Client API
Jan 1 2022 at 12:00 AM
Client API
Client API is responsible for maintaining a list of clients (aka tenants).
API calls within Client API
Client API
API Calls
Get
GET
Permission
ValidateId on clientId
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/Gethttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/GetURL Params
None
Data Params
{
"clientId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Add
POST
Permission
entities.clients:add
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/Addhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/AddURL Params
None
Data Params
{
"client": {
"clientId": "t000000000",
"name": "string",
"description": "string",
"active": false,
"documentVersion": 2,
"logoUrl": "string",
"autoAllocateGateways": false,
"autoAllocateGatewayToGroupId": "string"
}
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Update
POST
Permission
entities.clients:edit
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/Updatehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/UpdateURL Params
None
Data Params
{
"client": {
"clientId": "t000000000",
"name": "string",
"description": "string",
"active": false,
"documentVersion": 2,
"logoUrl": "string",
"autoAllocateGateways": false,
"autoAllocateGatewayToGroupId": "string"
}
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
Remove
POST
Permission
entities.clients:delete
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/Removehttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/RemoveURL Params
None
Data Params
{
"clientId": "string"
}
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
All
POST
Permission
None
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/Allhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/AllURL Params
None
Data Params
None
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
PublishAll
POST
Permission
None
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/PublishAllhttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/PublishAllURL Params
None
Data Params
None
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None
SubscribeToEvents
POST
Permission
None
Accessible
Core only Refer to the response and accessiblity information for more information.
URL
https://{tenantDomain}/{accountPath}/_apis/dapi/v1/Client/SubscribeToEventshttps://iotnxtinternal.commander.io/default/_apis/dapi/v1/Client/SubscribeToEventsURL Params
None
Data Params
None
Success Response
Refer to the response and accessiblity information for more information.
Error Response
Refer to the response and accessiblity information for more information.
Notes
None