Patch a thing

4 minute(s) read

Patch

/inventory/things/{thingId}

Apply a patch to a thing passing only the properties to modify, leaving all the other fields unchanged.
This is the recommended way to update a single attribute, such as the name, the location assignment or a custom property, without the risk of overwriting concurrent changes.

Required permissions: READ_THING, WRITE_THING.

Security

HTTP

Type bearer

Header parameters

X-Servitly-Tenant

stringRequired

The name of the tenant (e.g. acme).

Path parameters

thingId

stringRequired

The thing identifier.

Minimum1.0

Exampleabcd1234

Body parameters

The details of the thing being patched.

Expand All

object

name

string

The thing name.

serialNumber

string

The thing serial number.

thingDefinitionId

string

The thing-definition identifier associated with the thing.

parentThingId

string

The object identifier of the parent thing in the hierarchy.

rootThingId

string

The object identifier of the root thing in the hierarchy.

productModelId

string

The product-model identifier associated with the thing. This must be provided as an alternative to the thingDefinitionId.

productModelPartId

string

The model-part identifier associated with the thing to be provided with the productModelId.

timezone

string

The timezone used for date/times localization (e.g. Europe/Rome).

gpsPosition

string

The GPS coordinates associated with this thing.

locationId

string

The location identifier. If missing, the thing is registered as NOT ASSIGNED during creation (allowed only by organization users).

properties

object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }

property*

string additionalProperties

simIccid

string

The ICCID of the SIM card installed into the product.

simDetails

object (SimDetails)

The sub-node providing SIM card connectivity and status details.

simStatus

string

The status of the SIM.

Valid values[ "INACTIVE", "TEST", "ACTIVE" ]

sessionStatus

string

The status of the SIM session.

Valid values[ "G", "A", "R" ]

sessionStartTimestamp

integer (int64)

The timestamp the last session has started.

sessionDataLastTimestamp

integer (int64)

The timestamp the last data has been exchanged by the active session.

sessionNetworkTraffic

integer

The number of bytes exchanged during the session.

dailyTraffic

integer

The daily average of exchanged bytes.

monthlyTraffic

integer

The monthly projection of bytes that will be exchanged.

lastCellId

string

The last cell id the SIM has been connected to.

lastUpdate

integer (int64)

The timestamp when the SIM details were last updated.

tagIds

Array of string

The tag identifiers associated with this thing.

string

Responses

200

Successfully patched.

Expand All

object

string

The thing object identifier.

name

string

The thing name.

serialNumber

string

The thing serial number.

thingDefinitionId

string

The thing-definition identifier associated with the thing.

parentThingId

string

The object identifier of the parent thing in the hierarchy.

rootThingId

string

The object identifier of the root thing in the hierarchy.

productModelId

string

The product-model identifier associated with the thing. This must be provided as an alternative to the thingDefinitionId.

productModelPartId

string

The model-part identifier associated with the thing to be provided with the productModelId.

timezone

string

The timezone used for date/times localization (e.g. Europe/Rome).

gpsPosition

string

The GPS coordinates associated with this thing.

creationTimestamp

integer (int64)

The timestamp at which the object was created.

activationDate

integer (int64)

The last activation date.

lastModifiedTimestamp

integer (int64)

The timestamp at which the object was last modified.

cloudStatus

integer

The cloud status of the thing.
0: INACTIVE
1: TEST
2: ACTIVE
3: SUSPENDED
4: PROVISIONING
5: ACTIVATING
6: ACTIVATING_TEST

cloudStatusLastUpdateTimestamp

integer (int64)

The timestamp of the last cloud status update.

connectionStatus

integer

The connection status of the thing.
-1: UNREACHABLE
0: OFFLINE
1: ONLINE

connectionStatusLastUpdateTimestamp

integer (int64)

The timestamp of the last connection status update.

latestMetricValueTimestamp

integer (int64)

The timestamp of the latest received metric value.

customerId

string

The customer identifier.

locationId

string

The location identifier. If missing, the thing is registered as NOT ASSIGNED during creation (allowed only by organization users).

properties

object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }

property*

string additionalProperties

simIccid

string

The ICCID of the SIM card installed into the product.

simDetails

object (SimDetails)

The sub-node providing SIM card connectivity and status details.

simStatus

string

The status of the SIM.

Valid values[ "INACTIVE", "TEST", "ACTIVE" ]

sessionStatus

string

The status of the SIM session.

Valid values[ "G", "A", "R" ]

sessionStartTimestamp

integer (int64)

The timestamp the last session has started.

sessionDataLastTimestamp

integer (int64)

The timestamp the last data has been exchanged by the active session.

sessionNetworkTraffic

integer

The number of bytes exchanged during the session.

dailyTraffic

integer

The daily average of exchanged bytes.

monthlyTraffic

integer

The monthly projection of bytes that will be exchanged.

lastCellId

string

The last cell id the SIM has been connected to.

lastUpdate

integer (int64)

The timestamp when the SIM details were last updated.

tagIds

Array of string

The tag identifiers associated with this thing.

string

thingDefinition

object

The thing-definition associated with the thing.

string

name

string

description

string

defaultThingName

string

nameMetricId

string

serialNumberMetricId

string

gpsPositionMetricId

string

thingDefinitionMetricId

string

superThingDefinitionId

string

parentThingDefinitionId

string

properties

object (Properties)

Example{ "foo": "abc", "bar": "123" }

property*

string additionalProperties

customer

object

The customer associated with the thing.

string

code

string

name

string

country

string

countryIsoCode

string

timezone

string

properties

object (Properties)

Example{ "foo": "abc", "bar": "123" }

property*

string additionalProperties

creationTimestamp

integer (int64)

firstAccessTimestamp

integer (int64)

lastAccessTimestamp

integer (int64)

location

object

The location associated with the thing.

string

name

string

country

string

countryIsoCode

string

timezone

string

gpsPosition

string

properties

object (Properties)

Example{ "foo": "abc", "bar": "123" }

property*

string additionalProperties

customerId

string

serviceLevel

object

The service-level associated with the thing.

string

name

string

level

integer

alertingFeature

boolean

notificationsFeature

boolean

thingPricing

object

authorizationPricing

object

features

object

partner

object

The partner associated with the thing or inherited from the parent location or customer.

string

name

string

code

string

country

string

countryIsoCode

string

timezone

string

customerCount

number

properties

object (Properties)

Example{ "foo": "abc", "bar": "123" }

property*

string additionalProperties

organization

object

string

Example1234abcd

creationTimestamp

integer (int64)

400

Request data not valid.

object

message

string

The error response.

ExampleBad request

401

User not authenticated.

object

message

string

The error response.

ExampleUser not authenticated

403

User not authorized.

object

message

string

The error response.

ExampleUser not authorized

404

Resource was not found.

object

message

string

The error response.

ExampleResource not found

429

API call rate limit exceeded.

object

message

string

The error response.

ExampleAPI call rate limit exceeded

500

Internal server error.

object

message

string

The error response.

ExampleInternal Server Error

Was this article helpful?

Documentation Index

Patch a thing