Portal API

Jan 1 2022 at 12:00 AM

Prerequisites
APIs within Portal API
1. Portal
  1. API Calls

The Portal API is used as a Portal UI aggregator for the Digitwin Template API and Digitwin Instance API.

Prerequisites

To use this service, a user must have access to Portal UI and been given Digital Twin Edit permissions.

APIs within Portal API

Portal

API Calls

GetDigitwinTemplateRoot

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateRoot

URL Params

NONE

Data Params

NONE

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

GetDigitwinTemplateDesignRoot

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateDesignRoot

URL Params

NONE

Data Params

NONE

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

GetDigitwinTemplate

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplate

URL Params

NONE

Data Params

{
    "templateId": "Guid"
}

templateId: 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

GetDigitwinTemplates

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplates

URL Params

NONE

Data Params

{
    "templateId": {"Guid", "Guid"}
}

templateId: 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

GetActiveTemplates

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetActiveTemplates

URL Params

NONE

Data Params

NONE

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

GetDesigningTemplates

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDesigningTemplates

URL Params

NONE

Data Params

NONE

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

GetInactiveTemplates

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetInactiveTemplates

URL Params

NONE

Data Params

NONE

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

AddNewTemplateDesign

Permission

digitwins:add

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/AddNewTemplateDesign

URL Params

NONE

Data Params

{
    "name": "string",
    "type": "Site"
}

