UpdateInstance

PUT

/api/sites/{siteId}/instances/{instanceId}

const url = 'https://your-tenant.consystence.com/api/sites/example/instances/example';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"example","assetNumber":"example","typeVersion":"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"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://your-tenant.consystence.com/api/sites/example/instances/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "assetNumber": "example", "typeVersion": "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" } ] }'

Authorizations

Bearer

Parameters

Path Parameters

siteId

required

string

instanceId

required

string

Request Body^required

application/json

object

name

string

nullable 0 <= 200 characters

assetNumber

string

nullable >= 1 characters <= 50 characters

typeVersion

string

nullable 0 <= 50 characters

controllerId

string

nullable 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

{
  "name": "example",
  "assetNumber": "example",
  "typeVersion": "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"
    }
  ]
}

UpdateInstance

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Request Body^required

Example^generated