Import a temporary create-only snapshot from IOTA.

POST

/v1/tenants/{tenantNumber}/imports/iota-snapshot

const url = 'https://api.dev.iot-sens.schlossers.at/v1/tenants/1/imports/iota-snapshot';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"baseUrl":"https://example.com","username":"example","password":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.dev.iot-sens.schlossers.at/v1/tenants/1/imports/iota-snapshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "baseUrl": "https://example.com", "username": "example", "password": "example" }'

Loads every tenant visible to the supplied IOTA credentials and creates the valid device types and devices in the active target tenant. Existing SENS records are never changed, deleted, reactivated, or moved. The credentials are used only for this request and are never persisted or included in logs or audit metadata. Only platform administrators may call this temporary V1 migration operation. Responses are not cacheable.

Authorizations

AccessToken

Parameters

Path Parameters

tenantNumber

required

integer format: int32

>= 1 <= 2147483647

Request Body^required

application/json

object

baseUrl

required

string format: uri

<= 300 characters /^https://commonapi-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.xaas-a0a0\.cloud/api$/

username

required

string

>= 1 characters <= 200 characters

password

required

string format: password

>= 1 characters <= 500 characters

Example^generated

{
  "baseUrl": "https://example.com",
  "username": "example",
  "password": "example"
}

Responses

200

The valid snapshot subset was persisted atomically.

application/json

object

targetTenantId

required

string format: uuid

completedAt

required

string format: date-time

source

required

object

tenantCount

required

integer

deviceTypeCount

required

integer

deviceCount

required

integer

deviceTypes

required

object

created

required

integer

existing

required

integer

skipped

required

integer

devices

required

object

created

required

integer

existing

required

integer

skipped

required

integer

issues

required

Array<object>

<= 200 items

object

entity

required

string

Allowed values: device_type device

code

required

string

Allowed values: invalid_device_type_code invalid_dev_eui missing_device_type duplicate_source_dev_eui device_exists_in_other_tenant existing_device_mismatch disabled_existing_device_type asset_excluded incomplete_source_record

sourceIdentifier

required

string

>= 1 characters <= 200 characters

Example

{
  "issues": [
    {
      "entity": "device_type",
      "code": "invalid_device_type_code"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

400

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

401

Bearer authentication is missing, invalid, expired, or revoked.

application/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

Cache-Control

string

Allowed value: no-store

WWW-Authenticate

string

Allowed value: Bearer

403

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

404

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

409

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

500

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

502

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

503

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

504

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store

Import a temporary create-only snapshot from IOTA.

Authorizations

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Example

Headers

400

Example

Headers

401

Example

Headers

403

Example

Headers

404

Example

Headers

409

Example

Headers

500

Example

Headers

502

Example

Headers

503

Example

Headers

504

Example

Headers

Request Body^required

Example^generated