Commander Digitwin API

Permission

entities.views:view (on templatePropertyId) digitwins:edit

Accessible

Tenant Only. See response and accessibility information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/LoadViewTemplate

URL Params

NONE

Data Params

{
    "templatePropertyId": "Guid",
    "subscribeToTemplate": "bool"
}

• templatePropertyId: Guid (required)
• subscribeToTemplate: bool

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

The Subscribe and Unsubscribe calls cannot be used via REST. As they use SignalR context

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplate

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templateId": "Guid",
    "includeNestedChildren": "bool"
}

• viewId: string (required)
• templateId: Guid (required)
• includeNestedChildren: bool

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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetRelevantInstances

URL Params

NONE

Data Params

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

• viewId: string (required)
• 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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetRelevantInstanceIdsByTemplatePropertyIdPaths

URL Params

NONE

Data Params

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

• viewId: string (required)
• 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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplateByProperty

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templatePropertyId": "string",
    "includeNestedChildren": "bool"
}

• viewId: string (required)
• templatePropertyId: string (required)
• includeNestedChildren: bool

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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplatePropertyChildren

URL Params

NONE

Data Params

{
    "viewId": "string",
    "parentPropertyId": "string"
}

• viewId: string (required)
• parentPropertyId: 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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/ResolveTemplateInstancesAndProperties

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templateId": "Guid",
    "types": ["string", "string"]
}

• viewId: string (required)
• templateId: Guid (required)
• types: 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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetInstancePropertiesByTemplatePropertyIds

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templatePropertyIds": ["string", "string"]
}

• viewId: string (required)
• templatePropertyIds: IEnumerable (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

Permission

entities.views:views (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetLimitedInstancePropertiesByTemplatePropertyIds

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templatePropertyIds": ["string", "string"],
    "pageSize": "int",
    "thresholdId": "string"
}

• viewId: string (required)
• templatePropertyIds: IEnumerable (required)
• pageSize: int
• thresholdId: 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

Permission

entities.views:views (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

URL	https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetDigitwinIdType

URL Params

NONE

Data Params

{
    "viewId": "string",
    "digitwinId": "string"
}

• viewId: string (required)
• digitwinId: 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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplateIdsByPropertyIds

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templatePropertyIds": ["string", "string"]
}

• viewId: string (required)
• templatePropertyIds: 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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetRelevantInstance

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templateId": "Guid",
    "templatePropertyId": "string"
}

• viewId: string (required)
• templateId: Guid (required if templatePropertyId is undefined)
• templatePropertyId: string (required if templateId is undefined)

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

Permission

entities.views:view (on viewId)

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetPropertyPaths

URL Params

NONE

Data Params

{
    "viewId": "string",
    "templatePropertyIdPaths": ["string", "string"]
}

• viewId: string (required)
• templatePropertyIdPaths: 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

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplateProperty

URL Params

NONE

Data Params

{
    "templatePropertyId": "Guid"
}

• templatePropertyId: Guid (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

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplatePropertyAncestry

URL Params

NONE

Data Params

{
    "templatePropertyId": "Guid"
}

• templatePropertyId: Guid (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

Ancestry is bound to the digital twin template (farthes ancestor) and the digital twin property itself (nearest ancestor).

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/dapi/v1/CommanderDigitwin/GetTemplatePropertyNamedPath

URL Params

NONE

Data Params

{
    "templatePropertyIdPath": "string"
}

• templatePropertyId: 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

The first ID in the path will always represent the digital twin template within to find a matching digitwin property ID path. Nested and deep nested digital twin instances are supported.