Skip to main content

Input fields

assets : [OnSiteJobsAssetInput!]! required

Request related assets.

comment : String

Comment for the request.

externalReference : String

External reference for the request.

isEmergency : Boolean

Is emergency.

overrideRequestCheckWarnings : Boolean

Ignore any warnings raised by the request checks.

reason : OnSiteJobsRequestReason! required

Combined reason and sub-reason for the request. It will be in the format of 'REASON___SUB_REASON'. Sub-reason can be optional so the format can also be just 'REASON'.

reporter : ReporterInput

Request reporter.

runRequestChecks : Boolean default: True

Run validation checks before creating the request. Cannot be false when using AccountUser authentication.

status : OnSiteJobsRequestStatus default: PENDING

Request status. This value may be overridden to APPROVAL_PENDING if the reason or emergency requires approval.

supplyPointIdentifierToMarketNameMapping : [SupplyPointIdentifierToMarketNameMappingInput!]

Supply point external identifier to market name mappings to associate with the request. If this is provided, supply_point_internal_ids cannot be provided.

supplyPointInternalIds : [Int!]

List of internal IDs of supply points to associate with the request. If this is provided, supply_point_identifier_to_market_name_mapping cannot be provided.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "assets": OnSiteJobsAssetInput, "comment": "meeting-watch-establish-lose-figure", "externalReference": "man-material-out-drop-computer", "isEmergency": true, "overrideRequestCheckWarnings": true, "reason": "METER_REMOVAL___BLANK_DISPLAY", "reporter": ReporterInput, "runRequestChecks": true, "status": "APPOINTMENT_FAILED", "supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput, "supplyPointInternalIds": 98 }