Rally - Tags: Can we archive or restore a tag using WSAPI?


Article ID: 131180


Updated On:


CA Agile Central On Premise (Rally) CA Agile Central SaaS (Rally)


What does archiving a tag mean? Can we archive or restore a tag using WSAPI?


Component: ACSAAS


Tags can be archived. Archiving tags will make them unavailable for future selection for your artifacts. An archived tag will still be tagged to its artifacts, that association remains unaffected. Archived tags can be 'restored' and become available again.
Archived tags can also be permanently deleted. In order to permanently delete an archived tag you shall consent to remove it from all its associated artifacts, then it shall be entirely deleted.

The functionality of archiving or restoring tags is allowed for Administrators only, such as subscription admin, workspace admin and project admin.

This functionality can also be used with WSAPI. To archive/store tags using WSAPI you shall make POST calls to the "Tag" endpoint and updating the 'Archived' field. See example below:

This is the Archived field definition on the Tag endpoint:

<Please see attached file for image>

User-added image

Here is a POST example of archiving a tag using WSAPI by setting the Archived field to 'True'.

<Please see attached file for image>

User-added image


1558687209198000131180_sktwi1f5rjvs16f7t.png get_app
1558687206462000131180_sktwi1f5rjvs16f7s.png get_app