Atomics are engineering parameters associated with a specific item. An Atomic is always the member of exactly one Item, but an Item can have many Atomics.

Endpoints and Data Structures

GET endpoints and parameters

Endpoints

  • To access a specific item GET /atomic/did/<atomic id>

Response Parameters

Parameter

Data Type

Description

did

integer, primary_key

The ID or “Data Identifier” of the Atomic returned

name

string

Name of the Atomic

item_id

integer

The ID of the Item associated with the Atomic

modified_by

User

Info about the most recent user to modify the item

  • uid (int): user ID

  • display_name (string): User display name

  • status (enum): User status, active, inactive, admin

  • avatar_url (string): URL to avatar

timestamp

timestamp

Timestamp corresponding to last update of the Atomic

unit_id

integer

ID corresponding to the unit type used here. Query GET /unit for a list of all available units

Note: Only ONE of ivalue, tvalue, or fvalue are allowed to be set and returned at a time

ivalue

integer

Atomic value, if it’s an integer

tvalue

string

Atomic value, if it’s a string

fvalue

float

Atomic value, if it’s a float

POST and PUT endpoints and parameters

Endpoints

  • To create a new atomic, you need to make two API calls:

    • POST /atomic to create the atomic

    • POST /item/atomic/<item_id>/<atomic_id> to associate the atomic with an item

  • To update an atomic: PUT /atomic/did/<atomic_id>

  • To delete an atomic: DELETE /atomic/did/<atomic_id>

Body Parameters

Parameter

Datatype

Required

Description

name

string

No

Name of the Atomic

unit_id

int

No

ID corresponding to the unit type used here.

Note: Only ONE of ivalue, tvalue, or fvalue are allowed to be set and returned at a time

ivalue

integer

No

Atomic value, if it’s an integer

tvalue

string

No

Atomic value, if it’s a string

fvalue

float

No

Atomic value, if it’s a float