Digitwin Instance Maintenance API
Jan 1 2022 at 12:00 AM
The Digitwin Instance Maintenance API contains API calls for running maintenance operations on Digital Twin instances. Administator permissions are required to perform maintenance operations.
APIs within Digitwin Instance Maintenance API
DigitwinInstanceMaintenance
API Calls
RealignInstanceStaticEndpointIds
Permission
digitwins:edit
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/RealignInstanceStaticEndpointIds
URL Params
None
Data Params
{
"limit":int"
}
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
PopulatePropertiesDictionary
Permission
digitwins:edit
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/PopulatePropertiesDictionary
URL Params
None
Data Params
{
"doAll":"bool",
"limit":"int"
}
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
RecreateMisalignedStaticEndpointInstances
Permission
No permission check
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/RecreateMisalignedStaticEndpointInstances
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
ReTagInstances
Permission
full access
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/ReTagInstances
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
RecreateStaticEndpoints
Permission
full access
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/RecreateStaticEndpoints
URL Params
None
Data Params
{
"instanceId": "string",
"templateId": "Guid"
}
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
ResendInstancesStaticEndpointValues
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/ResendInstancesStaticEndpointValues
URL Params
None
Data Params
{
"instanceIds": "IEnumerable<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
ResendTemplateInstancesStaticEndpointValues
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/ResendTemplateInstancesStaticEndpointValues
URL Params
None
Data Params
{
"templateId": "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
ResendSeriesInstancesStaticEndpointValues
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinInstanceMaintenance/ResendSeriesInstancesStaticEndpointValues
URL Params
None
Data Params
{
"series": "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
AlignAncestorAndNestedPropertyIdDataByInstanceIds
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://portal.iotnxt.io/DAPI/v1/DigitwinInstanceMaintenance/AlignAncestorAndNestedPropertyIdDataByInstanceIds
URL Params
None
Data Params
{
"instanceIds": "List<string>",
"deepNestedFilter": "List<string>",
"logOnly": "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
AlignAncestorAndNestedPropertyIdDataByTemplateId
Permission
No permission check.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://portal.iotnxt.io/DAPI/v1/DigitwinInstanceMaintenance/AlignAncestorAndNestedPropertyIdDataByTemplateId
URL Params
None
Data Params
{
"templateId": "List<string>",
"deepNestedFilter": "List<string>",
"logOnly": "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