CreateInstance

POST

/api/sites/{siteId}/instances

curl --request POST \
  --url https://your-tenant.consystence.com/api/sites/example/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "example", "name": "example", "typeId": "example", "typeVersion": "example", "assetNumber": "example", "controllerId": "example", "area": "example", "tagMappings": { "additionalProperty": "example" }, "config": { "additionalProperty": "example" }, "position": "example", "coordinates": { "latitude": 1, "longitude": 1 }, "clearCoordinates": true, "maintenance": { "lastService": "example", "nextService": "example", "vendor": "example", "model": "example", "serial": "example", "serviceIntervalRunHours": 1, "serviceIntervalDays": 1, "runHoursAtLastService": 1, "startsPerHourLimit": 1 }, "relationships": [ { "type": "example", "target": "example" } ] }'

• Your tenant's hosted service: Enterprise tenants
• Your tenant's hosted service: Integrator tenants and free sandboxes

Authorizations

• Bearer

Parameters

Path Parameters

siteId

required

string

Request Body^required

Media typeapplication/json

object

id

required

string

0 <= 50 characters

name

required

string

0 <= 200 characters

typeId

required

string

0 <= 200 characters

typeVersion

string

nullable 0 <= 50 characters

assetNumber

required

string

>= 1 characters <= 50 characters

controllerId

required

string

0 <= 50 characters

area

string

nullable

tagMappings

object

key

additional properties

string

config

object

key

additional properties

nullable

position

string

nullable

coordinates

object

latitude

number format: double

nullable

longitude

number format: double

nullable

clearCoordinates

boolean

nullable

maintenance

object

lastService

string

nullable

nextService

string

nullable

vendor

string

nullable

model

string

nullable

serial

string

nullable

serviceIntervalRunHours

integer format: int32

nullable

serviceIntervalDays

integer format: int32

nullable

runHoursAtLastService

number format: double

nullable

startsPerHourLimit

integer format: int32

nullable

relationships

Array<object>

nullable

object

type

string

nullable

target

string

nullable

Example^generated

{
  "id": "example",
  "name": "example",
  "typeId": "example",
  "typeVersion": "example",
  "assetNumber": "example",
  "controllerId": "example",
  "area": "example",
  "tagMappings": {
    "additionalProperty": "example"
  },
  "config": {
    "additionalProperty": "example"
  },
  "position": "example",
  "coordinates": {
    "latitude": 1,
    "longitude": 1
  },
  "clearCoordinates": true,
  "maintenance": {
    "lastService": "example",
    "nextService": "example",
    "vendor": "example",
    "model": "example",
    "serial": "example",
    "serviceIntervalRunHours": 1,
    "serviceIntervalDays": 1,
    "runHoursAtLastService": 1,
    "startsPerHourLimit": 1
  },
  "relationships": [
    {
      "type": "example",
      "target": "example"
    }
  ]
}

Responses

200

OK