Products/Post

POST /odata/Products/

Description

To create a new Product.

See the following for request and response details ‒

• Request ‒ Products/Post
• Response ‒ Products/Post

See Also

• Authentication
• API Response Codes

Request ‒ Products/Post

Properties for Products are organized hierarchically by object. The hierarchy of objects for the Products/Post request properties is as follows –

• products (general)
• serviceCommand
• serviceEvent
• serviceProperty
• mediaSettings
• tooltipElement
• commandArgument
• valueRange
• eventLoggingSettings
• aggregatedEventSettings
• commandServiceProperty
• additionalProperty

The properties for each of the objects listed above are described in the sections that follow. Each object has its own section and table of properties.

Request – Products/Post – Products (General) Properties

Request ‒ Products/Post – serviceCommand Properties

Request – Products/Post – serviceEvent Properties

Request – Products/Post – serviceProperty Properties

Request – Products/Post – mediaSettings Properties

<tdmediaSettings/
mediaProtocol<td”>mediaSettings/
mediaType<td”>The dimension ratio of the screen’s size. The format is – number, colon, number. For example, “3:4” or “6:9”.

Request – Products/Post – tooltipElement Properties

Request – Products/Post – commandArgument Properties

Request – Products/Post – valueRange Properties

<td”>The severity of the event, which can be one of the following values –

• Warning
• Minor
• Major
• Critical

Request – Products/Post – eventLoggingSettings Properties

Request – Products/Post – aggregatedEventSettings Properties

Request – Products/Post – commandServiceProperty Properties

Request – Products/Post – additionalProperty Properties

Example JSON Products/Post Request

curl -X POST \

https://api.stg.axonize.com/odata/products/ \

-H ‘Authorization: Token’ \

-H ‘Content-Type: application/json’ \

-H ‘appId: 801A048A-9F23-429F-BF0D-B6D35B22771E’ \

-d ‘{

{“name”:”ExampleFridge”,

“manufacturer”:”TheFridgeMakingCompany”,

“tooltip”:[],

“customIdDisplay”:false,

“serialNumberDisplay”:false,

“displayDeviceSDKDetails”:false,

“events”:[{“nameResourceKey”:””,

“name”:”HowColdIsItRightNow”,”typeCode”:7,”defaultRollupMethod”:”Avg”,”precision”:1,”displayType”:null,”valueRange”:{“allowedValues”:[],”ranges”:[]},”aggregatedEventSettings”:null}]} { }

‘

Response ‒ Products/Post

All the same properties in the request are returned in the response. In addition, the response that is returned also contains the following properties –

Status 201 – Created

Example JSON Products/Post Response

{“@odata.context”:”https://dev-axonizeapi-axonize.dev-ase-axonize.p.azurewebsites.net/odata/$metadata#Products/$entity”,”urn”:null,”name”:”ExampleFridge”,”description”:null,”icon”:null,”customIdFormat”:null,”customIdDisplay”:false,”customIdRequired”:true,”serialNumberFormat”:null,”serialNumberDisplay”:false,”serialNumberRequired”:false,”active”:false,”keepAliveThreshold”:0,”defaultVirtualDeviceEvents”:null,”disconnectChildDevicesOnDisconnect”:false,”connectChildDevicesOnConnect”:false,”disconnectGroupDeviceOnAllChildrenDisconnect”:false,”connectGroupDeviceOnAnyChildrenConnect”:false,”onConnectCommandIds”:[],”manufacturer”:”TheFridgeMakingCompany”,”commandsProtocol”:”Undefined”,”commandsAddress”:null,”commandsUrl”:null,”autoDiscoveryCommand”:null,”displayCommandsTab”:false,”onDeleteCommands”:[],”onPatchCommands”:[],”displayDeviceSDKDetails”:false,”enableSDKFeatures”:false,”id”:”5bb0634719ec0c19c4596b49″,”appId”:”801A048A-9F23-429F-BF0D-B6D35B22771E”,”createDate”:”2018-09-30T05:46:47.7900808Z”,”createUser”:”1234″,”updateDate”:”0001-01-01T00:00:00Z”,”updateUser”:null,”commands”:[],”events”:[{“typeCode”:7,”description”:null,”name”:”HowColdIsItRightNow”,”nameResourceKey”:””,”datatype”:null,”logicalType”:null,”displayType”:null,”unit”:null,”retention”:0,”iconName”:null,”iconColor”:null,”isAccumulated”:false,”subject”:null,”fieldsCount”:null,”precision”:1,”calculationId”:null,”defaultRollupMethod”:”Avg”,”valueRange”:{“minimum”:null,”maximum”:null,”precision”:0,”numericType”:null,”step”:null,”allowedValues”:[],”ranges”:[]},”loggingSettings”:null,”aggregatedEventSettings”:null}],”additionalProperties”:[],”mediaSettings”:null,”tooltip”:[]}