Creates a branched LiveDoc and returns an asynchronous jobs resource. requestBody.documentConfigurations identifies the source and optional target project, space, and document name; omit target project/space to branch within the source project and space. Requires read access to the source and write access to the target; poll getJob for completion. Use copyDocument when branch lineage is not needed. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates branches for multiple source LiveDocs and returns an asynchronous jobs resource. Each documentConfigurations entry supplies a source and may specify its own target; omitted targets stay with the source location. Requires source read and target write permissions; poll getJob for completion. Use branchDocument for one document. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Closes one Collection, changing its lifecycle state while retaining its contents. Requires permission to update the Collection. Use reopenCollection to make a closed Collection active again, or reuseCollection when continuing its contents as a new cycle. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Copies one LiveDoc into a target project and space, creating a new document while leaving the source unchanged. Supply the target location and new document name in requestBody; omit target project/space only when the operation should remain in the source location. Use branchDocument when the copy must retain branch lineage. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a new Polarion project and returns the created project resource. Supply a unique project ID and any required template configuration; the signed-in user must have project creation permission. Use getProjectTemplates first when selecting a template, or markProject to register existing repository data as a project. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Work Items from the Global context. Scope: spans every project (no project filter). To act on a single project, use deleteWorkItems instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Work Item Approval. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteApprovals instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Work Item Approvals. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteApproval instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Collection. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteCollections instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Collections. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteCollection instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Removes the named relationship from one Collection; the related resource itself is not deleted. Read current links with getCollectionsRelationship; use postCollectionsRelationships to add links or patchCollectionsRelationships to replace the relationship set. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Document Parts. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Externally Linked Work Item. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteExternallyLinkedWorkItems instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Externally Linked Work Items. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteExternallyLinkedWorkItem instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Custom Field configuration from the Global context. Scope: spans every project (no project filter). To act on a single project, use deleteProjectCustomFields instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Enumeration from the Global context. Scope: spans every project (no project filter). To act on a single project, use deleteProjectEnumeration instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes specified license slots from the Polarion server. This is a server-wide administrative change requiring license administration permission. Read current assignments with getLicenseSlots and capacity with getLicense before removal. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteLinkedWorkItems instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteLinkedWorkItem instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Removes one or more OSLC links from a Work Item, identified in requestBody.data by their link IDs as returned by getOslcResources. Only the link is removed; the artifact in the remote OSLC tool is untouched. To add links use postOslcResources; for Polarion-internal links use deleteLinkedWorkItems. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Permanently deletes one Rich Page and its content; this cannot be undone through this API. Requires page deletion permission. Use dry_run to preview the request or patchRichPage to edit without deleting. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Page Attachment. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Page Relationships. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Plan. Cardinality: targets a single item by ID. For the full collection or a batch, use deletePlans instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Removes the named relationship from one Plan without deleting the related resource. Read current links with getPlanRelationship; use postPlanRelationships to add links or patchPlanRelationships to replace them. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Plans. Cardinality: targets the full collection or a batch. For a single item by ID, use deletePlan instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Permanently deletes a Polarion project and its project data, including contained resources; this cannot be recovered through the API. Requires project deletion permission. Use dry_run to preview the request, and use unmarkProject when the project data should remain in the repository. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Custom Field configuration from the Project context. Scope: one project (requires a project ID). To act across all projects, use deleteGlobalCustomFields instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Enumeration from the Project context. Scope: one project (requires a project ID). To act across all projects, use deleteGlobalEnumeration instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Parameter Definition for the specified Project. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteProjectTestParameterDefinitions instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Parameter Definitions for the specified Project. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteProjectTestParameterDefinition instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes one Test Record execution in a Test Run iteration, not the Test Case definition. Use getTestRecords to identify the record and patchTestRecord when only its values should change. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Record Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteTestRecordAttachments instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Record Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteTestRecordAttachment instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Removes one parameter value from a Test Record execution without deleting the record or Test Case. Use getTestRecordTestParameters to inspect values and patchTestRecordTestParameters to change rather than remove them. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteTestRuns instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Run Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteTestRunAttachments instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Run Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteTestRunAttachment instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Parameter for the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteTestRunTestParameters instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Parameter Definition for the specified Test Run. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Parameters for the specified Test Run. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteTestRunTestParameter instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Runs. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteTestRun instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Step. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteTestSteps instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Test Step Result Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteTestStepResultAttachments instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Step Result Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteTestStepResultAttachment instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Test Steps. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteTestStep instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Work Item Attachment. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Work Items. Scope: one project (requires a project ID). To act across all projects, use deleteAllWorkItems instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Removes one named JSON:API relationship from a Work Item; this edits linkage and does not delete related Work Items. Use getWorkItemsRelationships to inspect raw linkage or linked-work-item tools for link roles and related item details. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes the specified Work Record. Cardinality: targets a single item by ID. For the full collection or a batch, use deleteWorkRecords instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Deletes a list of Work Records. Cardinality: targets the full collection or a batch. For a single item by ID, use deleteWorkRecord instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Starts a Polarion asynchronous job and returns its jobs resource; this response means the job was accepted, not that it finished. Poll getJob with the returned job ID, then use getJobLogContent or getJobResultFileContent after completion. Use run_job_and_wait when bounded polling and a log tail are preferred. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Generates a chat completion using a Large Language Model (LLM). Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Returns a list of Documents from all Projects. Scope: spans every project (no project filter). To act on a single project, use getDocuments instead. Examples: {"query":"title:Plan","page[size]":20}. Selection: Use getAllDocuments to search Documents across projects; use getDocuments when listing within one project and getDocument when you know the Document name and need one result.

Returns a list of Pages from all Projects and Pages on the Repository level. Scope: spans every project (no project filter). To act on a single project, use getPages instead.

