inventories

Download schema

Equipment: dataloggers, sensors, gateways and packaging

Get a sensor by identity

GET

https://api.smach.science

/inventories/sensors/{identity}

Get a sensor by identity › path Parameters

identity

string · minLength: 1 · required

Get a sensor by identity › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Optional for an account belonging to a single organization, which is resolved from the token. Required beyond that, since no default is defensible. A super-admin may name any organization, or none, which reads across all of them.

Get a sensor by identity › Responses

Unknown identity

Sensor - IoT sensor probe (temperature, humidity, accelerometer)

Sensor

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kinds

Captor[] · minItems: 1 · required

Captors available on this probe

Enum values:

accelerometer

temperature

humidity

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Update a sensor

PUT

https://api.smach.science

/inventories/sensors/{identity}

Update a sensor › path Parameters

identity

string · minLength: 1 · required

Update a sensor › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Update a sensor › Request Body

Sensor - IoT sensor probe (temperature, humidity, accelerometer)

Sensor

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kinds

Captor[] · minItems: 1 · required

Captors available on this probe

Enum values:

accelerometer

temperature

humidity

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Update a sensor › Responses

Unknown identity

Sensor - IoT sensor probe (temperature, humidity, accelerometer)

Sensor

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kinds

Captor[] · minItems: 1 · required

Captors available on this probe

Enum values:

accelerometer

temperature

humidity

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

PUT/inventories/sensors/{identity}

curl https://api.smach.science/inventories/sensors/:identity \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kinds": [
    "accelerometer"
  ],
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kinds": [
    "accelerometer"
  ],
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kinds": [
    "accelerometer"
  ],
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

application/json

Delete a sensor

DELETE

https://api.smach.science

/inventories/sensors/{identity}

Delete a sensor › path Parameters

identity

string · minLength: 1 · required

Delete a sensor › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Delete a sensor › Responses

Deleted

No data returned

Get a packaging by identity

GET

https://api.smach.science

/inventories/packaging/{identity}

Get a packaging by identity › path Parameters

identity

string · minLength: 1 · required

Get a packaging by identity › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Get a packaging by identity › Responses

Unknown identity

Packaging - Protection container (inclosure for static, crate for transport)

Packaging

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kind

Kind · enum · required

Packaging kind

Enum values:

inclosure

crate

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

category

string

Packaging category

inside

string

Internal material

outside

string

External material

thermal

string

Thermal insulation material

thermalRate

integer · int32 · min: 0 · max: 5

Thermal protection rating (0-5)

vibration

string

Vibration damping material

vibrationRate

integer · int32 · min: 0 · max: 5

Vibration protection rating (0-5)

Size

Packaging dimensions (mm)

weight

integer · int64

Packaging weight (grams)

pictures

string[]

Photo URLs

type

string · readOnly

Inventory item type

GET/inventories/packaging/{identity}

curl https://api.smach.science/inventories/packaging/:identity \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}

json

application/json

Update a packaging

PUT

https://api.smach.science

/inventories/packaging/{identity}

Update a packaging › path Parameters

identity

string · minLength: 1 · required

Update a packaging › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Update a packaging › Request Body

Packaging - Protection container (inclosure for static, crate for transport)

Packaging

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kind

Kind · enum · required

Packaging kind

Enum values:

inclosure

crate

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

category

string

Packaging category

inside

string

Internal material

outside

string

External material

thermal

string

Thermal insulation material

thermalRate

integer · int32 · min: 0 · max: 5

Thermal protection rating (0-5)

vibration

string

Vibration damping material

vibrationRate

integer · int32 · min: 0 · max: 5

Vibration protection rating (0-5)

Size

Packaging dimensions (mm)

weight

integer · int64

Packaging weight (grams)

pictures

string[]

Photo URLs

type

string · readOnly

Inventory item type

Update a packaging › Responses

Unknown identity

Packaging - Protection container (inclosure for static, crate for transport)

Packaging

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kind

Kind · enum · required

Packaging kind

Enum values:

inclosure

crate

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

category

string

Packaging category

inside

string

Internal material

outside

string

External material

thermal

string

Thermal insulation material

thermalRate

integer · int32 · min: 0 · max: 5

Thermal protection rating (0-5)

vibration

string

Vibration damping material

vibrationRate

integer · int32 · min: 0 · max: 5

Vibration protection rating (0-5)

Size

Packaging dimensions (mm)

weight

integer · int64

Packaging weight (grams)

pictures

string[]

Photo URLs

type

string · readOnly

Inventory item type

PUT/inventories/packaging/{identity}

curl https://api.smach.science/inventories/packaging/:identity \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}

json

application/json

Delete a packaging

DELETE

https://api.smach.science

/inventories/packaging/{identity}

Delete a packaging › path Parameters

identity

