Skip to main content

Input fields

additionalDetails : JSONString

Additional details about the asset.

The current asset category.

externalIdentifier : NonEmptyString

Asset external identifier.

The current asset fuel type.

kind : OnSiteJobsAssetKind! required

Asset kind.

status : OnSiteJobsAssetStatus! required

Asset status.

The current asset sub category.

supplyPointIdentifierToMarketNameMapping : SupplyPointIdentifierToMarketNameMappingInput

Supply point external identifier to market name mapping to associate with the asset. If this is provided, supply_point_internal_id cannot be provided.

supplyPointInternalId : Int

Internal ID of the supply point to associate with the asset. 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

{ "additionalDetails": {"key": "value"}, "category": "TRADITIONAL", "externalIdentifier": "62491508", "fuelType": "ELECTRICITY", "kind": "METER", "status": "EXISTING", "subCategory": "CREDIT", "supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput, "supplyPointInternalId": 88401986 }