Returns a list of Work Items from all Projects. Scope: spans every project (no project filter). To act on a single project, use getWorkItems instead. Examples: {"query":"type:requirement","fields":{"workitems":"id,title"},"page[size]":25}. Selection: Use getAllWorkItems when the search must span every project; use getWorkItems when you know the project and want a project-scoped result.

Returns the enumeration options that may be set on one field of one existing Document (ID, name, color/icon), narrowed by that Document's type. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Call it before patchDocument to pick a valid value; for the value(s) currently set use getCurrentEnumerationOptionsForDocument, and for a Document that does not exist yet use getAvailableEnumOptionsForDocumentType.

Returns the enumeration options that may be set on one field for a Document type (e.g. type=req_specification), before any concrete Document exists. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Pass type=~ for options that apply regardless of type. Call it before postDocuments to choose valid values; for an existing Document use getAvailableEnumOptionsForDocument.

Returns the enumeration options that may be set on one field of one existing Work Item (ID, name, and presentation such as color/icon), already narrowed by that item's type and any dependent enumerations. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Call it before patchWorkItem to pick a valid value; for the value(s) currently set use getCurrentEnumOptionsForWorkItem, and for an item that does not exist yet use getAvailableEnumOptionsForWorkItemType.

Returns the enumeration options that may be set on one field for a Work Item type (e.g. type=requirement), before any concrete item exists. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Pass type=~ for options that apply regardless of type. Call it before postWorkItems to choose valid values; for an existing item use getAvailableEnumOptionsForWorkItem, which also applies that item's dependent enumerations.

Downloads the avatar image of one user. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Since avatars are images, this is rarely useful to an agent; for a user's name, email, and other profile data use getUser, and to replace the image use updateAvatar.

Returns Work Items with an incoming link to the specified Work Item, paginated. Use getLinkedWorkItems for outgoing links, getExternallyLinkedWorkItem for links to another Polarion server, or getWorkItemsRelationships for raw relationship linkage without linked item details.

Returns the specified Collection. Cardinality: targets a single item by ID. For the full collection or a batch, use getCollections instead.

Returns a list of Collections. Cardinality: targets the full collection or a batch. For a single item by ID, use getCollection instead.

Returns the resource identifiers linked from one Collection 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 Collection with its related resources embedded, call its get tool with include instead. To change the relationship, use postCollectionsRelationships (add), patchCollectionsRelationships (replace), or deleteCollectionsRelationship (remove).

Returns the specified Work Item Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getComments instead.

Lists comments associated with one Work Item. Use getDocumentComments for a LiveDoc, getPageComments for a Rich Page, or getTestRunComments for a Test Run. Cardinality: targets the full collection or a batch. For a single item by ID, use getComment instead. Selection: Use getComments for comments on a Work Item; use getDocumentComments for comments on a Document.

Returns the enumeration option(s) currently selected in one field of one Work Item, resolved to full option objects (ID, name, color/icon) rather than the bare ID stored on the item. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Use it to display or compare the current value; for the options you could switch to use getAvailableEnumOptionsForWorkItem.

Returns the enumeration option(s) currently selected in one field of one Document, resolved to full option objects (ID, name, color/icon) rather than the bare stored ID. fieldId must be an enumeration-typed field (e.g. status, severity, or a custom enum field). Use it to display or compare the current value; for the options you could switch to use getAvailableEnumOptionsForDocument.

Returns the Polarion user represented by the bearer token or active session, including that user’s profile fields. The result depends on the credentials used for this request and is not an arbitrary user lookup; use getUser with a user ID to inspect another profile. A 403 means the credentials cannot read this endpoint, not that authentication failed.

Returns the specified Icon from the default context. Cardinality: targets a single item by ID. For the full collection or a batch, use getDefaultIcons instead.

Returns a list of Icons from the default context. Cardinality: targets the full collection or a batch. For a single item by ID, use getDefaultIcon instead.

Returns the specified Document. Cardinality: targets a single item by ID. For the full collection or a batch, use getSpaceDocuments instead. Examples: {"projectId":"myproject","spaceId":"_default","documentName":"requirements","fields":{"documents":"id,title,homePageContent"}}. Selection: Use getDocument to read one Document by name; use getAllDocuments to search a collection across projects.

Returns the specified Document Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getDocumentAttachments instead.

Downloads the raw file content of one Document attachment. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Use this only when you need the file's bytes; for its metadata (fileName, contentType, size, author) call getDocumentAttachment, and to discover attachment IDs call getDocumentAttachments.

Returns a list of Document Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentAttachment instead.

Returns the specified Document Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getDocumentComments instead.

Returns a list of Document Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentComment instead. Selection: Use getDocumentComments for comments on a Document; use getComments for comments on a Work Item.

Returns the specified Document Part. Cardinality: targets a single item by ID. For the full collection or a batch, use getDocumentParts instead.

Returns a list of Document Parts. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentPart instead.

Returns a list of Documents from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllDocuments instead. Examples: {"projectId":"myproject","query":"title:Plan","page[size]":20}. Selection: Use getDocuments when listing Documents in one project; use getAllDocuments to search across projects.

Starts an asynchronous export of one Test Run's test cases to an Excel workbook, optionally filtered with query, ordered with sortBy, and shaped by an export template. Returns a jobs resource, not the file: poll getJob until finished, then download the workbook with getJobResultFileContent. To import results back, use importExcelTestResults.

Returns Work Items linked to the specified item in another Polarion server, using the external-link relationship. Use getLinkedWorkItems or getBacklinkedWorkItems for links within this server and getWorkItemsRelationships for raw relationship identifiers. Cardinality: targets a single item by ID. For the full collection or a batch, use getExternallyLinkedWorkItems instead.

Returns the external links to other Work Items. (The same as the corresponding Java API method.). Cardinality: targets the full collection or a batch. For a single item by ID, use getExternallyLinkedWorkItem instead.

