Base Entity Tag API
Jan 1 2022 at 12:00 AM
The Base Entity Tag API is responsible for providing functionality for tagging and retrieving tagged tree entities.
APIs within Base Entity Tag API
BaseEntityTag
API Calls
AddTagToEntityMany
Permission
SECURITY_ENTITYACCESSGROUPS_ADD on Client Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/BaseEntityTag/AddTagToEntityMany
URL Params
None
Data Params
{
"entityIdsToTags": {"string": "string", "string": "string"}
}
- entityIdsToTags: Dictionary<string, 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
RemoveTagFromEntityMany
Permission
SECURITY_ENTITYACCESSGROUPS_ADD on Client Id
Accessible
Tenant only. See response and accessiblity information for more
URL
https://iotnxtinternal.commander.io/DAPI/v1/BaseEntityTag/RemoveTagFromEntityMany
URL Params
None
Data Params
{
"entityIdsToTags": {"string": "string", "string": "string"}
}
- entityIdsToTags: Dictionary<string, 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