string · minLength: 1 · required

Delete a packaging › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Delete a packaging › Responses

Deleted

No data returned

Get a logger by identity

GET

https://api.smach.science

/inventories/loggers/{identity}

Get a logger by identity › path Parameters

identity

string · minLength: 1 · required

Get a logger by identity › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Get a logger by identity › Responses

Unknown identity

Logger - IoT datalogger central unit (GPS + Bluetooth box)

Logger

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Update a logger

PUT

https://api.smach.science

/inventories/loggers/{identity}

Update a logger › path Parameters

identity

string · minLength: 1 · required

Update a logger › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Update a logger › Request Body

Logger - IoT datalogger central unit (GPS + Bluetooth box)

Logger

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Update a logger › Responses

Unknown identity

Logger - IoT datalogger central unit (GPS + Bluetooth box)

Logger

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

PUT/inventories/loggers/{identity}

curl https://api.smach.science/inventories/loggers/:identity \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

application/json

Delete a logger

DELETE

https://api.smach.science

/inventories/loggers/{identity}

Delete a logger › path Parameters

identity

string · minLength: 1 · required

Delete a logger › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Delete a logger › Responses

Deleted

No data returned

Get a gateway by identity

GET

https://api.smach.science

/inventories/gateways/{identity}

Get a gateway by identity › path Parameters

identity

string · minLength: 1 · required

Get a gateway by identity › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Get a gateway by identity › Responses

Unknown identity

Gateway - IoT relay device (cabin/trailer)

Gateway

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Update a gateway

PUT

https://api.smach.science

/inventories/gateways/{identity}

Update a gateway › path Parameters

identity

string · minLength: 1 · required

Update a gateway › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Update a gateway › Request Body

Gateway - IoT relay device (cabin/trailer)

Gateway

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Update a gateway › Responses

Unknown identity

Gateway - IoT relay device (cabin/trailer)

Gateway

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

PUT/inventories/gateways/{identity}

curl https://api.smach.science/inventories/gateways/:identity \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

application/json

Delete a gateway

DELETE

https://api.smach.science

/inventories/gateways/{identity}

Delete a gateway › path Parameters

identity

string · minLength: 1 · required

Delete a gateway › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Delete a gateway › Responses

Deleted

No data returned

List sensors

GET

https://api.smach.science

/inventories/sensors

Follow the Link header to page through the collection rather than building page URLs. The search parameter matches the name, the identity and the description, anywhere in the field. Sortable on name, identity, created, updated.

List sensors › query Parameters

page

integer · int32 · min: 0

0-indexed page number

Default: 0

size

integer · int32 · min: 1 · max: 200

Page size

Default: 50

search

string

Free-text search. The fields it matches are documented per endpoint.

sort

string

Sort field, prefixed with '-' for descending (e.g. -createdAt), composed with commas. The sortable fields are documented per endpoint.

captor

Captor · enum

Keep only probes carrying this captor

Enum values:

accelerometer

temperature

humidity

inService

boolean

true keeps only the items engaged by a monitoring that is set up or recording, false only the others, which are the ones available for a Setup. A monitoring that ended does not count: an item it used is free again. Requires the X-Organization header.

List sensors › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

List sensors › Responses

200

A page of results

Sensor[]

Sensor - IoT sensor probe (temperature, humidity, accelerometer)

Sensor

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kinds

Captor[] · minItems: 1 · required

Captors available on this probe

Enum values:

accelerometer

temperature

humidity

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Create a sensor

POST

https://api.smach.science

/inventories/sensors

Create a sensor › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Create a sensor › Request Body

Sensor - IoT sensor probe (temperature, humidity, accelerometer)

Sensor

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kinds

Captor[] · minItems: 1 · required

Captors available on this probe

Enum values:

accelerometer

temperature

humidity

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Create a sensor › Responses

Created

Sensor - IoT sensor probe (temperature, humidity, accelerometer)

Sensor

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kinds

Captor[] · minItems: 1 · required

Captors available on this probe

Enum values:

accelerometer

temperature

humidity

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

POST/inventories/sensors

curl https://api.smach.science/inventories/sensors \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kinds": [
    "accelerometer"
  ],
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kinds": [
    "accelerometer"
  ],
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kinds": [
    "accelerometer"
  ],
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

application/json

List packaging

GET

https://api.smach.science

/inventories/packaging

List packaging › query Parameters

page

integer · int32 · min: 0

0-indexed page number

Default: 0

size

integer · int32 · min: 1 · max: 200

Page size

Default: 50

search

string

Free-text search. The fields it matches are documented per endpoint.

sort

string

Sort field, prefixed with '-' for descending (e.g. -createdAt), composed with commas. The sortable fields are documented per endpoint.

kind

Kind · enum

Keep only inclosures, or only crates

Packaging kind