Returns the specified Feature Selection. Cardinality: targets a single item by ID. For the full collection or a batch, use getFeatureSelections instead.

Returns a list of Feature Selections. Cardinality: targets the full collection or a batch. For a single item by ID, use getFeatureSelection instead.

Returns the field definitions that apply to one specific Collection, keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing to the Collection to learn which field keys and value types are valid. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Returns the field definitions that apply to one specific Document, keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing to the Document to learn which field keys and value types are valid. For the allowed values of one enum field, follow up with getAvailableEnumOptionsForDocument. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Returns the field definitions that apply to one specific Plan, keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing to the Plan to learn which field keys and value types are valid. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Returns the field definitions that apply to one specific Test Record (one test case execution within a Test Run iteration), keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing to the Test Record (one test case execution within a Test Run iteration) to learn which field keys and value types are valid. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Returns the field definitions that apply to one specific Test Run, keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing to the Test Run to learn which field keys and value types are valid. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Returns the field definitions that apply to one specific Work Item, keyed by field ID: each field's label and type kind (primitive such as string/date/text/html, list, structure, or enumeration with its enum name), including the custom fields configured for its type. Use it before writing to the Work Item to learn which field keys and value types are valid. For the allowed values of one enum field, follow up with getAvailableEnumOptionsForWorkItem. For the project-wide definitions of a resource type without a concrete instance, use getProjectFieldsMetadata; for global defaults, getGlobalFieldsMetadata.

Returns the defined Custom Fields for the resource type and target type in the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectCustomFields instead.

Returns the specified Enumeration from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectEnumeration instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getGlobalEnumerations instead. Selection: Use getGlobalEnumeration for global enumeration values; use getProjectEnumeration for values configured in one project.

Returns a list of Enumerations from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectEnumerations instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getGlobalEnumeration instead.

Returns fields for the resource type and its target type in the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectFieldsMetadata instead.

Returns the specified Icon from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectIcon instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getGlobalIcons instead.

Returns a list of Icons from the Global context. Scope: spans every project (no project filter). To act on a single project, use getProjectIcons instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getGlobalIcon instead.

Lists Rich Pages across repository spaces, subject to the signed-in user’s global repository read permissions; returns an empty page when no matching pages are visible. Use getSpacePages for a known space, getRepositorySpacePages for one repository space, or getPages for a project space. Follow pagination links or use max_items to cap collection.

Returns the specified Job. Cardinality: targets a single item by ID. For the full collection or a batch, use getJobs instead. Examples: {"jobId":"job-123"}.

Downloads the plain-text execution log for one asynchronous Polarion job. Call after getJob reports a terminal state because a running job may have an incomplete log; jobId comes from the jobs resource returned by the operation that started it. Use getJobResultFileContent for produced files instead of logs.

Downloads one result file produced by a finished asynchronous job (e.g. the spreadsheet from getExportExcelTests). Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Call it only after getJob reports the job as finished; the job resource lists the available file names. For the job's log instead of its output, use getJobLogContent.

Returns the list of Jobs. Cardinality: targets the full collection or a batch. For a single item by ID, use getJob instead.

Returns the server-wide license limits as current count vs. maximum for Work Items, Documents/Pages, and projects, plus links to the default license slots. Use it to check remaining capacity before bulk-creating items or projects; for which user holds which license use getLicenseAssignments, and for the slot details getLicenseSlots.

Returns a list of License Assignments. (Not supported by cloud-based Polarion X.). Cardinality: targets the full collection or a batch. For a single item by ID, use getLicenseAssignmentsForUser instead.

Returns the specified License Assignment. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use getLicenseAssignments instead.

Returns the specified License Slot. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use getLicenseSlots instead.

Returns information on the available License Slots. (Not supported by cloud-based Polarion X.). Cardinality: targets the full collection or a batch. For a single item by ID, use getLicenseSlot instead.

Returns the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. Cardinality: targets a single item by ID. For the full collection or a batch, use getLinkedWorkItems instead.

Returns the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. Cardinality: targets the full collection or a batch. For a single item by ID, use getLinkedWorkItem instead.

Returns the Large Language Models configured on this Polarion server for its built-in AI features (ID and name), paginated. Call it before generateCompletion to pick a valid model; an empty list means no LLM is configured and AI actions will fail.

Returns server-wide Polarion REST metadata available to REST API users. Use this for global field/configuration definitions; use getProjectFieldsMetadata for a project’s effective resource fields and getFieldsMetadataForWorkItem for fields on a specific Work Item.

Returns the OSLC resources linked to one Work Item: links to artifacts in other OSLC-capable tools (e.g. Jira, DOORS Next, Teamcenter), each with its URI, label, and link role. Use it to trace cross-tool links; for links to Work Items in this or another Polarion server use getLinkedWorkItems or getExternallyLinkedWorkItems.

Returns the specified Page. Cardinality: targets a single item by ID. For the full collection or a batch, use getSpacePages instead.

Returns the specified Page Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getPageAttachments instead.

Downloads the raw file content of one Rich Page attachment. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Use this only when you need the file's bytes; for its metadata (fileName, contentType, size, author) call getPageAttachment, and to discover attachment IDs call getPageAttachments.

Returns a list of Page Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getPageAttachment instead.

Returns the specified Page Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getPageComments instead.

Returns a list of Page Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getPageComment instead.

Returns the resource identifiers linked from one Rich Page 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 Rich Page with its related resources embedded, call its get tool with include instead. To change the relationship, use postPageRelationships (add), patchPageRelationships (replace), or deletePageRelationships (remove).

Returns a list of Pages from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllPages instead.

Returns the specified Plan. Cardinality: targets a single item by ID. For the full collection or a batch, use getPlans instead.

Returns the resource identifiers linked from one Plan 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 Plan with its related resources embedded, call its get tool with include instead. To change the relationship, use postPlanRelationships (add), patchPlanRelationships (replace), or deletePlanRelationship (remove).

