Link Search Menu Expand Document

Entity Dependency API

Jan 1 2022 at 12:00 AM

  1. APIs within Entity Dependency API
    1. EntityDependency
      1. API Calls

The Entity Dependency API is responsible for calculating an entity’s active states based on its dependencies. The following entities need to have their active states calculated:

  • Functions
  • Triggers
  • Endpoints
  • Static Endpoints (Always Active)
  • Calendars
  • Calendar Events

APIs within Entity Dependency API

EntityDependency

API Calls

RebuildDependencyDocuments

POST

Permission

full_access

Accessible

Tenant only. See response and accessibility information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityDependancy/RebuildDependencyDocuments

URL Params

None

Data Params

{
    "batchSize": 4,
    "fromStep" : 1,
    "idPath" : "string"
}
  • batchSize: int
  • fromStep : int
  • idPath : 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

RemoveDuplicateStaticEndpointsInEntityEndpoint

POST

Permission

full_access

Accessible

Tenant only. See response and accessibility information for more.

URL

https://iotnxtinternal.commander.io/DAPI/v1/EntityDependancy/RemoveDuplicateStaticEndpointsInEntityEndpoint

URL Params

None

Data Params

{
    "batchSize": 4
   
}

batchSize: int

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