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 a list of Documents from all Projects. Scope: spans every project (no project filter). To act on a single project, use getDocuments instead.

Creates Branches of Documents. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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. Effect: not guaranteed idempotent — this call can trigger a workflow action, and re-running a workflow action from a different resulting status has real additional side effects (status change, signatures, notifications). Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified Custom Fields in the Global context. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified Enumeration in the Global context. Scope: spans every project (no project filter). To act on a single project, use patchProjectEnumeration 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 the list of Jobs. Cardinality: targets the full collection or a batch. For a single item by ID, use getJob instead.

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

Downloads one result file produced by a finished asynchronous job (e.g. the spreadsheet from getExportExcelTests). The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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.

Downloads the Log content for a specified job.

Executes a Job. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Updates the product License. (Not supported by cloud-based Polarion X.). 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of group License Slots. (Not supported by cloud-based Polarion X.). Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.). Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)

Returns a list of all Pages on the Repository level.

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

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

Deletes the specified Project. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Moves project to a different location. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Collections. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Closes the specified Collection. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Reopens the specified Collection. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Reuses the specified Collection. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates the specific Relationships for the Collections. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Removes the specific Relationship from the Collection. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates a list of Collection Relationships. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified Custom Fields in the Project context. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified Enumeration in the Project context. Scope: one project (requires a project ID). To act across all projects, use patchGlobalEnumeration 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 Pages from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllPages instead.

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

Creates a list of Plans. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates the specific Relationships for the Plan. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Removes the specific Relationship from the Plan. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates a list of Plan Relationships. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Documents. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Updates the specified Document. Effect: not guaranteed idempotent — this call can trigger a workflow action, and re-running a workflow action from a different resulting status has real additional side effects (status change, signatures, notifications). Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Creates a Branch of the 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Creates a copy of the 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Merges Master Work Item changes to the specified Branched 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Merges Work Item changes from specified Branched Document to Master. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 in the same order (or match them via each entry's lid). 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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the raw file content of one Document attachment. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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 Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentComment instead.

Creates a list of Document Comments. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Updates the specified Document 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 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 a list of Document Parts. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentPart instead.

Creates a list of Document Parts. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Moves a Work Item Document Part. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Overwrites multiple Work Item Document 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Imports a Word document to create a new Polarion 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Pages. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Deletes the specified Page. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 in the same order (or match them via each entry's lid). 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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the raw file content of one Rich Page attachment. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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 Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getPageComment instead.

Creates a list of Page Comments. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Updates the specified 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Rich Page Relationships. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates a list of Page Relationships. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Test Parameter Definitions for the specified Project. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Test Runs. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Imports Excel 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 in the same order (or match them via each entry's lid). 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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the file content for a specified Test Run Attachment.

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

Creates a list of Test Run Comments. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Test Parameter Definitions for the specified Test Run. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Test Parameters for the specified Test Run. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Test Records. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Deletes the specified Test Record. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 a list of Test Record Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecordAttachment instead.

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 in the same order (or match them via each entry's lid). 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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the raw file content of one Test Record attachment. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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 Parameters for the specified Test Record. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecordTestParameter instead.

Creates a list of Test Parameters for the specified Test Record. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Deletes the specified Test Parameter for the specified Test Record. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Test Step Results. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 in the same order (or match them via each entry's lid). 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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the raw file content of one Test Step Result attachment. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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 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.

Creates a list of Work Items. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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. Effect: not guaranteed idempotent — this call can trigger a workflow action, and re-running a workflow action from a different resulting status has real additional side effects (status change, signatures, notifications). Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Updates the specified Work Item. Cardinality: targets a single item by ID. For the full collection or a batch, use patchWorkItems instead. Effect: not guaranteed idempotent — this call can trigger a workflow action, and re-running a workflow action from a different resulting status has real additional side effects (status change, signatures, notifications). Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Moves the specified Work Item to the 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of WorkItem Approvals. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates a list of instances. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified instance. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 in the same order (or match them via each entry's lid). 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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the raw file content of one Work Item attachment. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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 the incoming links from other Work Items (also known as backlinks). Does not pertain to External links.

Creates incoming links from other Work Items (backlinks). Does not pertain to External links. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Creates a list of Work Item Comments. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Updates the specified Work Item 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Externally Linked Work Items. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 specified Feature Selection. Cardinality: targets a single item by ID. For the full collection or a batch, use getFeatureSelections instead.

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

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Work Item Relationships. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Deletes 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates a list of Work Item Relationships. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 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 Steps. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestStep instead.

Creates a list of Test Steps. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a list of Work Records. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Moves multiple Work Items to the 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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.

Creates a new 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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 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 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 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 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 the current User.

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.

Creates a list of Users. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

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

Updates the specified User. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Downloads the avatar image of one user. The file body is returned as UTF-8 text: plain-text files (TXT, CSV, XML, JSON, HTML) are readable, but binary files (images, PDF, Office) arrive garbled. 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.

Sets the User's license. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Updates the specified User Avatar. 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 preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.