Returns a list of Plans. Cardinality: targets the full collection or a batch. For a single item by ID, use getPlan instead.

Returns the specified Project. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjects instead.

Returns the defined Custom Fields for the resource type and target type in the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalCustomFields instead.

Returns the specified Enumeration from the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalEnumeration instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjectEnumerations instead. Examples: {"projectId":"myproject","enumContext":"workitems","enumName":"status","targetType":"requirement"}. Selection: Use getProjectEnumeration for values configured in one project; use getGlobalEnumeration for global enumeration values.

Returns a list of Enumerations from the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalEnumerations instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getProjectEnumeration instead. For the same collection across projects, use getGlobalEnumerations instead.

Returns fields for the resource type and its target type in the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalFieldsMetadata instead.

Returns the specified Icon from the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalIcon instead. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjectIcons instead.

Returns a list of Icons from the Project context. Scope: one project (requires a project ID). To act across all projects, use getGlobalIcons instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getProjectIcon instead. For the same collection across projects, use getGlobalIcons instead.

Returns the project templates available on the server (ID, name, description, whether it is the default, and its parameters), paginated. Call it before createProject to choose a valid templateId.

Returns the specified Test Parameter Definition for the specified Project. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjectTestParameterDefinitions instead.

Returns a list of Test Parameter Definitions for the specified Project. Cardinality: targets the full collection or a batch. For a single item by ID, use getProjectTestParameterDefinition instead.

Returns a list of Projects. Cardinality: targets the full collection or a batch. For a single item by ID, use getProject instead. Examples: {"query":"active:true","page[size]":20}.

Returns the Rich Pages in one space at the repository (server) level, outside any project, paginated and filterable with query. Use it for global wiki pages; for pages inside a project space use getSpacePages, and for every repository-level page regardless of space use getGlobalPages.

Returns one repository revision (commit) by its number: author, timestamp, and commit message. Use it to see who changed data at a known revision, e.g. a revision value seen on a resource; to search or page through revision history use getRevisions. Cardinality: targets a single item by ID. For the full collection or a batch, use getRevisions instead.

Returns repository revisions (commits) with author, timestamp, and commit message, paginated and filterable with query. Use it to audit recent changes across the repository; for one known revision number use getRevision. Cardinality: targets the full collection or a batch. For a single item by ID, use getRevision instead.

Returns one global role (e.g. admin, user) and the users that hold it. Use it to check who has server-wide permissions; project-level roles are not covered by this tool. For a user's own profile and roles use getUser.

Returns a list of Documents from a given Project Space. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocument instead.

Lists Rich Pages in the specified project space and returns the paginated JSON:API page collection. Requires a project ID and space ID visible to the signed-in user. Use getGlobalPages for pages across repository spaces or getRepositorySpacePages for a repository-level space outside projects. Cardinality: targets the full collection or a batch. For a single item by ID, use getPage instead.

Returns the specified Test Record. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRecords instead.

Returns the specified Test Record Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRecordAttachments instead.

Downloads the raw file content of one Test Record attachment. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Use this only when you need the file's bytes; for its metadata (fileName, contentType, size, author) call getTestRecordAttachment, and to discover attachment IDs call getTestRecordAttachments.

Returns a list of Test Record Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecordAttachment instead.

Returns the specified Test Parameter for the specified Test Record. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRecordTestParameters instead.

Returns a list of Test Parameters for the specified Test Record. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecordTestParameter instead.

Returns a list of Test Records. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecord instead.

Returns the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRuns instead. Examples: {"projectId":"myproject","testRunId":"Regression-2026-10"}.

Returns metadata for one attachment on a Test Run, including its file name and content type. Use getTestRunAttachmentContent to download the bytes or getTestRunAttachments to list attachments. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunAttachments instead.

Downloads one Test Run attachment and returns its file bytes as image, text, or embedded-resource content. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Use getTestRunAttachment for metadata or getTestRunAttachments to list available attachment IDs; read the attachment only when its contents are needed.

Lists attachment metadata on one Test Run. Use getTestRunAttachment for one known attachment ID and getTestRunAttachmentContent to read its file bytes. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRunAttachment instead.

Returns the specified Test Run Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunComments instead.

Returns a list of Test Run Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRunComment instead.

Returns the specified Test Parameter for the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunTestParameters instead.

Returns the specified Test Parameter Definition for the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunTestParameterDefinitions instead.

Returns a list of Test Parameter Definitions for the specified Test Run. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRunTestParameterDefinition instead.

Returns a list of Test Parameters for the specified Test Run. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRunTestParameter instead.

Returns a list of Test Runs. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRun instead. Examples: {"projectId":"myproject","query":"status:inprogress","page[size]":20}.

Returns the specified Test Step. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestSteps instead.

Returns the specified Test Step Result. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestStepResults instead.

Returns the specified Test Step Result Attachment for the specified Test Record. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestStepResultAttachments instead.

Downloads the raw file content of one Test Step Result attachment. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Use this only when you need the file's bytes; for its metadata (fileName, contentType, size, author) call getTestStepResultAttachment, and to discover attachment IDs call getTestStepResultAttachments.

Returns a list of Attachments for the specified Test Step Result. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestStepResultAttachment instead.

Lists the execution results for steps in one Test Record, including result values and step references. Requires the project, Test Run, iteration, and Test Record identifiers. Use getTestSteps for the Test Case definition or getTestRun for overall execution status. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestStepResult instead.

Returns a list of Test Steps. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestStep instead.

Returns the specified User. Cardinality: targets a single item by ID. For the full collection or a batch, use getUsers instead.

Returns one user group: its ID, name, description, member users, and the global and project roles it grants. Use it to resolve group membership (for example to understand who a group-based assignment or permission covers); for a single user's details use getUser.

