Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Verb

POST

Resource

/api/datamanagement/v1/SMDeviceModels

Content type

application/json

Body

{

“data”: {

“smdmModel”: “<model name>”,

“smdmMetricProfile”: 0

}

}

...

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

Code Block
{
    "statusCode":200,
    "data":{
        "SMDeviceModels":[
   
        {
   
            "smdmId":0,
   
            "smdmModel":"Unspecified",
   
            "smdmMetricProfile":0,

               "smdmCreatedAt":"2020-11-20 15:55:35",
   
            "smdmUpdatedAt":"2020-11-20 15:55:35",

               "smdmDeletedAt":null,

               "SMDevices":[
   
                {
   
                    "smrdId":0,
   
                    "smrdTerminalId":"",
   
                    "smrdIMEI":"000000000000000",
                        "smrdModel":0,
   
                    "smrdState":1,
                        "smrdCreatedAt":"2020-11-20 15:54:56",
   
                    "smrdUpdatedAt":"2020-11-20 15:54:56",
   
                    "smrdDeletedAt":null
   
                }
   
            ],
  
             "SMRuleOverrides":[
                ],
  
             "SMCriteriaOverrides":[
                ]
   
        },
   
        ...
   
    ]
    }
}

GET an existing device model

...

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

Code Block
{
    "statusCode":200,
    "data":{
   
    "SMDeviceModels":[
   
        {
 
              "smdmId":3,
   
            "smdmModel":"Samsung S9",
 
              "smdmMetricProfile":0,
 
              "smdmCreatedAt":"2022-06-24 13:23:08",
   
            "smdmUpdatedAt":"2022-06-24 13:23:08",
   
            "smdmDeletedAt":null,
   
            "SMDevices":[
   
            ],

               "SMRuleOverrides":[
   
            ],

               "SMCriteriaOverrides":[

               ]
   
        }
   
    ]
    }
}

UPDATE an existing device model

...

Verb

UPDATE

Resource

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

Content type

application/json

Body

{

“data”: {

“smdmModel”: “<model name>”,

“smdmMetricProfile”: 0 }

}

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

...

Verb

DELETE

Resource

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

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

...