Amadis

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Define a new device model

This API allows adding a device model to the SAM database:

Verb

POST

Resource

/api/datamanagement/v1/SMDeviceModels

Content type

application/json

Body

{

“data”: {

“smdmModel”: “<model name>”,

“smdmMetricProfile”: 0

}

}

Where:

Field

Description

smdmModel

Device model name (max 32 chars).

smdmMetricProfile

RFU, always 0.

The response data is a JSON object with the following structure:

{

Field

Description

“statusCode”: 200,

Request successful

“data”: {

Response data

“smdmId”: <new device model id>

New device model id.

}

}

Access existing device models

This API allows retrieving device model data from the SAM database:

Verb

GET

Resource

/api/datamanagement/v1/SMDeviceModels[/{id}]

The response data is a JSON object with the following structure:

{

Field

Description

“statusCode”: 200,

Request successful

“data”: {

Response data


“SMDeviceModels”: [<device model>*]

<device model>* is the list of device model records, represented as Json objects. See the SAM database model document for a description of the Json object structure.
If a device model id is specified (e.g. /6) the list will contain only the device model of the specified id (smdmId==id).

}

}

  • No labels