Returns a list of Users. Cardinality: targets the full collection or a batch. For a single item by ID, use getUser instead. Examples: {"query":"name:Smith","page[size]":20}.

Returns the specified Work Item. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkItems instead. Examples: {"projectId":"myproject","workItemId":"WI-123","fields":{"workitems":"id,title,description"}}.

Returns one user's approval entry on a Work Item, addressed by that user's ID: the approver and their status (waiting, approved, disapproved). Use it to check a single approver's decision; to record or change it use patchWorkItemApproval. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkItemApprovals instead.

Returns the approval entries on one Work Item: each approver (user) and their approval status (waiting, approved, disapproved). Use it to check sign-off progress; to add approvers use postWorkItemApprovals, and to record a decision use patchWorkItemApproval. Cardinality: targets the full collection or a batch. For a single item by ID, use getWorkItemApproval instead.

Returns the specified Work Item Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkItemAttachments instead.

Downloads the raw file content of one Work Item attachment. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. Use this only when you need the file's bytes; for its metadata (fileName, contentType, size, author) call getWorkItemAttachment, and to discover attachment IDs call getWorkItemAttachments.

Returns a list of Work Item Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getWorkItemAttachment instead.

Returns the specified Test Parameter Definition for the specified Work Item. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkItemTestParameterDefinitions instead.

Returns a list of Test Parameter Definitions for the specified Work Item. Cardinality: targets the full collection or a batch. For a single item by ID, use getWorkItemTestParameterDefinition instead.

Returns a list of Work Items. Scope: one project (requires a project ID). To act across all projects, use getAllWorkItems instead. Cardinality: targets the full collection or a batch. For a single item by ID, use getWorkItem instead. For the same collection across projects, use getAllWorkItems instead. Examples: {"projectId":"myproject","query":"type:requirement AND status:open","fields":{"workitems":"id,title,status"},"page[size]":25}. Selection: Use getWorkItems when you need matching Work Items in one project; use getAllWorkItems when the search must span every project.

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}.

Returns one work record (time-tracking entry) on a Work Item by its ID: date, time spent, type, comment, and the user who logged it. To remove it use deleteWorkRecord. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkRecords instead.

Returns the work records (time-tracking entries) logged on one Work Item: each with its date, time spent, type, comment, and the user who logged it. Use it to report effort spent on an item; to log time use postWorkRecords. Cardinality: targets the full collection or a batch. For a single item by ID, use getWorkRecord instead.

Returns the workflow actions (transitions) possible from one Test Run's current status, each with its action ID, name, target status, whether it is available to the calling user (with an unavailableReason if not), and the fields, roles, or signatures it requires. Call it before patchTestRun with workflowAction to choose a valid transition; for Work Items use getWorkflowActionsForWorkItem.

Returns the workflow actions (transitions) possible from one Work Item's current status, each with its action ID, name, target status, whether it is available to the calling user (with an unavailableReason if not), and the fields, roles, or signatures it requires. Call it before patchWorkItem with workflowAction to choose a valid transition; setting status directly bypasses workflow conditions and functions.

Reads a LiveDoc at the requested revision and returns {outline} with each heading’s part ID, title, level, and nested heading path, without rendering body text. Use this to locate a section; call read_document_section for its content or read_document_markdown for the full document. Requires a project ID, space ID, and document name readable by the signed-in Polarion user.

Imports test results from an Excel file into the specified Test Run and changes its execution data. The file must match the expected Polarion export/import format and the user must have permission to update the run. Use getExportExcelTests to create a compatible workbook; use importWordDocument for Word-based document import. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Imports a Word document as a Polarion LiveDoc, creating or updating document content according to the request options. Requires project and space access plus a valid Word file; use postDocuments to create a LiveDoc from JSON:API data or importExcelTestResults for test-result spreadsheets. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Imports XUnit test results. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Check a Lucene query for unknown work-item fields, unbalanced quotes or parentheses, and suspicious boolean operators. This tool never executes the query.

Registers an existing repository folder as a Polarion project (the inverse of unmarkProject): requestBody names the repository location, the new projectId, its trackerPrefix, and optionally a templateId. Runs as an asynchronous job and returns a jobs resource; poll getJob until it finishes. Use it to re-attach project data that already exists in the repository; to create a brand-new project use createProject. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Merges Master Work Item changes to the specified Branched Document. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Merges the selected branched LiveDoc content into its master document and returns the merge job/result. Requires a valid branch/master relationship and write access to the master. Use branchDocument to create a branch, or moveDocumentParts for edits within one document. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Reorders or relocates parts within a LiveDoc using the requested part IDs and target position. Read current part IDs with getDocumentParts first; use overwriteDocumentParts only when replacing the document structure rather than moving existing parts. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Removes one Work Item from the Document that currently contains it and returns it to the project's plain Work Item tracker. The Work Item itself is kept with all its fields and links; only its placement in the Document is removed. Use moveToDocument for the reverse. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Moves project to a different location. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Moves one existing Work Item from the project tracker into a LiveDoc and returns the move result. Requires the Work Item and target document to be writable. Use moveFromDocument to return an item to the tracker or moveWorkItemsToDocument to move a batch. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Moves a batch of existing Work Items from the project tracker into a LiveDoc. Provide the target document and the Work Item IDs in the request body; all items must be accessible and the document writable. Use moveToDocument for a single item or moveFromDocument to remove one from a document. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces the parts of a LiveDoc with the supplied part list. This can remove or replace existing content, so read the current structure with getDocumentParts and use dry_run before writing. Use moveDocumentParts to reposition existing parts while retaining their identities. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Work Items in the Global context. Scope: spans every project (no project filter). To act on a single project, use patchWorkItems instead. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"requestBody":{"data":[{"type":"workitems","id":"myproject/WI-123","attributes":{"status":"inprogress"}}]}}. Selection: Use patchAllWorkItems for a batch spanning projects; use patchWorkItems for a batch in one project and patchWorkItem for one known item.