Enum values:

inclosure

crate

List packaging › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

List packaging › Responses

200

A page of results

Packaging[]

Packaging - Protection container (inclosure for static, crate for transport)

Packaging

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kind

Kind · enum · required

Packaging kind

Enum values:

inclosure

crate

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

category

string

Packaging category

inside

string

Internal material

outside

string

External material

thermal

string

Thermal insulation material

thermalRate

integer · int32 · min: 0 · max: 5

Thermal protection rating (0-5)

vibration

string

Vibration damping material

vibrationRate

integer · int32 · min: 0 · max: 5

Vibration protection rating (0-5)

Size

Packaging dimensions (mm)

weight

integer · int64

Packaging weight (grams)

pictures

string[]

Photo URLs

type

string · readOnly

Inventory item type

GET/inventories/packaging

curl https://api.smach.science/inventories/packaging \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "identity": "IMEI-LOGGER-001",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "kind": "inclosure",
    "name": "Datalogger 001",
    "description": "description",
    "category": "Isothermal",
    "inside": "Aluminum frame",
    "outside": "Stainless steel",
    "thermal": "thermal",
    "thermalRate": 4,
    "vibration": "vibration",
    "vibrationRate": 3,
    "size": {
      "height": 700,
      "width": 68300,
      "depth": 30
    },
    "weight": 180000,
    "pictures": [
      "string"
    ],
    "type": "logger"
  }
]

json

application/json

Create a packaging

POST

https://api.smach.science

/inventories/packaging

Create a packaging › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Create a packaging › Request Body

Packaging - Protection container (inclosure for static, crate for transport)

Packaging

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kind

Kind · enum · required

Packaging kind

Enum values:

inclosure

crate

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

category

string

Packaging category

inside

string

Internal material

outside

string

External material

thermal

string

Thermal insulation material

thermalRate

integer · int32 · min: 0 · max: 5

Thermal protection rating (0-5)

vibration

string

Vibration damping material

vibrationRate

integer · int32 · min: 0 · max: 5

Vibration protection rating (0-5)

Size

Packaging dimensions (mm)

weight

integer · int64

Packaging weight (grams)

pictures

string[]

Photo URLs

type

string · readOnly

Inventory item type

Create a packaging › Responses

Created

Packaging - Protection container (inclosure for static, crate for transport)

Packaging

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

kind

Kind · enum · required

Packaging kind

Enum values:

inclosure

crate

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

category

string

Packaging category

inside

string

Internal material

outside

string

External material

thermal

string

Thermal insulation material

thermalRate

integer · int32 · min: 0 · max: 5

Thermal protection rating (0-5)

vibration

string

Vibration damping material

vibrationRate

integer · int32 · min: 0 · max: 5

Vibration protection rating (0-5)

Size

Packaging dimensions (mm)

weight

integer · int64

Packaging weight (grams)

pictures

string[]

Photo URLs

type

string · readOnly

Inventory item type

POST/inventories/packaging

curl https://api.smach.science/inventories/packaging \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "kind": "inclosure",
  "name": "Datalogger 001",
  "description": "description",
  "category": "Isothermal",
  "inside": "Aluminum frame",
  "outside": "Stainless steel",
  "thermal": "thermal",
  "thermalRate": 4,
  "vibration": "vibration",
  "vibrationRate": 3,
  "size": {
    "height": 700,
    "width": 68300,
    "depth": 30
  },
  "weight": 180000,
  "pictures": [
    "string"
  ],
  "type": "logger"
}

json

application/json

List loggers

GET

https://api.smach.science

/inventories/loggers

List loggers › query Parameters

page

integer · int32 · min: 0

0-indexed page number

Default: 0

size

integer · int32 · min: 1 · max: 200

Page size

Default: 50

search

string

Free-text search. The fields it matches are documented per endpoint.

sort

string

Sort field, prefixed with '-' for descending (e.g. -createdAt), composed with commas. The sortable fields are documented per endpoint.

inService

boolean

List loggers › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

List loggers › Responses

200

A page of results

Logger[]

Logger - IoT datalogger central unit (GPS + Bluetooth box)

Logger

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Create a logger

POST

https://api.smach.science

/inventories/loggers

Create a logger › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Create a logger › Request Body

Logger - IoT datalogger central unit (GPS + Bluetooth box)

Logger

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Create a logger › Responses

Created

Logger - IoT datalogger central unit (GPS + Bluetooth box)

Logger

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

POST/inventories/loggers

curl https://api.smach.science/inventories/loggers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

application/json

List gateways

GET

https://api.smach.science

/inventories/gateways

List gateways › query Parameters

page

integer · int32 · min: 0

0-indexed page number

Default: 0

size

integer · int32 · min: 1 · max: 200

Page size

Default: 50

search

string

Free-text search. The fields it matches are documented per endpoint.

