Sign in
TrackerItem

Resolve a pasted tracker item id or link against the workspace's tracker integrations

Resolves 123, AB#123 or a work item URL. Never picks an integration for the caller: a supplied workspace_integration_id is the only one asked; a URL resolves only in the organization and project it names; an id found in more than one integration is ambiguous, with every match as a candidate; and when any integration could not be asked the result is ambiguous_or_unavailable rather than found. TestRail and Jira links are other_platform, without contacting any tracker.

post/issueTrackers/workspaces/{workspace_id}/items:lookup

Path parameters

workspace_idstring required

Request body

inputstring required

123, AB#123 or a work item URL

workspace_integration_idstring

Resolve only against this integration. Validated against the workspace.

Response

The resolution and its candidates

status'found' | 'ambiguous' | 'ambiguous_or_unavailable' | 'not_found' | 'not_connected' | 'other_platform' | 'unrecognised' required

found: exactly one integration holds the item (the one candidate). ambiguous: several do; every match is a candidate and the caller must choose. ambiguous_or_unavailable: at least one integration could not be asked, so a match is never reported as unique. not_found: every integration asked answered, and none holds it in its project. not_connected: no enabled integration covers the organization and project the input names. other_platform: a TestRail or Jira link, not a tracker item. unrecognised: not an item id or link.

Example response

{
  "candidates": [
    {
      "issue_key": "123",
      "display_key": "AB#123",
      "item_type": "User Story",
      "state": "Active"
    }
  ]
}

Changes

Changed in 1 of the 32 revisions of this API.1