Updates one Collection’s attributes from the supplied JSON:API request body. Use patchCollectionsRelationships for linkage changes or postCollections to create another Collection. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces relationship linkage on one Collection with the supplied relationship data. Read existing links with getCollectionsRelationship; use postCollectionsRelationships to add links without replacing the full set. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one comment on a Work Item and returns the updated comment resource. Requires permission to edit that comment. Use patchDocumentComment or patchPageComment for comments on those resource families. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces the entire list of Custom Fields of one project for one resource type and target type: fields missing from requestBody are deleted, not merged. Read the current list with getProjectCustomFields first and send every field you want to keep. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates attributes of one LiveDoc using its JSON:API request body; only supplied attributes change. Rich text uses {type: "text/html", value: "<p>…</p>"}. Use patchDocumentParts for structured body parts or patchRichPage for a wiki page. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"projectId":"myproject","spaceId":"_default","documentName":"requirements","requestBody":{"data":{"type":"documents","id":"requirements","attributes":{"title":"Updated requirements"}}}}.

Updates one existing Document attachment: its metadata (e.g. title) via requestBody.resource, and optionally replaces the stored file by passing base64-encoded bytes in requestBody.content. The attachment keeps its ID. Use this to rename or re-upload a file that already exists; to add a new file use postDocumentItemAttachments, and to read the current file use getDocumentAttachmentContent. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the text or supported attributes of one comment on a LiveDoc. Requires permission to edit that comment. Use patchComment for a Work Item comment and patchPageComment for a Rich Page comment. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces the entire list of global Custom Fields for one resource type and target type: fields missing from requestBody are deleted, not merged. Read the current list with getGlobalCustomFields first and send every field you want to keep. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces the entire option list of one global Enumeration: options missing from requestBody are deleted, not merged. Read the current list with getGlobalEnumeration first and send every option you want to keep. Scope: spans every project (no project filter). To act on a single project, use patchProjectEnumeration instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the server license configuration from the supplied request body. This is a global administrative change requiring license administration permission. Inspect capacity with getLicense and assignments with getLicenseSlots first. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a user's License Assignment. (Not supported by cloud-based Polarion X.). Cardinality: targets a single item by ID. For the full collection or a batch, use patchLicenseAssignments instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.). Cardinality: targets the full collection or a batch. For a single item by ID, use patchLicenseAssignment instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one existing Rich Page attachment: its metadata (e.g. title) via requestBody.resource, and optionally replaces the stored file by passing base64-encoded bytes in requestBody.content. The attachment keeps its ID. Use this to rename or re-upload a file that already exists; to add a new file use postPageAttachments, and to read the current file use getPageAttachmentContent. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the text or supported attributes of one comment on a Rich Page. Requires permission to edit that comment. Use patchComment for a Work Item comment or patchDocumentComment for a LiveDoc comment. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces relationship linkage on one Rich Page. Read links with getPageRelationships; use postPageRelationships to add links without replacing the existing set. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one Plan’s attributes from the supplied JSON:API request body. Use patchPlanRelationships for linkage changes or postPlans to create a Plan. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Plan Relationships. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one Polarion project’s attributes from the supplied JSON:API request body. Requires project administration permission. Use getProject to inspect current values and deleteProject only to remove the project. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces the entire option list of one Enumeration in a project: options missing from requestBody are deleted, not merged. Read the current list with getProjectEnumeration first and send every option you want to keep. Scope: one project (requires a project ID). To act across all projects, use patchGlobalEnumeration instead. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one Rich Page (wiki-style page): its title and/or its HTML homePageContent, sent as requestBody.data.attributes. Only the attributes you send are changed. Use it to edit page text or metadata; to create a page use postPages, and for LiveDoc Documents use patchDocument instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the specified Test Record. Cardinality: targets a single item by ID. For the full collection or a batch, use patchTestRecords instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one existing Test Record attachment: its metadata (e.g. title) via requestBody.resource, and optionally replaces the stored file by passing base64-encoded bytes in requestBody.content. The attachment keeps its ID. Use this to rename or re-upload a file that already exists; to add a new file use postTestRecordAttachments, and to read the current file use getTestRecordAttachmentContent. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Test Records. Cardinality: targets the full collection or a batch. For a single item by ID, use patchTestRecord instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use patchTestRuns instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one existing Test Run attachment: its metadata (e.g. title) via requestBody.resource, and optionally replaces the stored file by passing base64-encoded bytes in requestBody.content. The attachment keeps its ID. Use this to rename or re-upload a file that already exists; to add a new file use postTestRunAttachments, and to read the current file use getTestRunAttachmentContent. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the specified Test Run Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use patchTestRunComments instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Test Run Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use patchTestRunComment instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Test Runs. Cardinality: targets the full collection or a batch. For a single item by ID, use patchTestRun instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the specified Test Step. Cardinality: targets a single item by ID. For the full collection or a batch, use patchTestSteps instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the specified Test Step Result. Cardinality: targets a single item by ID. For the full collection or a batch, use patchTestStepResults instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one existing Test Step Result attachment: its metadata (e.g. title) via requestBody.resource, and optionally replaces the stored file by passing base64-encoded bytes in requestBody.content. The attachment keeps its ID. Use this to rename or re-upload a file that already exists; to add a new file use postTestStepResultAttachments, and to read the current file use getTestStepResultAttachmentContent. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Test Step Results. Cardinality: targets the full collection or a batch. For a single item by ID, use patchTestStepResult instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Test Steps. Cardinality: targets the full collection or a batch. For a single item by ID, use patchTestStep instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates profile attributes for one user from the supplied JSON:API request body. Requires permission to edit that user; use getUser to inspect the profile and updateAvatar for the image. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates the specified Work Item. Cardinality: targets a single item by ID. For the full collection or a batch, use patchWorkItems instead. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"projectId":"myproject","workItemId":"WI-123","requestBody":{"data":{"type":"workitems","id":"WI-123","attributes":{"title":"Updated title"}}}}. Selection: Use patchWorkItem to update one Work Item by its project and ID; use patchWorkItems for a project-scoped batch and patchAllWorkItems for a cross-project batch.

