Skip to content
SENS Platform Docs

Create a device, optionally with its initial organization assignment.

POST
/v1/tenants/{tenantNumber}/devices
curl --request POST \
  --url https://api.dev.iot-sens.schlossers.at/v1/tenants/1/devices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deviceTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "devEui": "example", "name": "example", "organizationUnitId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metadata": { "additionalProperty": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantNumber
required
integer format: int32
>= 1 <= 2147483647

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
deviceTypeId
required
string format: uuid
devEui
required
string
>= 16 characters <= 16 characters /^[A-F0-9]{16}$/
name
required
string
>= 1 characters <= 200 characters
organizationUnitId
string format: uuid
metadata
object
<= 50 properties
key
additional properties
One of:
string
Examplegenerated
{
  "deviceTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "devEui": "example",
  "name": "example",
  "organizationUnitId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metadata": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

201

Section titled “201”

Device created.

Media typeapplication/json
object
deviceId
required
string format: uuid
tenantId
required
string format: uuid
deviceTypeId
required
string format: uuid
devEui
required
string
>= 16 characters <= 16 characters /^[A-F0-9]{16}$/
name
required
string
>= 1 characters <= 200 characters
status
required
string
Allowed values: active disabled retired
metadata
required
object
<= 50 properties
key
additional properties
One of:
string
currentAssignment
required
One of:
object
deviceAssignmentId
required
string format: uuid
deviceId
required
string format: uuid
tenantId
required
string format: uuid
organizationUnitId
required
string format: uuid
validFrom
required
string format: date-time
validTo
required
One of:
string format: date-time
assignedAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "status": "active"
}

Headers

Section titled “Headers”
Location
string
Example
/v1/devices/10000000-0000-4000-8000-000000000001

Canonical flat Device URL.

default

Section titled “default”

A safe platform error response.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED AUTHENTICATION_FAILED AUTHORIZATION_FAILED RESOURCE_NOT_FOUND CONFLICT DEPENDENCY_FAILURE FLOW_FAILURE RATE_LIMITED INTERNAL_ERROR
category
required
string
Allowed values: validation authentication authorization not_found conflict dependency_failure flow_failure rate_limit internal
message
required

Safe client-facing diagnostic message.

string
correlationId
required

Correlation ID for operational investigation.

string
>= 1 characters
details

Safe bounded diagnostic details.

object
key
additional properties
One of:
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED",
    "category": "validation"
  }
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store