The Protocols end point allows you to retrieve the name and IDs of protocols, update protocols, create protocols, and delete protocols. This endpoint performs the same function as the Drivers endpoint.
URI Definition
Method | URI and Fields |
GET
| /iap/protocols |
Returns a set of protocols that match the search criteria.
Body Parameters| Parameter | Description |
|---|
| systemName | Specifies the protocol. | | userName | Specifies the name of the protocol. | | id | ID of the protocol. |
Query ParametersYou can specify a query parameter appended to the end of your URI, preceded with a "?" character. | Parameter | Type | Description |
|---|
| sortOrder | String | Specifies the sort order. Either ascending or descending (asc or desc).
Default is asc. | | sortBy | String | Specifies the name of a parameter. Either: typeName, type, protocol, or xifName.
Default is typeName. | | pg | Integer | Specifies the page number (1-0x7fffffff).
Default is null. | | sz | Integer | Specifies the page size (1-0x7fffffff). Default is null. |
Syntax Example/iap/protocols?sortOrder={asc/desc}&sortBy={field_name}&pg={page_number}&sz={page_size}
|
Examplehttps://localhost/iap/protocols Response[
{
"id": 48,
"systemName": "bacnet",
"userName": "BACnet"
},
{
"id": 49,
"systemName": "iap",
"userName": "IAP"
},
{
"id": 46,
"systemName": "iox",
"userName": "IOX"
},
{
"id": 45,
"systemName": "lon",
"userName": "LON"
},
{
"id": 47,
"systemName": "modbus",
"userName": "Modbus"
}
] |
|
| /iap/protocols/{name} |
Returns information about the named protocol.
Parameters| Parameter | Description |
|---|
| name | The name of the protocol to be returned. |
Example:https://localhost/iap/protocols/modbus Response {
"id": 47,
"systemName": "modbus",
"userName": "Modbus"
} |
|
/iap/protocols/predefined |
Returns a set of predefined protocols. Query ParametersYou can specify a query parameter appended to the end of your URI, preceded with a "?" character. | Parameter | Type | Description |
|---|
| sortOrder | String | Specifies the sort order. Either ascending or descending (asc or desc).
Default is asc. | | sortBy | String | Specifies the name of a parameter. Either: typeName, type, protocol, or xifName.
Default is typeName. | | pg | Integer | Specifies the page number (1-0x7fffffff).
Default is null. | | sz | Integer | Specifies the page size (1-0x7fffffff). Default is null. |
Examplehttps://localhost/iap/protocols/predefined Response[
{
"id": 48,
"systemName": "bacnet",
"userName": "BACnet"
},
{
"id": 49,
"systemName": "iap",
"userName": "IAP"
},
{
"id": 46,
"systemName": "iox",
"userName": "IOX"
},
{
"id": 45,
"systemName": "lon",
"userName": "LON"
},
{
"id": 47,
"systemName": "modbus",
"userName": "Modbus"
}
] |
|
POST
| /iap/protocols |
Creates a new protocol in the CMS.
Body Parameters| Parameter | Description |
|---|
| systemName | Specifies the protocol. | | userName | Specifies the name of the protocol. |
Examplehttps://localhost/iap/protocols Request Body {
"systemName": "test",
"userName": "TestProtocol"
} Response {
"id": 514,
"systemName": "test",
"userName": "TestProtocol"
} |
|
| PUT
| /iap/protocols/{id} |
Updates protocol specified by the ID. Parameters| Parameter | Description |
|---|
| systemName | Specifies the protocol. | | userName | Specifies the name of the protocol. | | id | ID of the protocol. |
Examplehttps://localhost/iap/protocols/514 Request Body {
"systemName": "test1",
"userName": "Updated TestProtocol"
} Response {
"id": 514,
"systemName": "test1",
"userName": "Updated TestProtocol"
} |
|
| DELETE | /iap/protocols/{id} |
Deletes the protocol specified with the ID. Parameter| Parameter | Type | Description |
|---|
| id | DeviceType | Specifies the device type ID to be updated. Possible value: 1-0x7fffffffffffffff |
Return Codes |