name: string (required)
type: DigitwinTemplateType (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

SetTemplateDesignName

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetTemplateDesignName

URL Params

NONE

Data Params

{
    “templateId”: “Guid”,
    “newName”: “string”
}

templateId: Guid (required)
newName: 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

DeactivateDigitwinTemplate

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/DeactivateDigitwinTemplate

URL Params

NONE

Data Params

{
    “templateId”: “Guid”
}

templateId: 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

DeleteDigitwinTemplate

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/DeleteDigitwinTemplate

URL Params

NONE

Data Params

{
    “templateId”: “Guid”
}

templateId: 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

SaveDigitwinTemplate

Permission

digitwins:save

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SaveDigitwinTemplate

URL Params

NONE

Data Params

{
    “templateId”: “Guid”
}

templateId: 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

AddNewDigitwinProperty

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/AddNewDigitwinProperty

URL Params

NONE

Data Params

{
    “templateId”: “Guid”,
    "property": {
            "PropertyName": "string",
            "PropertyDefinition": "BsonDocument",
            "DataType": "GpsCoordinate",
            "Type": "Endpoint",
            "DigitwinTemplateInstanceId": "Guid",
            "RegexTokensDictionary": {"string”:”string"}
          }

}

templateId: Guid (required)
property: DigitwinProperty (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

UpdateDigitwinProperty

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/UpdateDigitwinProperty

URL Params

NONE

Data Params

{
    “templateId”: “Guid”,
    "property": {
            "PropertyName": "string",
            "PropertyDefinition": "BsonDocument",
            "DataType": "GpsCoordinate",
            "Type": "Endpoint",
            "DigitwinTemplateInstanceId": "Guid",
            "RegexTokensDictionary": {"string”:”string"}
          }

}

templateId: Guid (required)
property: DigitwinProperty (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

SetDigitwinPropertyDefinition

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetDigitwinPropertyDefinition

URL Params

NONE

Data Params

{
    “templateId”: “Guid”,
    “propertyId”: “Guid”,
    “propertyDefinition”: “BsonDocument”
}

templateId: Guid (required)
propertyId: Guid (required)
propertyDefinition: BsonDocument (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

RenameDigitwinProperty

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/RenameDigitwinProperty

URL Params

NONE

Data Params

{
    “templateId”: “Guid”,
    “propertyId”: “Guid”,
    “newName”: “string”
}

templateId: Guid (required)
propertyId: Guid (required)
newName: 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

RemoveDigitwinProperty

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/RemoveDigitwinProperty

URL Params

NONE

Data Params

{
    “templateId”: “Guid”, 
    “propertyId”: “Guid“
}

templateId: Guid (required)
propertyId: 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

GetEmptyBlueprintList

Permission

tags.get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetEmptyBlueprintList

URL Params

NONE

Data Params

NONE

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

EditTemplateDesign

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetEmptyBlueprintList

URL Params

NONE

Data Params

{
    “templateId”: “Guid” 
}

templateId: 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

AddDigitwinInstance

Permission

digitwins:add

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/AddDigitwinInstance

URL Params

NONE

Data Params

{
    “instance”: “DigitwinAddInstanceDto”
}

instance: DigitwinAddInstanceDto (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

RemoveDigitwinInstance

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/RemoveDigitwinInstance

URL Params

NONE

Data Params

{
    “instanceId”: “text”
}

instanceId: 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

UpdateDigitwinInstance

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/UpdateDigitwinInstance

URL Params

NONE

Data Params

{
"instance": {
            "Entity": {
              "EntityId": "string",
              "UiMayEdit": "bool",
              "ManagedBy": "string",
              "Ancestors": {
                "EntityId": "string"
              },
              "Name": "string",
              "Description": "string",
              "ParentId": "string",
              "IdPath": "string",
              "Tags": "List<string>",
              "Level": "int",
              "Children": "IReadOnlyCollection<string>",
              "Authorised": "bool"
            },
            "StaticEndpoints": {
                “Id”:”string”,
                “Name”:”string”,
                “Path”:”string”,
                “DataType”:GpsCoordinate,
                “Value”:object,
                “DateSet”:DateTime,
                “InstanceId”:”string”,
                “TemplateId”:”Guid”,
                “DigitwinPropertyId”:”Guid”,
                “PropertySeries”:”Guid”
                            }
            } 
}

instance: DigitwinUpdateInstanceDto (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

SetStaticEndpointValues

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetStaticEndpointValues

URL Params

NONE

Data Params

{
          "instanceId": "string",
          "staticEndpointValues":  {
                “Id”:”string”,
                “Name“:“string“,
                “Path“:“string“,
                “DataType“:“GpsCoordinate“,
                “Value“:object,
                “DateSet“:DateTime“,
                “InstanceId“:string“,
                “TemplateId“:Guid“,
                “DigitwinPropertyId“:Guid“,
                “PropertySeries“:“Guid“}
}

instanceId: string (required)
staticEndpointValues: 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

SetUserContactGroupValues

Description

Replaces user contact group values of the instance (including nests).

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetUserContactGroupValues

URL Params

NONE

Data Params

{
    "instanceId": "string",
    "userContactGroupValues": []
}

instanceId: string (required)
userContactGroupValues: 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

GetStaticEndpointValues

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetStaticEndpointValues

URL Params

NONE

Data Params

{
    “instanceId”:”string”,
    “templateId”:”Guid”
}

instanceId: string (required)
templateId: 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

GetImageEntityValues

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/DAPI/v1/Portal/GetImageEntityValues

URL Params

NONE

Data Params

{
    “instanceId”:”string”,
    “templateId”:”Guid”
}

instanceId: string (required)
templateId: Guid (required)

Success Response

{
  "result": [{
    "id": "85ea2066-1853-4be4-8e8e-5ae7798bab25",
    "name": "",
    "path": "",
    "AssetId": "fd7c63ae-abf8-45af-b74a-135727d01b09",
    "contentType": “image/jpeg”,
    "imageSize": 0,
    "DateSet": "",
    "instanceId": “”,
    "templateId": “e8513e75-a76d-49f8-aee3-c362a2106ef2”,
    "digitwinPropertyId": “baac09e9-3342-4cc4-820e-f8f9a6298028”,
    "propertySeries":” 116f93dc-c658-4ec2-9d8d-2cd72ccd410f”
  }],
  "messageType": "OK",
  "state": null,
  "sourceMessageID": null
}

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

GetUserContactGroupValues

Description

Fetches user contact group values of the instance (including nests).

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetUserContactGroupValues

URL Params

NONE

Data Params

{
    “instanceId”:”string”,
    “templateId”:”Guid”
}

instanceId: string (*required)
templateId: Guid (*required)

*At least one

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

GetSeriesStaticEndpointValues

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetSeriesStaticEndpointValues

URL Params

NONE

Data Params

{
    “series”:”string”
}

series: 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

GetDigitwinTemplateInstanceLinks

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateInstanceLinks

URL Params

NONE

Data Params

   {
    “templateSeries”:”Guid”,
    “pagingOptions”: {
        “Limit”:”int”,
        “Skip”:”int”,
        “Threshold”:”string”
     },
    “templateId”:”Guid”
}

templateSeries: Guid (required)
pagingOptions: PagingOptions (required)
templateId: 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

RemoveDigitwinInstanceLink

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateInstanceLinks

URL Params

NONE

Data Params

{
   “instanceId”:”string”,
    “templateId”:”Guid”
}

instanceId: string (required)
templateId: 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

UpdateDigitwinInstanceEntity

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/UpdateDigitwinInstanceEntity

URL Params

NONE

Data Params

{
    "instance": {
            "Entity": {
              "EntityId": "string",
              "UiMayEdit": "bool",
              "ManagedBy": "string",
              "Ancestors": {
                "EntityId": "string"
              },
              "Name": "string",
              "Description": "string",
              "ParentId": "string",
              "IdPath": "string",
              "Tags": "List<string>",
              "Level": "int",
              "Children": "IReadOnlyCollection<string>",
              "Authorised": "bool"
            },
            "StaticEndpoints": "List<{
                    “Id”:”string”,
                    “Name”:”string”,
                    “Path”:”string”,
                    “DataType”:{
                    {
                    “GpsCoordinate”:”enum”
                    } },
                    “Value”:”object”,
                    “DateSet”:”DateTime”,
                    “InstanceId”:”string”,
                    “TemplateId”:”Guid”,
                    “DigitwinPropertyId”:”Guid”,
                    ”PropertySeries”:”Guid”
                    }>"
    }
}

instance: DigitwinUpdateInstanceDto (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

GetDigitwinInstance

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinInstance

URL Params

NONE

Data Params

{
    “instanceId”:”string”
}

instanceId: 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

GetDigitwinTemplateSeries

Permission

digitwins:get

Accessible

Portal Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateSeries

URL Params

NONE

Data Params

{
    “seriesId”:”Guid”,
    “baselineVersion”:”int”
}

seriesId: Guid (required)
baselineVersion: int (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

GetActiveDigitwinTemplateOfSeries

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetActiveDigitwinTemplateOfSeries

URL Params

NONE

Data Params

{
    “seriesId”:”Guid”,
}

seriesId: 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

GetTemplateGatewayTokens

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateGatewayTokens

URL Params

NONE

Data Params

{
    "templateId": "Guid",
    "excludeNestedTemplates": false,
}

templateId: Guid (required)
excludeNestedTemplates: bool (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

DuplicateTemplateDesign

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateGatewayTokens

URL Params

NONE

Data Params

{
    "templateId": "Guid",
    "name": "string",
    "type": "DigitwinTemplateType",
}

templateId: Guid (required)
name: string (required)
type: DigitwinTemplateType

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

MigrateInstance

Permission

digitwins:rollout

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/MigrateInstance

URL Params

NONE

Data Params

{
    "oldTemplateId": "Guid",
    "newTemplateId": "Guid",
    "instanceId": "string",
    "staticEndpoints": [],
    "userContactGroups": []
}

oldTemplateId: Guid (required)
newTemplateId: Guid (required)
instanceId: string (required)
staticEndpoints: List (optional)
userContactGroups: List (optional)

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

MigrateInstances

Permission

digitwins:rollout

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/MigrateInstances

URL Params

NONE

Data Params

{
    "instanceIds": ["string"],
    "newTemplateId": "Guid",
    "staticEndpointValues": [],
    "userContactGroups": [],
    "gatewayId": "string",
    "gatewayTokens": [],
    "regexTokens": [],
    "imageEntities"" []
}

instanceIds: List (required)
newTemplateId: Guid (required)
staticEndpointValues: List (optional)
userContactGroups: List (optional)
gatewayId: string (optional)
gatewayTokens: List (optional)
regexTokens: List (optional)
imageEntities: List (optional)

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

If ‘newTemplateId’ matches the instance’s current template then an update is performed else an upgrade is performed.

SetTemplateDesignBlueprintName

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetTemplateDesignBlueprintName

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    “newBlueprintName”:”string”
}

templateId: Guid (required)
newBlueprintName: 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

SetDigitwinPropertyMultilevelBlueprintName

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetDigitwinPropertyMultilevelBlueprintName

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    “propertyId”:”Guid”,
    “newBlueprintName”:”string”
}

templateId: Guid (required)
propertyId: Guid (required)
newBlueprintName: 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

ExportTemplates

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ExportTemplates

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    “propertyId”:”Guid”,
    “newBlueprintName”:”string”
}

templateIds: List (required)
excludeDependents: bool (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

AnalyzeImportData

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/AnalyzeImportData

URL Params

NONE

Data Params

{
    "importData": "JObject"
}

importData: JObject (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

Return an ImportDataAnalysis with the following properties:

importable: indicates if the data is importable
cloneable: indicates if the data is cloneable
mergeable: indicates if the data is mergeable
importPreventionReasons: A list of reasons the data is not importable
clonePreventionReasonsByTemplateId: A list of reasons (by template ID) the data is not cloneable
mergePreventionReasonsByTemplateId: A list of reasons (by template ID) the data is not mergeable
cloneAndMergePreventionReasonsByTemplateId: A list of reasons (by template ID) the data is not cloneable and mergeable

The analysis of the import data gives reasons why importing would not be possible.

If ‘importable’ is false it would indicate that no import of any type will succeed with the given data.
If ‘cloneable’ is false it would indicate that no import of type clone will succeed with the given data.
If ‘mergeable’ is false it would indicate that no import of type merge will succeed with the given data.

ImportTemplates

Permission

digitwins:add

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ImportTemplates

URL Params

NONE

Data Params

{
    "importData": "JObject",
    "importOptions": {
      "taskId": "Guid?",
      "subTaskId": "String",
      "type": "ImportType"
    }
}

importData: JObject (required)
importOptions: ImportOptions (optional)

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

There are two import types:

Clone (default if importOptions.type is left out):
- Each template will get a new ID and series
- Each template will be set to version 1 of its new series
- Each property in each template will get a new ID and series
- Each property in each template will be set to version 1 of its series
Merge:
- Each template whose series exists:
  - Will keep its ID and series
  - Will be set to the next version of its series
- Each template whose series does not exist:
  - Will keep its ID and series
  - Will be set to version 1 of its series
- Each property of each template whose series exists:
  - Will keep its ID and series
  - Will be set to the next version of its series
- Each property of each template whose series does not exist:
  - Will keep its ID and series
  - Will be set version 1 of its series

Task progress can be logged to an existing task progress using taskId and subTaskId.

LinkDigitwinInstanceAndGateway

Permission

digitwins:apply

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/LinkDigitwinInstanceAndGateway

URL Params

NONE

Data Params

{
    “instanceId”:”string”,
    “gatewayId”:”string”,
    “regexTokensDictionary”:”Dictionary<string, string>”
}

instanceId: string (required)
gatewayId: string (required)
regexTokensDictionary: 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

GetDigitwinProperty

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinProperty

URL Params

NONE

Data Params

{
    “propertyId”:”Guid”
}

propertyId: 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

ApplyTemplate

Permission

digitwins:apply

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ApplyTemplate

URL Params

NONE

Data Params

 {
    "instance": {
                "Id": "string",
                "TemplateId": "Guid",
                "StaticEndpoints":"List<{
                        “Id”:”string”,
                        “Name”:”string”,
                        “Path”:”string”,
                        “DataType”:{
                        {
                        “GpsCoordinate”:”enum”
                        },
                        “Value”:”object”,
                        “DateSet”:”:DateTime”,
                        “InstanceId”:”string”,
                        “TemplateId”:”Guid”,
                        “DigitwinPropertyId”:”Guid”,
                        “PropertySeries”:”Guid”
                        }>"
    }
 }

instance: DigitwinApplyTemplateDto (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

SubscribeToGateway

Permission

support:sub_gateway

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SubscribeToGateway

URL Params

NONE

Data Params

 {
    “gatewayId”:”string”
 }

gatewayId: 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

UnsubscribeFromGateway

Permission

NONE

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/UnsubscribeFromGateway

URL Params

NONE

Data Params

 {
    “gatewayId”:”string”
 }

gatewayId: 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

ResolveDigitwinPropertyPathAsIds

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ResolveDigitwinPropertyPathAsIds

URL Params

NONE

Data Params

 {
    “propertyId”:”Guid”
 }

propertyId: 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

ResolveDigitwinPropertyPathAsNames

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ResolveDigitwinPropertyPathAsNames

URL Params

NONE

Data Params

 {
    "propertyId":”Guid”
 }

propertyId: 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

GetDigitwinTemplateName

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateName

URL Params

NONE

Data Params

 {
    "templateId":"Guid"
 }

templateId: 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

ExtractTemplateRegexTokens

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ExtractTemplateRegexTokens

URL Params

NONE

Data Params

 {
    "templateId":"Guid"
 }

templateId: 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

GetTemplateRegexTokens

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateRegexTokens

URL Params

NONE

Data Params

 {
    "templateId":"Guid"
 }

templateId: 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

GetInstancesPropertiesMappings

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetInstancesPropertiesMappings

URL Params

NONE

Data Params

 {
    “instanceIds”:”string[]”
 }

instanceIds: 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

GetDigitwinTemplateInfo

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateInfo

URL Params

NONE

Data Params

 {
    “templateId”:”Guid”
 }

templateId: 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

GetDigitwinTemplateReferenceLinks

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateReferenceLinks

URL Params

NONE

Data Params

 {
    “templateSeries”:”Guid”
 }

templateSeries: 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

UpgradeNestedDigitwinTemplate

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/UpgradeNestedDigitwinTemplate

URL Params

NONE

Data Params

 {
    “templateId”:”Guid”,
    “propertyId”:”Guid”,
    “newNestedTemplateId”:”Guid”
 }

templateId: Guid (required)
propertyId: Guid (required)
newNestedTemplateId: 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

ValidateDigitwinDesignForActivation

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ValidateDigitwinDesginForActivation

URL Params

NONE

Data Params

 {
    "desginId":”Guid”,
 }

designId: 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

GetDigitwinTemplateStaticEndpoints

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinTemplateStaticEndpoints

URL Params

NONE

Data Params

 {
    "templateId":”Guid”,
 }

templateId: 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

GetTemplateUserContactGroups

Description

Gets user contact groups (with defaults) of the template (including nests).

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateUserContactGroups

URL Params

NONE

Data Params

 {
    "templateId":”Guid”,
 }

templateId: 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

SubscribeToDigitwinTemplateUpdates

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SubscribeToDigitwinTemplateUpdates

URL Params

NONE

Data Params

NONE

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

UnsubscribeFromDigitwinTemplateUpdates

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/UnsubscribeFromDigitwinTemplateUpdates

URL Params

NONE

Data Params

NONE

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

SetTemplateDesignRegexTokensDct

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetTemplateDesignRegexTokensDct

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    “regexTokensDct”:”Dictionary<string, string>”
}

templateId: Guid (required)
regexTokensDct: 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

RemoveTemplateDesignRegexTokenFromDct

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/RemoveTemplateDesignRegexTokenFromDct

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    "token":"string"
}

templateId: Guid (required)
regexTokensDct: 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

GetTokensForDigitwinInstance

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTokensForDigitwinInstance

URL Params

NONE

Data Params

{
    "instanceId":"guid"
}

instanceId: 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

SetTemplateDesignDefaultView

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetTemplateDesignDefaultView

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    “newDefaultViewId”:”Guid”
}

templateId: Guid (required)
newDefaultViewId: 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

SetTemplateDesignDefultView

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetTemplateDesignDefaultView

URL Params

NONE

Data Params

{
    “templateId”:”Guid”,
    “newDefaultViewId”:”Guid”
}

templateId: Guid (required)
newDefaultViewId: 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

GetBasicTemplateSeriesVersions

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetBasicTemplateSeriesVersions

URL Params

NONE

Data Params

{
    "seriesId":”Guid”,
}

seriesId: 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

GetTemplateSeriesVersions

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateSeriesVersions

URL Params

NONE

Data Params

{
“templateId”:”Guid,
"pagingOptions": {
    "limit": 10,
    "skip": 0
  }
}

templateId: Guid (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 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

GetDigitwinInstancesValues

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetDigitwinInstancesValues

URL Params

NONE

Data Params

Example
{
“instances”:
[
	{
		"templateId":"Guid",
		"instanceId":"string"
	}
]
}

templateId: Guid (required)
instanceId: 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

SetDigitwinInstancesValues

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/SetDigitwinInstancesValues

URL Params

NONE

Data Params

Example
{
	"instanceValuesDto":	
	[
		{
			"templateId":"Guid",
			"instanceId":"string",
			"regexTokens": 
			[
				{
					"token":"string"
				}
			],
			"gatewayTokens": 
			[
				{
					"path":"string",
					"seriesPath":"string",
					"value":"string",
					"propertyId":"Guid"
				}
			],
			"staticEndpoints": 
			[
				{
					"name":"string",
					"path":"string",
					"dataType":"DigitwinDataType",
					"propertyId":"Guid",
					"PropertySeries":"Guid",
					"templateId":"Guid",
					"nestedTemplatePropertyId":"Guid"
				}
			],
			"ancestorInstance":{
				"templateId":"Guid",
				"instanceId":"string"
			}		
		}
	]
}

instanceValuesDto: 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

DeleteInstances

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/DeleteInstances

URL Params

NONE

Data Params

Example
{
	"instanceIds":	
	[
		"string",
		"string",
		"string"
	]
}

instanceIds: 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

GetTemplateVersionsWithLinkedInstances

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateVersionsWithLinkedInstances

URL Params

NONE

Data Params

Example
{
	"seriesId":	"string"
}

seriesId: 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

AddDigitwinInstances

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/AddDigitwinInstances

URL Params

NONE

Data Params

{
	"templateId":"Guid",
	"instancesToAdd": 
	[
		{
			"rootInstanceId":"string",
			"parentEntityId":"string",
			"name":"string",
			"staticEndpoints: 
			[
				{
					"name":"string",
					"path":"string",
					"dataType":"DigitwinDataType",
					"value":"object",
					"propertyId":"Guid",
					"propertySeries":"Guid",
					"templateId":"Guid",
					"nestedTemplatePropertyId":"Guid"
				}
			],
			"regexTokens":
			[
				
				{
					"token":"string"
				}
			],
			"gatewayTokens":
			[
				
				{
					"path":"string",
					"seriesPath":"string",
					"value":"string",
					"propertyId":"Guid"
				}
			]
		}
	]
}

templateId: Guid (required)
instancesToAdd: List

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

ImportDigitwinInstances

Permission

digitwins:edit

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/ImportDigitwinInstances

URL Params

NONE

Data Params

{
	"templateId":"Guid",
	"importInstances": 
	[
		{
			"rootInstanceId":"string",
			"parentEntityId":"string",
			"name":"string",
			"staticEndpoints: 
			[
				{
					"name":"string",
					"path":"string",
					"dataType":"DigitwinDataType",
					"value":"object",
					"propertyId":"Guid",
					"propertySeries":"Guid",
					"templateId":"Guid",
					"nestedTemplatePropertyId":"Guid"
				}
			],
			"regexTokens":
			[
				
				{
					"token":"string"
				}
			],
			"gatewayTokens":
			[
				
				{
					"path":"string",
					"seriesPath":"string",
					"value":"string",
					"propertyId":"Guid"
				}
			]
		}
	]
}

templateId: Guid (required)
importInstances: List

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

FetchDigitwinInstanceIdsThatExist

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/FetchDigitwinInstanceIdsThatExist

URL Params

NONE

Data Params

{
	"instanceIds":
	[
		"string",
		"string"
	]
}

instanceIds: 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

GetTemplateSeriesInstances

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetTemplateSeriesInstances

URL Params

NONE

Data Params

{
	"seriesId":"string",
	"pagingOptions":
	{
		"limit":"int",
		"skip":"int",
		"threshold":"string"
	},
	"nameSearchText":"string"
}

seriesId: string (required)
pagingOptions: PagingOptions (required)
nameSearchText: string (optional)

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

GetInstanceDataLinkedToGateway

Permission

digitwins:get

Accessible

Tenant Only. See response and accessiblity information for more

URL

https://iotnxtinternal.commander.io/default/_apis/DAPI/v1/Portal/GetInstanceDataLinkedToGateway

URL Params

NONE

Data Params

{
	"gatewayIds":
	[
		"string",
		"string"
	],
	"mainInstancesOnly":"bool"
}

gatewayId: List (required)
mainInstancesOnly: bool (optional)

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

Portal API

Prerequisites

APIs within Portal API

Portal

API Calls

Continue reading

Community

Questions

Website