Can the Rally Webservice API be used to pull back watchers for work items
search cancel

Can the Rally Webservice API be used to pull back watchers for work items

book

Article ID: 262530

calendar_today

Updated On:

Products

Rally SaaS

Issue/Introduction

Can the Rally Webservice API be used to pull back watchers for work items.    I didn't see anything in the API documentation for Watcher

Environment

Release : SAAS

Resolution

We use the Pigeon API to pull Watch information.  Our Web Services API doesn't have any information about Watchers.  

  • To pull all watches for a Workspace use the following query:
    • https://rally1.rallydev.com/apps/pigeon/api/v2/watch
  • To pull watch information in a workspace for a specific Artifact use:
    • https://rally1.rallydev.com/apps/pigeon/api/v2/watch?ArtifactUUID=<ARTIFACT_UUID>
  • And all watches in a workspace for a specific user use:
    • https://rally1.rallydev.com/apps/pigeon/api/v2/watch?UserUUID=<USER_UUID>
  • ***It will be necessary to add a header of:
    • Cookie:ZSESSIONID=<APIKey>

Here are a couple of articles that may be helpful if you want to use the API to Add or Delete Watchers:

How to add a Watch via pigeon API 

How to remove a Watch

Watches are not published or documented API endpoints, therefore their use and availability are not guaranteed, additionally, there is no guarantee of support using this method to create watches.