How can we help?

Searching:

0 results found

Products/Get (Specific)

GET /odata/Products/[productId]

Description

Gets the details of a specific Product, as specified by the Product’s ID. This Product ID is returned in the response of Products/Post.

To get the details of all the Products of the Applications allowed to the logged-in user, see Products/Get (List).

See the following for request and response details ‒

See Also

Request ‒ Products/Get (Specific)

Property Type Description Mandatory
productId String This is the unique identifier automatically assigned by Axonize when a Product is created. This productId is returned in the response of the Products/Post. Y

Example JSON Products/Get (Specific) Request

curl -X GET \

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

  -H ‘Authorization: Token’ \

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

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

Response ‒ Products/Get (Specific)

For the requested Application, the response provides the properties in Products/Post.

Example JSON Products/Get (Specific) Response

Status 200 – OK

{

“@odata.context”: “https://dev-axonizeapi-axonize.dev-ase-axonize.p.azurewebsites.net/odata/$metadata#Products/$entity”,

            “urn”: null,

            “name”: “Temperature”,

            “description”: null,

            “icon”: “icon-Temperature”,

            “customIdFormat”: null,

            “customIdDisplay”: true,

            “customIdRequired”: true,

            “serialNumberFormat”: null,

            “serialNumberDisplay”: true,

            “serialNumberRequired”: false,

            “active”: false,

“keepAliveThreshold”: 1000000,

            “defaultVirtualDeviceEvents”: null,

            “disconnectChildDevicesOnDisconnect”: false,

            “connectChildDevicesOnConnect”: false,

            “disconnectGroupDeviceOnAllChildrenDisconnect”: false,

            “connectGroupDeviceOnAnyChildrenConnect”: false,

            “onConnectCommandIds”: [],

            “manufacturer”: null,

            “commandsProtocol”: “Undefined”,

            “commandsAddress”: null,

            “autoDiscoveryCommand”: null,

            “displayCommandsTab”: false,

            “onDeleteCommands”: [],

            “onPatchCommands”: [],

            “displayDeviceSDKDetails”: false,

            “id”: “58d0d7165a4fbc0f486fe71a”,

            “appId”: “801A048A-9F23-429F-BF0D-B6D35B22771E”,

            “createDate”: “2017-03-21T07:32:38.032Z”,

            “createUser”: null,

            “updateDate”: “0001-01-01T00:00:00Z”,

            “updateUser”: null,

            “commands”: [],

            “events”: [

                {

                    “typeCode”: 1088,

                    “name”: “Temperature”,

                    “nameResourceKey”: “msg_temperature_hot”,

                    “datatype”: null,

                    “unit”: null,

                    “iconName”: null,

                    “isAccumulated”: false,

                    “logicalType”: null,

                    “subject”: null,

                    “fieldsCount”: null,

                    “precision”: null,

                    “calculationId”: null,

                    “valueRange”: {

                        “minimum”: null,

                        “maximum”: null,

                        “precision”: 0,

                        “numericType”: null,

                        “step”: null,

                        “allowedValues”: [

                            {

                                “key”: “msg_ok”,

                      “value”: “0”,

                                “iconName”: null,

                                “iconColor”: null

                            },

                            {

                                “key”: “msg_alarm”,

                                “value”: “1”,

                                “iconName”: null,

                                “iconColor”: null

                            }

                        ]

                    }

                }

               

            ],

            “additionalProperties”: [],

            “mediaSettings”: null

        }