Entity Static Endpoint API
Jan 1 2022 at 12:00 AM
This service is responsible for managing static endpoint entities and their metadata.
APIs within Entity Static Endpoint API
EntityStaticEndpoint
API Calls
Get
Permission
Checks Entity Path Access and “entities:get”.
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/Get
URL Params
None
Data Params
{
"id": "text"
}
- id: text
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
GetMany
Permission
Checks Entity Path Access and “entities:get”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/GetMany
URL Params
None
Data Params
{
"ids": ["text","text"]
}
- ids: List
(Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
GetNext1000
Permission
Checks permission “entities:global_get”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/GetNext1000
URL Params
None
Data Params
{
"lastFetchedId": "text"
}
- lastFetchedId: text (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
Add
Permission
Checks Entity Path Access and “entities.calendar:add”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/Add
URL Params
None
Data Params
{
"data":{
"id": "string",
"rowVersion": "string",
"publishRoutingKey": "string",
"storageKey": "string",
"virtualGatewayId": "string",
"managedBy": "string",
"dataType": "Undefined(enum)",
"publishRoutingKeyEntityType": "Default(enum)",
"allowNotificationsToTheEdge": true,
"valueTimeout": 0
}
}
- data: StaticEndpointEntity (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
AddMany
Permission
Checks Entity Path Access and “entities.calendar:add”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/AddMany
URL Params
None
Data Params
{
"data":[
{
"id": "string",
"rowVersion": "string",
"publishRoutingKey": "string",
"storageKey": "string",
"virtualGatewayId": "string",
"managedBy": "string",
"dataType": "Undefined(enum)",
"publishRoutingKeyEntityType": "Default(enum)",
"allowNotificationsToTheEdge": true,
"valueTimeout": 0
}
]
}
- data: StaticEndpointEntity (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
Update
Permission
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/Update
URL Params
None
Data Params
{
"data":{
"id": "string",
"rowVersion": "string",
"publishRoutingKey": "string",
"storageKey": "string",
"virtualGatewayId": "string",
"managedBy": "string",
"dataType": "Undefined(enum)",
"publishRoutingKeyEntityType": "Default(enum)",
"allowNotificationsToTheEdge": true,
"valueTimeout": 0
}
}
- data: UpdateModel
(Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
UpdateMany
Permission
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/UpdateMany
URL Params
None
Data Params
{
"data":[
{
"id": "string",
"rowVersion": "string",
"publishRoutingKey": "string",
"storageKey": "string",
"virtualGatewayId": "string",
"managedBy": "string",
"dataType": "Undefined(enum)",
"publishRoutingKeyEntityType": "Default(enum)",
"allowNotificationsToTheEdge": true,
"valueTimeout": 0
}
]
}
- data: List<UpdateModel
> (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
AddOrUpdate
Permission
Checks Entity Path Access and “entities.calendar:add” or “entities.calendar:edit”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/AddOrUpdate
URL Params
None
Data Params
{
"data":{
"id": "string",
"rowVersion": "string",
"publishRoutingKey": "string",
"storageKey": "string",
"virtualGatewayId": "string",
"managedBy": "string",
"dataType": "Undefined(enum)",
"publishRoutingKeyEntityType": "Default(enum)",
"allowNotificationsToTheEdge": true,
"valueTimeout": 0
}
}
- data: UpdateModel
(Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
AddOrUpdateMany
Permission
Checks Entity Path Access and “entities.calendar:add” or “entities.calendar:edit”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/AddOrUpdateMany
URL Params
None
Data Params
{
"data":[
{ "id": "string",
"rowVersion": "string",
"publishRoutingKey": "string",
"storageKey": "string",
"virtualGatewayId": "string",
"managedBy": "string",
"dataType": "Undefined(enum)",
"publishRoutingKeyEntityType": "Default(enum)",
"allowNotificationsToTheEdge": true,
"valueTimeout": 0
}
]
}
- data: List<UpdateModel
> (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
Remove
Permission
Checks Entity Path Access and “entities.calendar:delete”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/Remove
URL Params
None
Data Params
{
"id": "text"
}
- id: text (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
Copy
Permission
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/Copy
URL Params
None
Data Params
{
"masterId": "string",
"targetId": "string"
}
- masterId: string (Required)
- targetId: string
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
CopyMany
Permission
Checks Entity Path Access and “entities.calendar:edit”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/CopyMany
URL Params
None
Data Params
{
"masterToTargetIds": [{"string": "string", "string": "string"}]
}
- masterToTargetIds: Dictionary<string, string> (Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None
RemoveMany
Permission
Checks Entity Path Access and “entities.calendar:delete”
Accessible
Tenant only. See response and accessiblity information for more.
URL
https://iotnxtinternal.commander.io/DAPI/v1/EntityStaticEndpoint/RemoveMany
URL Params
None
Data Params
{
"ids": ["text", "text"]
}
- ids: List
(Required)
Success Response
Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessiblity information for more.
Error Response
Response message with the following codes and HTMLs body formats. Refer to the API Response Types Error Response. See response and accessiblity information for more.
Notes
None