Tag Management API

/api/space/tag-management/tags/{id}

The following operations are supported on this resource:

GET /api/space/tag-management/tags/{id} (v1)


This API is used to get 'tag' information.

Access Control

The following capabilities are required to access this API:
"DefaultRead"


Example Usage

GET /api/space/tag-management/tags/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idIntegerPathThe ID of the tag to get tag information for. Y

Content Types

  • Produces content types:
    application/vnd.net.juniper.space.tag-management.tag+xml;version=1
    application/vnd.net.juniper.space.tag-management.tag+json;version=1


  • Sample Output XML:

    <tag uri="/api/space/tag-management/tags/458766">
       <id>458766</id>
       <name>Junos-tag</name>
       <type>private</type>
       <targets uri="/api/space/tag-management/tags/458766/targets">
          <target type="vnd.net.juniper.space.user-management.user" href="/api/space/user-management/users/1234" uri="/api/space/tag-management/tags/458766/targets/458767"/>
    </targets>
       <method href="/api/space/tag-management/tags/458766/targets" rel="Method used to tag the targets"/>
    </tag>


  • Sample Output JSON:

    {
    "tag":
       {
       "@uri":"/api/space/tag-management/tags/458766",
       "id":458766,
       "name":"Junos-tag",
       "type":"private",
       "targets":
       {
          "@uri":"/api/space/tag-management/tags/458766/targets",
          "target":
          {
          "@type":"vnd.net.juniper.space.user-management.user",
          "@href":"/api/space/user-management/users/1234",
          "@uri":"/api/space/tag-management/tags/458766/targets/458767"
          }
       },
       "method":
       {
          "@href":"/api/space/tag-management/tags/458766/targets",
          "@rel":"Method used to tag the targets"
       }
       }
    }



PUT /api/space/tag-management/tags/{id} (v1)


This API is used to rename or share a tag object. Sharing can be done on a tag that is changed from private to public. However, once shared, a tag cannot be made private again.

Note: A tag name cannot start with a space. It cannot contain special characters, such as a comma, double quote, or parentheses. The name cannot exceed 255 characters.

.

Access Control

The following capabilities are required to access this API:
{"ShareTag", "RenameTag"}


Example Usage

PUT /api/space/tag-management/tags/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idIntegerPathThe ID of the tag to modify. Y

Data Notification

This API supports data notification.

See the following links for information about enabling data notifications changes to be received for this service:

  • Data Notification Usage.


Content Types


DELETE /api/space/tag-management/tags/{id} (v1)


This API is used to delete a tag object.

Access Control

The following capabilities are required to access this API:
"DeleteTag"


Example Usage

DELETE /api/space/tag-management/tags/{id}


Parameters

NameTypeURI TypeDescriptionRequired
idIntegerPathThe ID of the tag object to delete. Y

Data Notification

This API supports data notification.

See the following links for information about enabling data notifications changes to be received for this service:

  • Data Notification Usage.