@nuralogix.ai/dfx-api-client / HTTP / Devices

Devices

Devices end points

Devices can be used to record the platform by which a measurement captured was conducted on. The DeviceTypeID references a pre-defined set of devices with the following chart. New Device Types cannot be created by organizations and are managed by the API specifically. Devices types can be retrieved from a dedicated endpoint returning all their values and meanings.

Sample code

const apiClient = client();
const response = await apiClient.http.devices.retrieve('your-device-id');
const { status, body } = response;
if (status !== '200') {
    /**
     * TypeScript knows that once we are inside this block, the only response
     * shape that matches a non "200" response is the ErrorResponse
    */
    throw body;
}
/** Otherwise the shape of the response is DeviceRetrieve200Response */
console.log(body.StatusID);

Methods

create

▸ create(data)

Creates a new device reference to associate with measurements. Each device is mapped to a device type ID.

Endpoint Action ID = 903

Parameters

Name	Type
`data`	`DeviceCreateRequest`

Returns

Promise<ErrorResponse | DeviceCreated200Response>

deleteDeviceMeasurement

▸ deleteDeviceMeasurement(id)

Only DFX_ORG_ADMIN has permission to delete all measurements of a specific device for their own organization.

Endpoint Action ID = 907

Parameters

Name	Type
`id`	`string`

Returns

Promise<ErrorResponse | DeviceDeleteMeasurements200Response>

list

▸ list(data)

Retrieves a list of existing devices in an organization.

Endpoint Action ID = 906

Parameters

Name	Type
`data`	`DeviceListRequest`

Returns

Promise<ErrorResponse | DeviceList200Response>

remove

▸ remove(id)

Deletes a device from the dataset.

Endpoint Action ID = 905

Parameters

Name	Type
`id`	`string`

Returns

Promise<ErrorResponse | DeviceDeleted200Response>

retrieve

▸ retrieve(id)

Retrieves a single reference to a device. The body response includes details about the device and the number of measurements that have been associated with it.

Endpoint Action ID = 902