getWorkItemsRelationships
Retrieve linked resource identifiers for one named Work Item relationship as JSON:API linkage, without attributes. Inspect a single relationship cheaply before fetching full related resources.
Instructions
Returns the resource identifiers linked from one Work Item through a single named relationship, as JSON:API linkage ({type, id} entries) without the related resources' attributes. relationshipId is the relationship's name, not an entry ID. Use this to inspect one relationship cheaply; to read the Work Item with its related resources embedded, call its get tool with include instead. To change the relationship, use postWorkItemRelationships (add), patchWorkItemRelationships (replace), or deleteWorkItemsRelationship (remove). For Work Item-to-Work Item links with roles, getLinkedWorkItems / getBacklinkedWorkItems are richer. Examples: {"projectId":"myproject","workItemId":"WI-123","relationshipId":"linkedWorkItems","page[size]":50}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. | |
| response_format | No | Response detail level. concise removes redundant HTML and JSON:API metadata and may use a small default fieldset on large lists; detailed preserves the complete response. Defaults to detailed. | detailed |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||