Entity Endpoint API

Jan 1 2022 at 12:00 AM

APIs within Entity Endpoint API
1. EntityEndpoint
  1. API Calls

This service is responsible for managing endpoint entities and their metadata.

APIs within Entity Endpoint API

EntityEndpoint

API Calls

Get

Permission

Entity Path Access and “entities:get”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/Get

URL Params

None

Data Params

data: 
{
    "clientId": "text"
}

clientId: 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 accessibility 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 accessibility information for more

Notes

None

GetMany

Permission

Entity Path Access and “entities:get”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/GetMany

URL Params

None

Data Params

data: 
{
    "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 accessibility 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 accessibility information for more

Notes

None

GetNext1000

Permission

Checks permission “entities:global_get

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/GetNext1000

URL Params

None

Data Params

data: 
{
    "lastFetchedId": "string"
}

lastFetchedId: string

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility 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 accessibility information for more

Notes

None

Add

Permission

Checks Entity Path Access and “entities.calendar:add”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/Get

URL Params

None

Data Params

data: 
{
    "id": "string", 
    "rowVersion": "string", 
    "routingKey": "string", 
    "gatewayPath": "string", 
    "publishRoutingKey": "string", 
    "storageKey": "string", 
    "managedBy": "string", 
    "dataType": "Undefined"(enum), 
    "publishRoutingKeyEntityType": "Default"(enum), 
    "allowNotificationsToTheEdge": true, 
    "valueTimeout": 0
}

data: Endpoint (required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility 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 accessibility information for more

Notes

None

AddMany

Permission

Checks Entity Path Access and “entities.calendar:add”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/AddMany

URL Params

None

Data Params

data: 
{
    [
        {
            "id": "string", 
            "rowVersion": "string", 
            "routingKey": "string", 
            "gatewayPath": "string", 
            "publishRoutingKey": "string", 
            "storageKey": "string", 
            "managedBy": "string", 
            "dataType": "Undefined"(enum), 
            "publishRoutingKeyEntityType": "Default"(enum), 
            "allowNotificationsToTheEdge": true, 
            "valueTimeout": 0
        },
        {
            "id": "string", 
            "rowVersion": "string", 
            "routingKey": "string", 
            "gatewayPath": "string", 
            "publishRoutingKey": "string", 
            "storageKey": "string", 
            "managedBy": "string", 
            "dataType": "Undefined"(enum), 
            "publishRoutingKeyEntityType": "Default"(enum), 
            "allowNotificationsToTheEdge": true, 
            "valueTimeout": 0
        }
    ]
}

data: 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 accessibility 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 accessibility information for more

Notes

None

Update

Permission

Checks Entity Path Access and “entities.calendar:edit”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/Update

URL Params

None

Data Params

data: 
{
    "OldDataRowVersion":"string", 
    "NewData": 
    {
        "id": "string", 
        "rowVersion": "string", 
        "routingKey": "string", 
        "gatewayPath": "string", 
        "publishRoutingKey": "string", 
        "storageKey": "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 accessibility 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 accessibility information for more

Notes

None

UpdateMany

Permission

Checks Entity Path Access and “entities.calendar:edit”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/UpdateMany

URL Params

None

Data Params

data: 
{
    {
        "OldDataRowVersion":"string", 
        "NewData": 
        {
            "id": "string", 
            "rowVersion": "string", 
            "routingKey": "string", 
            "gatewayPath": "string", 
            "publishRoutingKey": "string", 
            "storageKey": "string", 
            "managedBy": "string", 
            "dataType": "Undefined"(enum), 
            "publishRoutingKeyEntityType": "Default"(enum), 
            "allowNotificationsToTheEdge": true, 
            "valueTimeout": 0
        }
    },
    {
        "OldDataRowVersion":"string", 
        "NewData": 
        {
            "id": "string", 
            "rowVersion": "string", 
            "routingKey": "string", 
            "gatewayPath": "string", 
            "publishRoutingKey": "string", 
            "storageKey": "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 accessibility 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 accessibility 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 accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/AddOrUpdate

URL Params

None

Data Params

data: 
{
    "OldDataRowVersion":"string", 
    "NewData":
    {
        "id": "string", 
        "rowVersion": "string", 
        "routingKey": "string", 
        "gatewayPath": "string", 
        "publishRoutingKey": "string", 
        "storageKey": "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 accessibility 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 accessibility 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 accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/AddOrUpdateMany

URL Params

None

Data Params

data: 
{
    [
        {
            "OldDataRowVersion":"string", 
            "NewData":
            {
                "id": "string", 
                "rowVersion": "string", 
                "routingKey": "string", 
                "gatewayPath": "string", 
                "publishRoutingKey": "string", 
                "storageKey": "string", 
                "managedBy": "string", 
                "dataType": "Undefined"(enum), 
                "publishRoutingKeyEntityType": "Default"(enum), 
                "allowNotificationsToTheEdge": true, 
                "valueTimeout": 0
            }
        },
        {
            "OldDataRowVersion":"string", 
            "NewData":
            {
                "id": "string", 
                "rowVersion": "string", 
                "routingKey": "string", 
                "gatewayPath": "string", 
                "publishRoutingKey": "string", 
                "storageKey": "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 accessibility 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 accessibility information for more

Notes

None

Remove

Permission

Checks Entity Path Access and “entities.calendar:delete”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/Remove

URL Params

None

Data Params

data: 
{
    "id": "text"
}

id: 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 accessibility 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 accessibility information for more

Notes

None

Copy

Permission

Checks Entity Path Access and “entities.calendar:edit

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/Copy

URL Params

None

Data Params

data: 
{
    "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 accessibility 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 accessibility information for more

Notes

None

CopyMany

Permission

Checks Entity Path Access and “entities.calendar:edit”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/CopyMany

URL Params

None

Data Params

data: 
{
    "masterToTargetIds": {
        "MasterIDstring": "TargetIDstring", 
        "MasterIDstring": "TargetIDstring", 
        "MasterIDstring": "TargetIDstring"
        }
}

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 accessibility 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 accessibility information for more

Notes

None

RemoveMany

Permission

Checks Entity Path Access and “entities.calendar:edit”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/RemoveMany

URL Params

None

Data Params

data: 
{
    "ids": 
    [
        "string", 
        "string"
    ]
}

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 accessibility 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 accessibility information for more

Notes

None

GetEntityIdsForGateway

Permission

Checks Entity Path Access and “entities:get”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/GetEntityIdsForGateway

URL Params

None

Data Params

{
    "gatewayId": "gateway1", 
    "pagingOptions": 
    { 
        "PageSize": 10, 
        "LastReturnedId": "guid"  
    }
}

gatewayId: string (required)
pagingOptions: PagingOptions (required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility 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 accessibility information for more

Notes

None

GetByGatewayId

Permission

Checks Entity Path Access and “entities:get”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/GetByGatewayId

URL Params

None

Data Params

data: 
{
    "gatewayId": "gateway1", 
    "pagingOptions": 
    { 
        "PageSize": 10, 
        "LastReturnedId": "guid"  
    }
}

gatewayId: string (required)
pagingOptions: PagingOptions (required)

Success Response

Response message with the following codes and JSON body formats. Refer to the API Response Types Success Response. See response and accessibility 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 accessibility information for more

Notes

None

GetEntityIdsForGatewayPath

Permission

Checks Entity Path Access and “entities:get”

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityEndpoint/GetEntityIdsForGatewayPath

URL Params

None

Data Params

data: 
{ 
    "gatewayPath": "gateway1" 
}

gatewayPath: 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 accessibility 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 accessibility information for more

Notes

None

Entity Endpoint API

APIs within Entity Endpoint API

EntityEndpoint

API Calls

Continue reading

Community

Questions

Website