UpdateInstance

PUT

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

const url = 'https://demo.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"}}'
};

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://demo.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" } }'

Authorizations

Bearer
ApiKey

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

Example^generated

{
  "name": "example",
  "assetNumber": "example",
  "typeVersion": "example",
  "controllerId": "example",
  "area": "example",
  "tagMappings": {
    "additionalProperty": "example"
  },
  "config": {
    "additionalProperty": "example"
  }
}

UpdateInstance

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Request Body^required

Example^generated