Updates one approver’s decision on a Work Item approval entry. Use the approver’s user ID as the approval identifier; the user must be allowed to record the decision. Read the entry with getWorkItemApproval and use patchWorkItemApprovals only when changing multiple approvals. Cardinality: targets a single item by ID. For the full collection or a batch, use patchWorkItemApprovals instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates multiple approval entries on one Work Item using the supplied approval list. Requires permission for each requested decision. Use getWorkItemApprovals to inspect current entries and patchWorkItemApproval for one approver. Cardinality: targets the full collection or a batch. For a single item by ID, use patchWorkItemApproval instead. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates one existing Work Item attachment: its metadata (e.g. title) via requestBody.resource, and optionally replaces the stored file by passing base64-encoded bytes in requestBody.content. The attachment keeps its ID. Use this to rename or re-upload a file that already exists; to add a new file use postWorkItemAttachments, and to read the current file use getWorkItemAttachmentContent. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Work Item Relationships. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Updates a list of Work Items. Scope: one project (requires a project ID). To act across all projects, use patchAllWorkItems instead. Cardinality: targets the full collection or a batch. For a single item by ID, use patchWorkItem instead. For the same collection across projects, use patchAllWorkItems instead. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"projectId":"myproject","requestBody":{"data":[{"type":"workitems","id":"WI-123","attributes":{"status":"inprogress"}}]}}. Selection: Use patchWorkItems to update a batch within one project; use patchWorkItem for one known ID and patchAllWorkItems when the batch spans projects.

Creates incoming Work Item links to the specified target from the Work Items in the request body. Supply valid project-scoped IDs and link roles. Use postLinkedWorkItems for outgoing links or getBacklinkedWorkItems to inspect incoming links. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Collections from the supplied JSON:API resource data and returns the created resources. Requires project permission to create Collections. Use getCollections to list existing ones or patchCollections to update one. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds relationship links to one Collection without replacing its other links. Provide JSON:API linkage; use getCollectionsRelationship to inspect the set or patchCollectionsRelationships to replace it. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates comments on the specified Work Item or resource using the request body and returns the created comment resources. The target must be writable by the signed-in user. Use getComments to list comments and postDocumentComments or postPageComments for comments on those specific resource families. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates comments on one LiveDoc and returns the created comment resources. Requires write access to the document. Use getDocumentComments to read document comments; use postComments for Work Item comments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Uploads one or more new files as attachments of a Document in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchDocumentAttachment, and to list what is already attached use getDocumentAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds structured parts to a LiveDoc and returns the created parts. Use valid LiveDoc part types and read existing content with getDocumentParts first; use overwriteDocumentParts only when replacing the full structure. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Documents. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"projectId":"myproject","spaceId":"_default","requestBody":{"data":[{"type":"documents","attributes":{"title":"Requirements"}}]}}.

Creates links from a Work Item to items in another Polarion server using external references. Use postLinkedWorkItems for links within this server and getExternallyLinkedWorkItem to inspect external links. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Custom Fields in the Global context. Scope: spans every project (no project filter). To act on a single project, use postProjectCustomFields instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Enumerations in the Global context. Scope: spans every project (no project filter). To act on a single project, use postProjectEnumeration instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Icons are identified by order. Scope: spans every project (no project filter). To act on a single project, use postProjectIcons instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.). Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds one or more OSLC links from a Work Item to artifacts in other OSLC-capable tools: each requestBody.data entry gives the remote artifact's uri, an OSLC link role URI (e.g. http://open-services.net/ns/cm#relatedChangeRequest), and an optional label. Use it for cross-tool traceability; to link Polarion Work Items to each other use postLinkedWorkItems, and to list existing OSLC links use getOslcResources. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Uploads one or more new files as attachments of a Rich Page in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchPageAttachment, and to list what is already attached use getPageAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates comments on one Rich Page and returns the created comment resources. Requires write access to the page. Use postComments for Work Item comments or postDocumentComments for LiveDocs. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds relationship links to one Rich Page while preserving existing linkage. Provide JSON:API relationship data; inspect links with getPageRelationships or use patchPageRelationships to replace the set. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Rich Pages in the specified project space from JSON:API resource data and returns the new page resources. Requires write access to the project and space. Use getSpacePages for project pages or getGlobalPages for repository-wide pages. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds relationship links to one Plan while retaining existing links. Provide JSON:API linkage; use getPlanRelationship to inspect the set or patchPlanRelationships to replace it. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Plans. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Custom Fields in the Project context. Scope: one project (requires a project ID). To act across all projects, use postGlobalCustomFields instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Enumerations in the Project context. Scope: one project (requires a project ID). To act across all projects, use postGlobalEnumeration instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Icons are identified by order. Scope: one project (requires a project ID). To act across all projects, use postGlobalIcons instead. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Test Parameter Definitions for a project. Supply each definition’s name and supported attributes; use getProjectTestParameterDefinitions to inspect existing definitions and patchProjectTestParameterDefinitions to update them. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Uploads one or more new files as attachments of a Test Record in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchTestRecordAttachment, and to list what is already attached use getTestRecordAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Test Parameters for the specified Test Record. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Test Record executions in a Test Run iteration from the supplied case references and result data. Use getTestRecords to inspect executions or postTestStepResults to add step-level outcomes. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Uploads one or more new files as attachments of a Test Run in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchTestRunAttachment, and to list what is already attached use getTestRunAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates comments on one Test Run and returns the created comment resources. Requires write access to the run. Use getTestRunComments to list them or postComments for Work Item comments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates parameter definitions for one Test Run. Use getTestRunParameterDefinitions to inspect the current set and patchTestRunParameterDefinitions to update it. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Test Parameter values for a Test Run and iteration. Values must match the run’s parameter definitions; use getTestRunTestParameters to inspect values and patchTestRunTestParameters to update them. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Test Runs. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"projectId":"myproject","requestBody":{"data":[{"type":"testruns","attributes":{"id":"Regression-2026-10","title":"Regression"}}]}}.

