Digitwin Template Maintenance API
Jan 1 2022 at 12:00 AM
The Digitwin Template Maintenance API contains API calls for running maintenance operations on Digital Twin templates.
Digitwin Template Maintenance API is responsible for running maintenance operations on digital twin templates.
Prerequisites
Administator permissions are required to perform maintenance operations.
APIs within Digitwin Template Maintenance API
DigitwinTemplateMaintenance
API Calls
RemoveSeries
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/RemoveSeries
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
RemoveSeriesByTemplateId
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/RemoveSeriesByTemplateId
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
RemoveAllActivesThatStartWith
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/RemoveAllActivesThatStartWith
URL Params
None
Data Params
{
"prefix": "string"
}
- prefix: 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
RevertVersion
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/RevertVersion
URL Params
None
Data Params
{
"seriesId": "Guid",
"newActiveVersion": "int"
}
- seriesId: Guid (required)
- newActiveVersion: 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
ResetLoading
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/ResetLoading
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
ResetManyLoading
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/ResetManyLoading
URL Params
None
Data Params
{
"templateIds": ["Guid", "Guid"]
}
- templateIds: 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
ResetPropertySeriesIdIfDefault
Permission
Administrator or full access.
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/DigitwinTemplateMaintenance/ResetPropertySeriesIdIfDefault
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