tags/{id}/tagged-entities

Manage Tags's Value Assignment (Customt Attributes value assignments)

Notes

  • Get the assigned value on the entities.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or partnerId of the tenant

  • tagIdstringrequired

    Tag uuid

  • idstringrequired

    Tag value uuid

Responses

  • resultsarray

  • totalResultsinteger

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • previousPageNointeger

  • descendingOrderboolean

Loading Examples...

Notes

  • Assign the custom attribute values to given set of entities
  • Each device supports up to 5 custom attributes with either Log Label, Metric Label, Alert Tag, or Authz Tag enabled
  • When an Authz tag is set to true, the associated Log Label, Metric Label, and Alert Tag are also automatically set to true by default
  • Authz tags can only be created at the client level, with a maximum of 10 Authz tags per client
  • Users can update an Authz tag to true or false. If set to true, the related metric, log, and alert tags are also set to true. If set to false, only the Authz tag is disabled (false); all other tags remain true.
  • Ignores assigned entity if re-assigned
  • Once assigned user needs to to unassign only
  • Can be assigned to multiple entities
  • An entity will have only one assigned value only

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or partnerId of the tenant

  • tagIdstringrequired

    Tag uuid

  • idstringrequired

    Tag value uuid

Request Body

application/json

  • entityTypestring

    Supported Tag entities

    Enum:
    clientserviceMapresource

    Default: resource

  • entityIdstring

    Entity uuid i..e resource uuid or client uuid or servicemap uuid

Loading Examples...

Responses

  • entityTypestring

    Supported Tag entities

    Enum:
    clientserviceMapresource

    Default: resource

  • entityIdstring

    Entity uuid i..e resource uuid or client uuid or servicemap uuid

404Not Found

Loading Examples...