Creates new thing

  • 3 minute(s) read
Prev Next
Post
/inventory/things

Required permissions: READ_THING, WRITE_THING.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

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

Body parameters

The details of the thing being created.

Expand All
object
name
string

The thing name.

serialNumber
string

The thing serial number.

thingDefinitionId
string

The thing-defininition identifier associated with the thing.

productModelId
string

The product-model identifier associated with the thing. This must be provided in the alternative of the thingDefinitionId.

productModelPartId
string

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

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 provising 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 amount of bytes exchanged with 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 the sim details has been last updated.

tagIds
Array of string

The tag identifiers assoicated with this thing.

string
Responses
201

Successful created.

Expand All
object
id
string

The thing object identifier.

name
string

The thing name.

serialNumber
string

The thing serial number.

thingDefinitionId
string

The thing-defininition identifier associated with the thing.

productModelId
string

The product-model identifier associated with the thing. This must be provided in the alternative of the thingDefinitionId.

productModelPartId
string

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

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 witch the object has been modified the last time.

cloudStatus
integer

The cloud status of the thing.
0: INACTIVE
1: TEST
2: ACTIVE
2: 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 lastest 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 provising 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 amount of bytes exchanged with 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 the sim details has been last updated.

tagIds
Array of string

The tag identifiers assoicated with this thing.

string
thingDefinition
object

The thing-defininition associated with the thing.

id
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.

id
string
name
string
country
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.

id
string
name
string
country
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.

id
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 by the parent location or customer.

id
string
name
string
code
string
country
string
timezone
string
customerCount
number
properties
object (Properties)
Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
organization
object
id
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
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error