Uploads one or more new files as attachments of a Test Step Result in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchTestStepResultAttachment, and to list what is already attached use getTestStepResultAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates execution results for Test Steps in a Test Record. Use getTestSteps for the Test Case definition and getTestStepResults to read recorded outcomes. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Test Steps on a Test Case and returns them. Use getTestSteps to read the current sequence and patchTestSteps to update existing steps. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates Polarion user accounts from the supplied user resource data. Requires user administration permission and valid unique user IDs. Use getUser to inspect an account or patchUser to update one. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds approval entries for users on one Work Item. Provide approver user IDs in the request body; the signed-in user must have permission to configure approvals. Use getWorkItemApprovals to inspect existing entries and patchWorkItemApproval to record a decision. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Uploads one or more new files as attachments of a Work Item in a single multipart request: requestBody.resource.data holds one metadata entry (fileName, optional title) per file, and requestBody.files holds the base64-encoded file bytes at the same array index as each metadata entry. Returns the created attachment IDs. Use this to add files; to change an existing attachment use patchWorkItemAttachment, and to list what is already attached use getWorkItemAttachments. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Adds relationship linkage to one Work Item while preserving existing relationships. Provide JSON:API linkage; inspect it with getWorkItemsRelationships or use patchWorkItemRelationships to replace it. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Creates a list of Work Items. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema. Examples: {"projectId":"myproject","requestBody":{"data":[{"type":"workitems","attributes":{"type":"requirement","title":"New requirement"}}]}}.

Creates time-tracking work records for one Work Item and returns the created entries. Each request-body record must include valid work-record attributes such as date and time spent; the user must have permission to log effort. Use getWorkRecords to inspect entries and deleteWorkRecord to remove an incorrect record. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Reads a LiveDoc from its current or requested repository revision and returns {markdown, outline}; embedded Work Items are rendered with their title and description. Use this for the full document body; use get_document_outline for headings only or read_document_section for one section. Requires a project ID, space ID, and document name the signed-in Polarion user can read.

Reads one LiveDoc section at the requested revision and returns {partId, headingPath, markdown, truncated}. Requires a project ID, space ID, and document name readable by the signed-in Polarion user; select the section with its part ID or exact heading path. Use read_document_markdown for the full body or get_document_outline to discover headings and IDs first.

Reopens one previously closed Collection so it can be used again. Requires permission to update the Collection. Use closeCollection to close an active one or reuseCollection to start a new cycle while preserving the earlier state. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Parses a Polarion UI URL on the configured API host into entity identifiers for a Work Item, LiveDoc, Rich Page, Test Run, or Plan. Returns the identifiers alone by default; set fetch to also call the matching get tool and include its entity response. Requires a URL from the same Polarion host. Use this when the input is a UI link; call the resource get tool directly when IDs are already known.

Starts a new use cycle for one Collection while retaining the existing collection history. Requires a valid Collection and update permission. Use reopenCollection to reactivate the same closed cycle or copyCollection when a separate Collection is needed. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Submits one Polarion asynchronous job, polls until a terminal state or timeout, then returns {jobId, status, state, message, logTail}. Provide the executeJob request body with a job factory ID and any factory-specific parameters; job semantics vary by factory. Requires permission to execute that job. Polling cancellation or timeout stops waiting but does not cancel the Polarion job; use executeJob and getJob separately when you do not need a bounded wait and log tail.

Search Work Items using structured filters, escaping values into a Lucene query. Returns {query, results, links?, totalCount?, truncated?} with concise item summaries. Provide projectId to search one project; omit it for the global getAllWorkItems search, which requires global read access. Use this for common filters; use getWorkItems or getAllWorkItems directly for advanced Lucene syntax, custom response fields, or includes.

Sets the User's license. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Builds a bounded, cycle-safe trace tree from one Work Item and returns {nodes, edges, truncated}. Requires a project ID and Work Item ID readable by the signed-in Polarion user. Use this to traverse multiple link levels; use getLinkedWorkItems or getBacklinkedWorkItems for a single hop. direction selects outgoing, incoming, or both; the result is marked truncated when the depth or node cap limits traversal.

Removes the Polarion project marker from a project so it no longer appears or works as a project, while its data stays in the repository and can be re-registered later with markProject. Runs as an asynchronous job and returns a jobs resource; poll getJob until it finishes. Use it to retire a project reversibly; to delete the project and its data use deleteProject. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Replaces one user avatar image using the supplied image content. Images (PNG, JPEG, GIF, WebP) come back as image content, UTF-8 text files as text, and any other file (PDF, Office, ZIP) as an embedded base64 resource; files over 20 MB are refused. The request changes the stored avatar for the specified user and requires permission to update that profile. Use getAvatar to retrieve the current image; use patchUser for profile fields such as name or email. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as not guaranteed idempotent. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Uploads one file as a Polarion attachment to a Work Item, Test Run, LiveDoc, or Rich Page and returns the attachment result. Choose exactly one source: an absolute local path on stdio with MCP_UPLOAD_ROOTS, or an HTTPS URL on an allowlisted host with MCP_UPLOAD_URL_HOSTS. The authenticated Polarion user must have attachment write permission. Use dry_run to validate and preview name, size, and SHA-256; use the resource-specific attachment tools when editing existing attachment metadata or content.