Update Element State (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/elements/:element_id/state

Update the element state.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

element_id stringrequired

The element ID.

application/json

Body

Update element state

id string

The ID.

image_id string

The element image ID.

scheduled_upgrade string

The scheduled upgrade.

Responses

200

Successful Operation

application/json

Schema

Schema

id string

The ID.

image_id string

The element image ID.

scheduled_upgrade string

The scheduled upgrade.

Example (from schema)

{
  "id": "string",
  "image_id": "string",
  "scheduled_upgrade": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "ELEMENT_NOT_FOUND"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "ELEMENT_BOUND_ERROR"
      },
      {
        "code": "ELEMENT_CONFIG_INVALID_VALUES"
      }
    ]
  }
}

Loading...