CreateSystemRequest

The request body that we need to passed at the time of creating system.

data object

ownerstringrequired

Please add the name of the system.

Possible values: [Industrility]

mappedAssetsOld object[]required

You only need to pass the mappedAssetsOld array when you have chosen the createSystemStep to ASSET_MAPPING.

Array [

idstring

You can keep this field to empty array as you are creating system, system would not have any existing assets.

Possible values: [``]

]

systemIdstringrequired

Please enter the sytemid, it is unique identification number of the system.

Possible values: [SYS-123456, 19-995-001]

addressstringrequired

Please enter the address of the system where it is located.

Possible values: [5396 North Reese Avenue, Fresno CA 93722, 2035 Ninth Street, Berkeley CA 94710]

descriptionstringrequired

Please enter the description for the system.

Possible values: [Boiler system which contains medium type boilers]

integratorstringrequired

Please enter the name of the integrator of the system or distributor.

Possible values: [Industrility]

securityGroupstring[]required

Possible values: [SY-dd-d088-46f3-a636-be24c3b02832]

typestringrequired

Please enter the type of the system it can one of enums value.

Possible values: [factory, location, area, zone, room, site, system, plant]

tagsstring[]required

Possible values: [boiler, industrility]

parentSystemstring[]

Possible values: [SY-dd-d088-46f3-a636-be24c3b02832, ``]

mappedAsset object[]required

You only need to pass the mappedAsset Id's array when you have chosen the createSystemStep to ASSET_MAPPING.

Array [

idstring

Kindly provide the asset ids you wish to have in this system.

Possible values: [AS-dd-d088-46f3-a636-be24c3b02832, AS-ff-d088-46f3-a636-be24c3b02832]

]

createSystemStepstringrequired

Please enter the step name for system creation it is really important field as based on this field we are decide the system create step.

Possible values: [META, ASSET_MAPPING]

namestringrequired

Please add the name of the system.

Possible values: [Boiler System]

locationstringrequired

enter the JSON stringified lat/long location object.

Possible values: [``]

idstringrequired

You need to enter the id of the system if you have chosen the createSystemStep to ASSET_MAPPING, that we usually do after the system creating the system with createSystemStep set to META.

Possible values: [SY-dd-d088-46f3-a636-be24c3b02832]

statusstringrequired

Please enter the status of the system. it can be one of active,inactive,designed,commissioned.

Possible values: [active, inactive, designed, commissioned]

CreateSystemRequest

{
  "data": {
    "owner": "Industrility",
    "mappedAssetsOld": [
      {
        "id": ""
      }
    ],
    "systemId": "SYS-123456",
    "address": "5396 North Reese Avenue, Fresno CA 93722",
    "description": "Boiler system which contains medium type boilers",
    "integrator": "Industrility",
    "securityGroup": [
      "SY-dd-d088-46f3-a636-be24c3b02832"
    ],
    "type": "factory",
    "tags": [
      "boiler"
    ],
    "parentSystem": [
      "SY-dd-d088-46f3-a636-be24c3b02832"
    ],
    "mappedAsset": [
      {
        "id": "AS-dd-d088-46f3-a636-be24c3b02832"
      }
    ],
    "createSystemStep": "META",
    "name": "Boiler System",
    "location": "",
    "id": "SY-dd-d088-46f3-a636-be24c3b02832",
    "status": "active"
  }
}