sort

string

Sort field, prefixed with '-' for descending (e.g. -createdAt), composed with commas. The sortable fields are documented per endpoint.

inService

boolean

List gateways › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

List gateways › Responses

200

A page of results

Gateway[]

Gateway - IoT relay device (cabin/trailer)

Gateway

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Create a gateway

POST

https://api.smach.science

/inventories/gateways

Create a gateway › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Create a gateway › Request Body

Gateway - IoT relay device (cabin/trailer)

Gateway

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

Create a gateway › Responses

Created

Gateway - IoT relay device (cabin/trailer)

Gateway

identity

string · minLength: 1 · pattern: \S(.*\S)? · required

Unique business identifier (IMEI or reference)

name

string · minLength: 1 · required

Display name

id

string · uuid · readOnly

Storage identifier

created

string · date-time · readOnly

Creation timestamp

updated

string · date-time · readOnly

Last update timestamp

description

string

Description or model information

type

string · readOnly

Inventory item type

POST/inventories/gateways

curl https://api.smach.science/inventories/gateways \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "identity": "IMEI-LOGGER-001",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "name": "Datalogger 001",
  "description": "description",
  "type": "logger"
}

json

application/json

Check whether a sensor identity is taken

GET

https://api.smach.science

/inventories/sensors/{identity}/exists

Whether this identity is already used in the current organization. Intended for live validation while a form is being filled: creating a duplicate answers 409 regardless.

Check whether a sensor identity is taken › path Parameters

identity

string · minLength: 1 · required

Check whether a sensor identity is taken › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Check whether a sensor identity is taken › Responses

200

Existence check result

Exists

exists

boolean

Count sensors matching the filters

GET

https://api.smach.science

/inventories/sensors/count

Answers a business question; paging is driven by the list endpoint's Link header. The filters have the same meaning as on the list endpoint.

Count sensors matching the filters › query Parameters

search

string

captor

Captor · enum

Enum values:

accelerometer

temperature

humidity

inService

boolean

Count sensors matching the filters › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Count sensors matching the filters › Responses

200

Number of resources matching the filters

Count

count

integer · int64

Check whether a packaging identity is taken

GET

https://api.smach.science

/inventories/packaging/{identity}/exists

Whether this identity is already used in the current organization. Intended for live validation while a form is being filled: creating a duplicate answers 409 regardless.

Check whether a packaging identity is taken › path Parameters

identity

string · minLength: 1 · required

Check whether a packaging identity is taken › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Check whether a packaging identity is taken › Responses

200

Existence check result

Exists

exists

boolean

Count packaging matching the filters

GET

https://api.smach.science

/inventories/packaging/count

Answers a business question; paging is driven by the list endpoint's Link header. The filters have the same meaning as on the list endpoint.

Count packaging matching the filters › query Parameters

search

string

kind

Kind · enum

Packaging kind

Enum values:

inclosure

crate

Count packaging matching the filters › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Count packaging matching the filters › Responses

200

Number of resources matching the filters

Count

count

integer · int64

Check whether a logger identity is taken

GET

https://api.smach.science

/inventories/loggers/{identity}/exists

Whether this identity is already used in the current organization. Intended for live validation while a form is being filled: creating a duplicate answers 409 regardless.

Check whether a logger identity is taken › path Parameters

identity

string · minLength: 1 · required

Check whether a logger identity is taken › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Check whether a logger identity is taken › Responses

200

Existence check result

Exists

exists

boolean

Count loggers matching the filters

GET

https://api.smach.science

/inventories/loggers/count

Answers a business question; paging is driven by the list endpoint's Link header. The filters have the same meaning as on the list endpoint.

Count loggers matching the filters › query Parameters

search

string

inService

boolean

Count loggers matching the filters › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Count loggers matching the filters › Responses

200

Number of resources matching the filters

Count

count

integer · int64

Check whether a gateway identity is taken

GET

https://api.smach.science

/inventories/gateways/{identity}/exists

Whether this identity is already used in the current organization. Intended for live validation while a form is being filled: creating a duplicate answers 409 regardless.

Check whether a gateway identity is taken › path Parameters

identity

string · minLength: 1 · required

Check whether a gateway identity is taken › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Check whether a gateway identity is taken › Responses

200

Existence check result

Exists

exists

boolean

Count gateways matching the filters

GET

https://api.smach.science

/inventories/gateways/count

Answers a business question; paging is driven by the list endpoint's Link header. The filters have the same meaning as on the list endpoint.

Count gateways matching the filters › query Parameters

search

string

inService

boolean

Count gateways matching the filters › Headers

X-Organization

string

The organization alias the request applies to, not its display name.

Count gateways matching the filters › Responses

200

Number of resources matching the filters

Count

count

integer · int64

artworks me