Polarion MCP Server
The Polarion MCP Server exposes the Polarion ALM REST API as a tool-based interface (~210 operations) for AI assistants (Claude, GitHub Copilot, ChatGPT, etc.), supporting stdio, Streamable HTTP, and REST HTTP transports.
Work Items
Create, read, update, delete, and search work items (with query/sort/filter/pagination)
Manage linked work items, externally linked work items, OSLC resource links, feature selections, approvals, comments, attachments, and work records
Documents
Create, read, update, copy, branch, and merge documents
Manage document parts, attachments, and comments
Projects
Create, read, update, delete, move, and mark/unmark projects
Manage project enumerations, icons, test parameter definitions, and templates
Plans
Create, read, update, delete plans and manage plan relationships
Test Management
Manage test records, test record attachments, test runs, test run comments/attachments, test steps, and test step results
Pages & Attachments
Get, update, and manage wiki/rich pages and their attachments
Global Resources
Manage global enumerations, icons, roles, revisions, and pages
Jobs
Get job status and download job result files
Administration
Manage project templates, user groups, users, and roles
Additional features include cached project configuration, SDK documentation access, and guided prompts for work item operations.
Integrates with VS Code GitHub Copilot agent mode to provide Polarion REST API tools for managing work items and projects directly from the editor.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Polarion MCP Serverlist work items assigned to me in project ABC"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Polarion MCP
Connect Claude, VS Code Copilot, and ChatGPT directly to Polarion ALM.
An open-source Model Context Protocol server that exposes 284 Polarion REST operations as AI-native tools.
Product page · Docs · Docker image
Table of Contents
Related MCP server: Polarion MCP
Features
Strict Type Validation — Zod schemas validate all inputs with Polarion query grammar support
Hardened Error Handling — Standardized MCP errors with automatic token sanitization
Pagination Helpers — Built-in utilities for easy result navigation
Security Checks — Validates required environment variables and never logs sensitive data
Multiple Transports — HTTP (Streamable MCP) and stdio support
CI/CD Ready — TypeScript checks and automated Docker publishing included
Requirements
Node.js v20+
Polarion Personal Access Token (PAT) with read permissions
Getting Started
Choose an auth method
Every method ends at a Polarion Personal Access Token (PAT). They differ in where that token lives and which clients can use them.
Method | Token lives | Use it for |
in the client's MCP config on your machine | Claude Code, Claude Desktop (local server), VS Code Copilot. One user, no server to run. | |
sent by the client on every request | Claude Code, VS Code Copilot, curl, scripts. Clients that can set a static | |
pasted once on a login page, then held by the client, encrypted | Claude.ai, Claude Desktop and mobile, ChatGPT connectors (they cannot send custom headers). Also works for Claude Code and VS Code. | |
one shared PAT in the server's environment | ChatGPT Custom GPT Actions. Every caller acts as the same Polarion user. | |
pasted once on a login page, then held by ChatGPT, encrypted | ChatGPT Custom GPT Actions, each user under their own Polarion account. |
B, C and E run the same server: MCP_PUBLIC_URL adds the login on top of B,
and GPT_CLIENT_ID/GPT_CLIENT_SECRET add the Custom GPT login on top of C,
so one deployment can serve all three.
Why two URLs?
API_BASE_URLis where Polarion's REST API lives, e.g.https://polarion.example.com/polarion/rest/v1(always ending in/polarion/rest/v1). The server calls it. Required by every method.MCP_PUBLIC_URLis this server's own public address as clients see it, e.g.https://mcp.example.com(origin only, no path). Only method C needs it. Behind a TLS proxy the process only seeshttp://127.0.0.1:3000, yet the OAuth metadata it publishes must contain absolute HTTPS URLs the client can reach (issuer,/authorize,/token,/register). The server does not guess this from the request'sHostheader, because a spoofed header would then change the issuer.
The client never needs API_BASE_URL. For B and C it only gets the connector
URL: the server's public origin plus /mcp.
Prerequisites
Polarion with the REST API enabled (
com.siemens.polarion.rest.enabled=trueinpolarion.properties).A Polarion PAT per user: Polarion, My Account > Personal Access Tokens. The token carries the user's own permissions.
Node.js 20+ or Docker. From source:
git clone https://github.com/phillipboesger/polarion-mcp.git cd polarion-mcp npm ci # also runs the build
A. Local stdio + PAT
The client starts the server as a subprocess; nothing listens on the network.
Build from source (see Prerequisites) or pull the image:
docker pull ghcr.io/phillipboesger/polarion-mcp:latest.Register it with your client:
Claude Code
claude mcp add polarion \ -e API_BASE_URL=https://polarion.example.com/polarion/rest/v1 \ -e BEARER_TOKEN=<your-polarion-pat> \ -- node /absolute/path/to/polarion-mcp/build/index.jsClaude Desktop (
claude_desktop_config.json, then restart the app){ "mcpServers": { "polarion": { "command": "node", "args": ["/absolute/path/to/polarion-mcp/build/index.js"], "env": { "API_BASE_URL": "https://polarion.example.com/polarion/rest/v1", "BEARER_TOKEN": "<your-polarion-pat>" } } } }VS Code Copilot (
.vscode/mcp.json; VS Code prompts for the token and stores it securely){ "inputs": [ { "type": "promptString", "id": "polarion-pat", "description": "Polarion PAT", "password": true } ], "servers": { "polarion": { "type": "stdio", "command": "node", "args": ["/absolute/path/to/polarion-mcp/build/index.js"], "env": { "API_BASE_URL": "https://polarion.example.com/polarion/rest/v1", "BEARER_TOKEN": "${input:polarion-pat}" } } } }With Docker instead of Node, replace the command in any of the above with:
docker run --rm -i \ -e API_BASE_URL=https://polarion.example.com/polarion/rest/v1 \ -e BEARER_TOKEN=<your-polarion-pat> \ ghcr.io/phillipboesger/polarion-mcp:latest \ node build/index.jsVerify: in Claude Code run
/mcp(server shows connected), then ask "list my Polarion projects".
B. HTTP server + PAT header
One shared server that holds no credentials; each client sends its own PAT.
Server
Start it. The image runs the Streamable HTTP MCP server by default:
docker run -d --name polarion-mcp \ -e API_BASE_URL=https://polarion.example.com/polarion/rest/v1 \ -e MCP_ALLOWED_HOSTS=mcp.example.com \ -p 127.0.0.1:3000:3000 \ ghcr.io/phillipboesger/polarion-mcp:latestFrom source:
MCP_HTTP_HOST=127.0.0.1 API_BASE_URL=... npm run start:mcp-http.Put TLS in front of it (reverse proxy forwarding
/mcpto127.0.0.1:3000). The PAT travels in a header, so never expose the plaintext port. For a Polarion server's own Apache, see docs/deployment.md.Verify:
curl -s https://mcp.example.com/health curl -si -X POST https://mcp.example.com/mcp \ -H 'authorization: Bearer <your-polarion-pat>' \ -H 'content-type: application/json' \ -H 'accept: application/json, text/event-stream' \ -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"curl","version":"1"}}}' \ | head -1 # HTTP/1.1 200
Clients
Claude Code
claude mcp add --transport http polarion https://mcp.example.com/mcp \ --header "Authorization: Bearer <your-polarion-pat>"VS Code Copilot (
.vscode/mcp.json){ "inputs": [ { "type": "promptString", "id": "polarion-pat", "description": "Polarion PAT", "password": true } ], "servers": { "polarion": { "type": "http", "url": "https://mcp.example.com/mcp", "headers": { "Authorization": "Bearer ${input:polarion-pat}" } } } }Your own code: see Usage Examples.
Claude.ai and Claude Desktop connectors cannot set a header; use C for them.
C. HTTP server + OAuth login
Same server as B plus MCP_PUBLIC_URL. A client connecting without a token
gets a 401 pointing at the login; the user pastes their PAT once, the server
checks it against Polarion and hands the client tokens that carry the PAT
encrypted under MCP_TOKEN_SECRET. The server stores nothing; only it can
read the tokens.
Server
Pick the public HTTPS hostname. It must be reachable from where the client connects: Claude.ai and Claude Desktop/mobile connectors connect from Anthropic's cloud, so the host must be reachable from the internet (a VPN- or intranet-only host will not work). Claude Code and VS Code connect from your own machine, so an internal host is fine for them.
Start it:
docker run -d --name polarion-mcp \ -e API_BASE_URL=https://polarion.example.com/polarion/rest/v1 \ -e MCP_PUBLIC_URL=https://mcp.example.com \ -e MCP_TOKEN_SECRET=$(openssl rand -base64 48) \ -e MCP_ALLOWED_HOSTS=mcp.example.com \ -p 127.0.0.1:3000:3000 \ ghcr.io/phillipboesger/polarion-mcp:latestThe log must show
OAuth login enabled at https://mcp.example.com/authorize. StoreMCP_TOKEN_SECRETlike a password and keep it fixed: it is what lets logins survive restarts and redeploys (and must be the same on every instance behind a load balancer). Changing it logs everyone out.Configure the TLS reverse proxy to forward all of these paths, or the login breaks mid-flow:
/mcp,/authorize,/token,/register,/polarion-login,/.well-known/oauth-authorization-server,/.well-known/oauth-protected-resource(prefix match), and for method E also/gpt/and/api/toolsplus/openapi-gpt.json. A dedicated hostname that forwards/entirely is simplest. The paths live at the root, so the server cannot sit under a sub-path such ashttps://host/polarion-mcp. Apache block for the Polarion host: docs/deployment.md.Verify:
# 401 with WWW-Authenticate: this is what makes a client offer the login curl -si -X POST https://mcp.example.com/mcp \ -H 'content-type: application/json' \ -H 'accept: application/json, text/event-stream' \ -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{}}' | grep -i www-authenticate curl -s https://mcp.example.com/.well-known/oauth-protected-resource/mcp curl -s https://mcp.example.com/.well-known/oauth-authorization-serverEvery URL in the two JSON documents must start with
https://mcp.example.com.
Clients
Claude.ai (also syncs to Claude Desktop and mobile): Settings > Connectors > Add custom connector, name it, URL
https://mcp.example.com/mcp, leave OAuth Client ID/Secret empty (the client registers itself). Click Connect, paste your PAT on the page that opens, click Connect again. On Team/Enterprise plans an owner may have to add the connector for the organization first.Claude Code:
claude mcp add --transport http polarion https://mcp.example.com/mcp, then run/mcp, selectpolarion, Authenticate; the login page opens in your browser.ChatGPT (Plus/Pro/Business/Enterprise): Settings > Security and login, turn on Developer mode (on Business/Enterprise an admin may have to allow custom connectors first). Then add a custom connector / app with URL
https://mcp.example.com/mcpand authentication OAuth; leave client ID and secret empty, ChatGPT registers itself. Paste your PAT on the page that opens.VS Code Copilot: add the server as in B but without
headers; VS Code asks you to authenticate on first use.
How long a login lasts: as long as Polarion accepts the PAT. The client
renews its access token silently every hour; each renewal re-checks the PAT
with Polarion, so revoking the PAT (or its expiry date passing) ends the
login at the next renewal and the user is asked to log in again. A server
restart does not log anyone out as long as MCP_TOKEN_SECRET stays the same.
There is no per-session logout: to cut off one user, revoke their PAT in
Polarion; to cut off everyone, change MCP_TOKEN_SECRET.
D. REST wrapper + API key (ChatGPT)
A plain REST surface for Custom GPT Actions, not MCP. It uses one PAT for all callers; there is no per-user login.
Start it:
docker run -d --name polarion-rest \ -e API_BASE_URL=https://polarion.example.com/polarion/rest/v1 \ -e BEARER_TOKEN=<service-account-pat> \ -e HTTP_API_KEY=$(openssl rand -hex 32) \ -p 127.0.0.1:3000:3000 \ ghcr.io/phillipboesger/polarion-mcp:latest \ node build/http-server.jsPublish it over HTTPS (reverse proxy), then check
curl -s https://gpt.example.com/health.In the GPT editor: Configure > Actions > Create new action > Import from URL
https://gpt.example.com/openapi-gpt.json(30-tool subset that fits ChatGPT's limit). Authentication: API Key, Auth Type Bearer, paste theHTTP_API_KEYvalue.
E. Custom GPT + OAuth login
The Custom GPT Action logs every user in with their own PAT, like C. It runs on the C server; Actions cannot do the automatic client registration or PKCE that connectors use, so the GPT gets a fixed client id and secret and its own two endpoints.
Server
Set up C, including
MCP_TOKEN_SECRET. The host must be reachable from the internet (ChatGPT calls it from OpenAI's cloud).Add a client id and secret for the GPT and restart:
-e GPT_CLIENT_ID=polarion-gpt \ -e GPT_CLIENT_SECRET=$(openssl rand -hex 32)The log must show
Custom GPT OAuth enabled: authorize https://mcp.example.com/gpt/authorize, ....Forward
/gpt/,/api/toolsand/openapi-gpt.jsonin the reverse proxy too (see C step 3).
GPT editor
Configure > Actions > Create new action > Import from URL
https://mcp.example.com/openapi-gpt.json.Authentication > OAuth:
Field
Value
Client ID
the
GPT_CLIENT_IDvalueClient Secret
the
GPT_CLIENT_SECRETvalueAuthorization URL
https://mcp.example.com/gpt/authorizeToken URL
https://mcp.example.com/gpt/tokenScope
polarionToken Exchange Method
Default (POST request) or Basic authorization header; both work
Save. The server only accepts ChatGPT's own callbacks (
https://chatgpt.com/aip/<gpt-id>/oauth/callback), so there is nothing to allowlist.Test: in the GPT preview ask "list my Polarion projects", click Sign in with mcp.example.com, paste your PAT. Later calls run silently until the PAT is revoked or expires.
Local development
npm ci
cp .env.example .env # set API_BASE_URL; BEARER_TOKEN only for stdio / REST mode
npm run build
npm run start:mcp-http # Streamable HTTP MCP server on :3000See docs/examples.http for ready-to-run HTTP requests and docs/client-example.ts for a complete Node.js client example.
Available Tools
284 tools are generated from the Polarion OpenAPI spec. A few representative examples:
Tool | Description |
| List work items across a project |
| Fetch a specific work item by ID |
| List documents in a project |
| Get a specific document |
| Create new work items |
| Update an existing work item |
All tools accept an optional rawPath parameter to override REST endpoint paths without code changes — useful when your Polarion version uses non-standard paths.
The full list is generated from src/tools.ts via npm run generate-tools.
Configuration
Environment Variables
# Required
API_BASE_URL=https://your-polarion.com/polarion/rest/v1
# Required for stdio and REST (ChatGPT) mode only. The MCP HTTP server ignores it:
# each client sends its own PAT
BEARER_TOKEN=your_polarion_personal_access_token
# Optional
MCP_HTTP_PORT=3000 # port for MCP HTTP server (default 3000)
MCP_HTTP_HOST=127.0.0.1 # bind address (default 0.0.0.0); use loopback behind a TLS proxy
MCP_PUBLIC_URL=https://mcp.example.com # public HTTPS origin (no path); enables the OAuth login page
MCP_ALLOWED_HOSTS=your-host.com # DNS-rebinding protection (comma-separated)
MCP_TOKEN_SECRET=... # min. 32 chars; keeps OAuth logins valid across restarts (keep it fixed)
GPT_CLIENT_ID=polarion-gpt # Custom GPT OAuth client (method E), with GPT_CLIENT_SECRET
GPT_CLIENT_SECRET=...
NODE_TLS_REJECT_UNAUTHORIZED=0 # disable SSL verification for self-signed certsUsage Examples
Node.js client
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
const client = new Client({ name: "my-client", version: "1.0.0" });
await client.connect(
new StreamableHTTPClientTransport(new URL("http://localhost:3000/mcp"), {
requestInit: { headers: { Authorization: "Bearer your_polarion_pat" } },
})
);
const result = await client.callTool({
name: "getAllWorkItems",
arguments: { projectId: "MYPROJECT", query: "status:open", pageSize: 10 },
});Pagination
All list operations support pageSize and pageStartIndex parameters:
const page1 = await client.callTool({
name: "getAllWorkItems",
arguments: { projectId: "MYPROJECT", query: "status:open", pageSize: 50, pageStartIndex: 0 },
});Architecture
src/
config.ts — API base URL, token, and resource URL constants
server.ts — shared MCP server factory (transport-agnostic)
tools.ts — generated MCP tool definitions (284 tools)
executor.ts — tool call dispatcher
mcp-http-server.ts — Streamable HTTP MCP transport (remote clients)
http-server.ts — plain REST wrapper for ChatGPT Custom GPT Actions
index.ts — stdio entry point (local MCP clients)
polarion.ts — resource and prompt handlers
auth.ts — authentication helpers
utils.ts — shared utilitiesDesign notes:
Tools are auto-generated from the Polarion OpenAPI spec via
npm run regenerate.REST paths may differ across Polarion versions. Every tool supports
rawPathto override endpoints without code edits.No caching by design. Retries only on 429/5xx with short backoff.
Bearer token is automatically sanitized from all logs and error messages.
Security
No stored credentials in HTTP mode — the server keeps no Polarion token of its own; every
/mcprequest carries the caller's own Polarion PAT, or an access token from the OAuth login that carries the PAT encrypted underMCP_TOKEN_SECRET(the client cannot read it), and Polarion authorizes each call under that userServe it over TLS — the PAT travels in the request header; terminate TLS in front of the server and bind the plaintext port to loopback (
MCP_HTTP_HOST=127.0.0.1)DNS-rebinding protection — optional
MCP_ALLOWED_HOSTSallow-list validates theHostheader on every requestNo Secrets in Logs — tokens are automatically removed from all log output and error messages
Contributing
Contributions are welcome. To get started:
npm install
npm run typecheck # TypeScript check
npm run build # compile to build/
npm run dev:http # run locallyTo regenerate tools from the latest Polarion OpenAPI spec:
npm run regenerate # downloads spec, generates tools, builds, and testsPlease open an issue before submitting a larger change so we can discuss the approach. Pull requests should include a description of what changed and why.
Releasing
Releases are automated by .github/workflows/release.yml:
Bump
"version"inpackage.jsonand commit it tomain.Tag the commit and push the tag:
git tag vX.Y.Z && git push origin vX.Y.Z.The workflow builds, tests, and packages the release ZIP, then publishes a GitHub Release for the tag with notes auto-generated from the pull requests merged since the previous tag (from the start of the history for the first release).
Acknowledgements
🙏 Thanks to @Jonasdero, whose work is the foundation this MCP server builds on.
License
MIT © Phillip Bösger
Available Tools
284 toolsbranchDocumentA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Branching parameters. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds valuable behavioral detail beyond the annotations by explaining the server-side nature, the variable repeatability of the operation, and the dry_run preview behavior including the error-flagged result. This does not contradict the annotations; it reinforces and elaborates on idempotentHint=false while adding context about how preview responses are represented.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose and keeps the additional caveats in two follow-up sentences. All sentences carry useful information, but the third sentence is somewhat dense and mixes preview mechanics with output-schema behavior, so it is concise but not maximally streamlined.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the nested schema and existence of an output schema, the description is largely complete: it covers the important non-idempotency warning, the server-side action nature, and the dry_run safety mechanism. It could be more complete by explicitly contrasting with related sibling operations, but nothing critical needed to call the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters including nested requestBody fields. The description mentions dry_run usage but mostly repeats what the schema already says; it adds the error-flag nuance but does not provide additional meaning for the other parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a Branch of the Document.' It clearly identifies what the tool does and adds the meaningful distinction that this is a server-side action rather than a plain resource creation. However, it does not differentiate itself from the sibling tool branchDocuments, so the purpose is clear but not fully distinguished from similar operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives actionable guidance: it warns that the action is not guaranteed idempotent and advises setting dry_run=true to preview the exact request before making changes. This is clear context for how to use the tool safely, though it does not explicitly discuss when to choose this over alternatives such as branchDocuments or copyDocument.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
branchDocumentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Branching parameters. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the annotations. It explicitly warns that the operation is not guaranteed idempotent, that repeating it may be safe, a no-op, or rejected depending on the action, and explains the dry_run preview behavior including the error-flagged result quirk. This is rich behavioral context that annotations alone (readOnlyHint=false, idempotentHint=false) do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, then adds the critical idempotency warning and dry-run tip. Every sentence earns its place. It loses one point because the dry_run explanation is somewhat dense and could be split for readability, but it's still efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested requestBody, 10 sub-parameters, no idempotency guarantee), the description covers the most critical operational concerns: the server-side action nature, idempotency risk, and the dry_run safety mechanism. The output schema exists, so return values don't need explanation. It doesn't mention prerequisites like permissions, but the dry-run guidance partially compensates.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds value by explaining the dry_run parameter's behavior in detail, but it doesn't add meaning to the requestBody fields beyond what the schema provides. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Creates Branches of Documents') and distinguishes it from plain resource creation by noting it triggers a server-side action. It doesn't explicitly name sibling tools like branchDocument or copyDocument, but the phrase 'Branches of Documents' plus the server-side action warning makes the core purpose clear.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context for when to use the tool (when branching documents) and provides a strong practical guideline: set dry_run: true first to preview the request. It doesn't explicitly say when not to use it or name alternatives, but the dry-run tip effectively guides safe usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
closeCollectionA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| collectionId | Yes | The Collection ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark readOnlyHint=false, idempotentHint=false, and destructiveHint=false. The description adds value by explaining the server-side nature and explicitly warning about non-idempotency, which is not fully captured by the annotations. It also details the dry_run preview behavior, including how results are flagged, which is useful beyond the schema. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, with the core purpose stated first, followed by the effect and a practical tip. It avoids redundant wording and is well-structured, though the second sentence about preview behavior is slightly long but still clear.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description explains the tool's effect and the dry_run mechanism, which is helpful. However, it does not clarify what 'closing' entails (e.g., status change, archiving) or what the response looks like, since there is no output schema. Given it's a mutation tool, more detail on the outcome would improve completeness, but the current level is adequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with each parameter described in detail, including dry_run's purpose. The description reinforces the dry_run tip but does not add additional meaning beyond what the schema already provides. Baseline of 3 is appropriate since the schema handles parameter documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Closes the specified Collection' with a specific verb and resource, which is unambiguous. However, it does not explicitly differentiate from sibling tools like deleteCollection or reopenCollection, relying on the name and context. The additional note about it being a server-side action adds some distinction but not a direct comparison.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides context that this is a server-side action and not guaranteed idempotent, implying it should be used when a close operation is needed. However, it does not explicitly state when to use this tool versus alternatives (e.g., delete vs. close) or when not to use it. The dry_run tip gives practical usage guidance but no selection criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
copyDocumentA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Copy Document parameters. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=false, but the description elaborates on the consequences (safe/no-op/rejected) and adds the dry_run preview behavior. This goes beyond the structured metadata without contradicting it.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured: purpose first, then effect, then a practical tip. No filler; every sentence adds information. Slightly longer than strictly necessary but justified by the non-obvious behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the nested requestBody and output schema existence, the description covers the key caveats (non-idempotency, dry_run preview) and does not need to explain return values. It is sufficiently complete for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are already documented. The description adds only the dry_run tip, which is already in the schema. No additional parameter-level semantics are provided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a clear verb-resource pair ('Creates a copy of the Document') and adds a critical nuance (server-side action) that distinguishes it from simple resource creation. It clearly differentiates from siblings like branchDocument or moveToDocument by focusing on 'copy' semantics.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explains the side-effect nature and non-idempotency, which is useful for deciding when to call it, but does not explicitly contrast with sibling copy/branch/move tools. No when-not guidance or alternative tool names are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
createProjectA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Create project parameters. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds meaningful behavioral context beyond the annotations: it explains the server-side action, warns about non-idempotency (consistent with idempotentHint: false), and details the dry_run behavior including the error-flagged result. This is valuable context not present in annotations alone. It does not contradict annotations; it reinforces and elaborates on them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is appropriately sized, containing four sentences each serving a purpose: the core action, the idempotency caveat, the dry_run tip, and the output behavior. It is front-loaded with the main purpose and adds relevant details without fluff. It is not overly verbose and every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the essential aspects: what it does, the idempotency concern, and how to preview via dry_run. It does not explain the fields of requestBody, but the schema already provides thorough descriptions for each. The output schema exists, so return values are not needed. Prerequisites are not mentioned, but for a creation tool they may be self-evident. Overall, it is fairly complete for its complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds a tip about setting dry_run: true, but this information is already present in the schema's parameter description. The description does not introduce new meaning for parameters; it merely restates what the schema already provides. No additional semantic value is added beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the primary action: 'Creates a new Project.' It goes beyond a simple resource creation by noting it triggers a server-side action, which distinguishes it from a generic create and clarifies its non-trivial nature. It is unambiguous about the resource being created and aligns with the tool name.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not explicitly compare against alternative tools or state when to use this tool versus others. Usage is implied by the name and description, but there is no explicit guidance on when not to use it or which sibling to choose. The dry_run tip is a safety guideline, but it is more about how to use than when. No alternatives or exclusions are mentioned.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteAllWorkItemsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The Work Item(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal destructiveness and non-read-only behavior, but the description adds meaningful context: the operation is irreversible, data cannot be recovered through the API, and the dry-run preview behavior is explained. This goes beyond what the annotations alone provide, though the open-world hint is not elaborated on.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and scope, then gives the sibling alternative, irreversibility warning, and dry-run tip. It is slightly long due to the dry-run error-flag explanation, but each sentence earns its place for a destructive tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive global-scope operation with no output schema, the description covers scope, irreversibility, safe preview usage, and the project-scoped alternative. It does not explain response/return details, but for a delete operation with a typed schema covering inputs, this is a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameters are already well documented. The description's dry_run tip reinforces the schema's dry_run explanation but does not add much beyond it. The nested requestBody structure is adequately described by the schema itself.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool deletes a list of Work Items from the Global context, with scope explicitly spanning every project. It also distinguishes itself from the sibling `deleteWorkItems` by noting the project-scoped alternative, so an agent can immediately tell which deletion tool to choose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit when-to-use rule: use this for global scope, use `deleteWorkItems` for a single project. It also recommends `dry_run: true` as a safe preview step before committing to an irreversible operation, which is concrete practical guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteApprovalADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate destructive and idempotent behavior, and the description adds valuable context beyond them: the operation is irreversible and cannot be recovered through the API. It also explains the dry_run preview behavior, including how to interpret the error-flagged preview result. No contradiction with annotations exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: the primary action, cardinality, alternative tool, and irreversible effect appear early. The dry_run tip is useful and earns its place. No sentence is redundant with the schema or annotations.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple single-item delete with no output schema, the description covers the essential operational context: scope, sibling routing, irreversibility, and a dry-run safety mechanism. Together with the fully documented schema and annotations, it gives an agent everything needed to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% parameter description coverage, including specifics like case-sensitive projectId and workItemId format. The description itself does not add parameter-level detail beyond mentioning the single-item cardinality, so the baseline of 3 applies: the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Deletes the specified Work Item Approval.' It immediately distinguishes itself from deleteApprovals by stating cardinality: 'targets a single item by ID.' An agent can clearly understand what this tool does and how it differs from the batch sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly gives the when-not-to-use guidance: 'For the full collection or a batch, use deleteApprovals instead.' It also recommends a safe invocation pattern with dry_run first. This gives the agent clear decision criteria for selecting this tool over its sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteApprovalsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Workitem Approval(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations already marking the operation destructive, the description discloses irreversibility ('data removed or overwritten... cannot be recovered') and documents the dry-run preview behavior, including the error-flagged result quirk. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each earning its place: operation, cardinality, alternative, irreversibility, and dry-run tip. The key scoping information is front-loaded before the extended tip.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive multi-item operation with no output schema, the description plus fully covered parameters and annotations is sufficient: it warns about irreversibility, explains how to preview safely, and clarifies the odd error-flagged preview output. No critical call-time behavior is left undocumented.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the bar for added value is lower; the cardinality statement clarifies that `requestBody.data` may represent a batch or full collection, which the bare array schema does not convey. However, it does not add field-level detail beyond the schema for `id` and `type`.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource ('Deletes a list of Work Item Approvals') and explicitly distinguishes itself from the singular sibling `deleteApproval`. The cardinality note ('full collection or a batch') removes ambiguity about scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It tells the agent exactly when to choose this tool versus `deleteApproval` ('For a single item by ID, use deleteApproval instead'), and recommends starting with `dry_run: true`. This is explicit routing guidance, not merely implied context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteCollectionADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| collectionId | Yes | The Collection ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already mark the tool as destructive and not read-only, but the description goes further by stating irreversibility ('data removed or overwritten by this call cannot be recovered through the API'). It also discloses the dry-run preview behavior, including the nuance that error-flagged results may represent previews rather than real failures. This adds meaningful behavioral context beyond the structured annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: core action first, then cardinality, sibling routing, irreversibility, and the dry-run tip. Every sentence provides distinct, necessary information with no filler or repetition. It is appropriately sized for the tool's complexity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item deletion tool with no output schema, the description covers everything an agent needs: what is deleted, the scope (single ID), the batch alternative, irreversibility, and safe preview guidance. It also references relevant project ID semantics indirectly through the schema, and the dry-run note addresses how to interpret unexpected results. No critical context is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all three parameters are already well documented in the schema. The tool description reinforces `dry_run`'s purpose and prepares the user for preview output, but it does not materially expand parameter semantics beyond what the schema already states. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource ('Deletes the specified Collection'), states the cardinality ('targets a single item by ID'), and explicitly distinguishes itself from the sibling `deleteCollections` for batch/full operations. An agent can confidently select this tool over its close sibling without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use guidance via the cardinality statement and names the alternative (`deleteCollections`) for full-collection or batch deletion. It also provides a concrete safety tip to use `dry_run: true` first, and even explains how the preview result is surfaced. This is actionable usage guidance beyond a generic description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteCollectionsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Collection(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
While annotations already flag destructiveHint=true, the description adds meaningful specifics: 'irreversible — data removed or overwritten by this call cannot be recovered through the API.' It also discloses the dry_run preview behavior and the error-flagged result for previews, which is not covered by annotations. No contradiction with annotations (idempotentHint and destructiveHint are compatible).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: the primary action and differentiation come first, followed by irreversibility, then the dry_run tip. Every sentence adds value; there is no filler. Structure is efficient for an agent scanning for purpose and safety.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 3-parameter tool with a nested requestBody and no output schema, the description covers essential context: what it deletes, cardinality, alternative for single items, irreversibility, and a dry_run preview mechanism. Nothing required for correct invocation is missing, and the error-flagged preview behavior is explained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% — the schema already fully describes projectId, requestBody, and dry_run. The description's mention of 'full collection or a batch' and the dry_run tip adds usage context but not parameter-specific semantics beyond what the schema provides. Baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a clear verb+resource statement: 'Deletes a list of Collections.' It immediately differentiates from the sibling `deleteCollection` by specifying cardinality ('targets the full collection or a batch') and explicitly directing single-item use to `deleteCollection`. Purpose is unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool versus alternatives: 'For a single item by ID, use `deleteCollection` instead.' It also provides a concrete usage tip (set `dry_run: true` to preview) and explains the preview's error-flag behavior. Usage conditions and exclusions are fully specified.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteCollectionsRelationshipADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Relationship body. | |
| collectionId | Yes | The Collection ID. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the destructiveHint annotation, the description explicitly states that the effect is 'irreversible' and that removed or overwritten data 'cannot be recovered through the API.' It also discloses dry_run preview behavior, including that typed-output previews appear as error-flagged results and the agent should read the text content regardless of that flag.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with no filler. The primary action is front-loaded, followed by the irreversible warning and the actionable dry_run tip; every sentence contributes necessary information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description, combined with the 100%-documented schema and annotations, fully equips the agent to invoke the tool correctly. It covers the destructive nature, the safe preview workflow, and the error-flag behavior, while the schema covers all parameter semantics and required fields.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by explaining the dry_run workflow and the error-flag nuance, enriching the meaning of the dry_run parameter. Other parameters rely on the schema, which fully documents them.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Removes the specific Relationship from the Collection.' This clearly identifies the deletion action and distinguishes it from sibling tools like postCollectionsRelationships, patchCollectionsRelationships, and getCollectionsRelationship.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use the tool—when a specific relationship must be removed from a collection—and provides the dry_run tip as a safety practice. However, it does not explicitly mention alternatives or exclusions, such as using patchCollectionsRelationships to modify or postCollectionsRelationships to add relationships.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteDocumentPartsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The list of Document Part IDs to delete. | |
| documentName | Yes | The Document name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the destructiveHint annotation by stating that deletion is irreversible and data cannot be recovered through the API. It also explains the dry_run preview behavior, including that the preview may be returned as an error-flagged result on typed output tools and that the text content should be read regardless. These are valuable behavioral details not present in the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is composed of three sentences, with the purpose front-loaded, followed by an irreversible warning and a dry_run tip. The last sentence is somewhat long but provides important context for interpreting error-flagged preview results. Overall, each sentence carries necessary value and there is no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive delete tool with no output schema, the description covers the essential safety aspects: irreversibility, dry_run preview, and how to interpret the preview response. Together with the fully documented input schema, it provides sufficient context for an agent to invoke the tool correctly, though it does not mention any prerequisites or post-conditions beyond the warning.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 100% schema description coverage, the schema already documents all parameters. The description adds meaningful semantics for the dry_run parameter by explaining that the preview is error-flagged and must be read from text content, which is not explicitly in the schema. It does not add semantics for other parameters, but the schema covers them adequately.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Deletes a list of Document Parts,' which is a specific verb-resource pair. It clearly differentiates from sibling tools like moveDocumentParts, overwriteDocumentParts, and getDocumentParts by explicitly naming the delete action and the target resource.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context for when to use this tool: to delete document parts. It also includes a practical safety tip to use dry_run first for preview. However, it does not explicitly mention alternatives or exclusions, such as moveDocumentParts or overwriteDocumentParts, leaving some room for inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteExternallyLinkedWorkItemADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| roleId | Yes | The Role ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| hostname | Yes | The Target Hostname. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| targetProjectId | Yes | The Target Project ID. | |
| linkedWorkItemId | Yes | The Linked Work Item ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the destructiveHint annotation, the description details irreversibility, possible overwriting, and the dry_run preview behavior including the error-flagged result nuance. This is additive context that helps the agent behave safely.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence adds value: primary action, cardinality/alternative, irreversibility, and the dry_run preview including output schema edge case. No fluff or redundant restating of annotations.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive single-item deletion with no output schema, the description gives the agent everything needed: what it deletes, when to use the sibling, that it is irreversible, and how to preview safely. Parameter details are fully covered by the input schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already explains all parameters. The description adds operational tips about dry_run but does not materially extend the meaning of the parameters beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Deletes the specified Externally Linked Work Item.' Explicitly identifies cardinality as single-item and distinguishes itself from the batch sibling `deleteExternallyLinkedWorkItems`.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent when to use this tool versus the batch alternative and includes the dry_run preview tip to validate before committing to an irreversible call.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteExternallyLinkedWorkItemsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Work Item(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds valuable behavioral context beyond the annotations: it states the operation is irreversible and data cannot be recovered through the API, which reinforces the destructiveHint. It also introduces the dry_run tip and explains that the preview appears as an error-flagged result because it's not real tool output. This is genuinely useful information an agent wouldn't get from annotations or schema alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact yet information-dense: each sentence serves a purpose. It front-loads the core action, then quickly covers scope, alternative, irreversibility, and a safety tip. There is no filler or redundancy, making it easy to parse in one glance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive batch operation with no output schema, the description covers the essential facts: what it does, scope, irreversibility, and a dry-run safeguard. It doesn't mention prerequisites like required permissions or behavior when some items don't exist, but given the schema already details the payload and the annotations carry the destructiveness, this is nearly complete. A short note on error/partial-failure behavior would push it to 5.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds extra meaning by explaining the cardinality of the operation ('full collection or a batch') and noting that a single item by ID belongs to the sibling tool.This helps an agent understand how the requestBody array should be populated, which goes slightly beyond the schema's dry property descriptions. Thus a 4 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Deletes a list of Externally Linked Work Items', which is a specific verb and resource, and immediately clarifies scope with 'Cardinality: targets the full collection or a batch.' It also differentiates from the sibling 'deleteExternallyLinkedWorkItem' by explicitly stating for a single item, use that other tool. This leaves no ambiguity about what the tool does or how it differs from its closest alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for when to use this tool: when deleting a list, collection, or batch. It explicitly names the alternative for single-item deletion, which is a strong routing signal. However, it doesn't enumerate other situations where this tool should be avoided (e.g., if partial deletion is needed or if soft-delete semantics are required), so it falls short of fully explicit when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteGlobalCustomFieldsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| resourceType | Yes | The Resource Type. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (destructiveHint, idempotentHint), the description discloses that the operation is irreversible and cannot be recovered via the API. It also explains the dry_run preview behavior, including the error-flagged result quirk, which adds significant behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is tight, front-loaded with the core purpose, then scope, alternative, effect, and tip. Each sentence earns its place without redundancy, making it easy for an agent to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, irreversible operation with no output schema, the description covers all essential aspects: scope, alternative, irreversibility, dry_run usage, and the preview's error-flag nuance. Nothing an agent needs to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already documents all parameters with high coverage. The description adds value by explaining the dry_run preview's error-flag behavior, which is not in the schema. This extra nuance justifies a score above the baseline of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb (Deletes), a specific resource (Custom Field configuration), and the context (Global context). It explicitly differentiates from the sibling deleteProjectCustomFields, making the tool's scope unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly tells when to use this tool (for global scope) and when to use the alternative (deleteProjectCustomFields for a single project). It also recommends a dry_run tip for safe preview, providing clear guidance on how to invoke it safely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteGlobalEnumerationADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| enumName | Yes | The Enumeration Name. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| enumContext | Yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses that the operation is irreversible and data cannot be recovered through the API, which is critical behavioral context. It also explains the dry_run preview behavior, including that the preview is returned as an error-flagged result. The annotations already declare destructiveHint=true and idempotentHint=true, so the description adds value by explaining the irreversibility and the dry_run behavior beyond what annotations provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured, with the core purpose front-loaded. It covers scope, alternatives, effect, and a usage tip in a compact form without unnecessary words. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete for a destructive operation: it states scope, irreversibility, and provides a safe preview mechanism. There is no output schema, but the description explains what to expect from the dry_run preview. The only minor gap is not describing the success/failure response format for the actual deletion, but the irreversibility warning and dry_run tip largely compensate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, so the schema already documents all four parameters. The description adds some context by mentioning dry_run: true as a tip, but it doesn't add significant meaning beyond what the schema already provides. Baseline 3 is appropriate given the high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool deletes a specified Enumeration from the Global context, with a specific verb and resource. It also explicitly distinguishes itself from deleteProjectEnumeration, which operates on a single project. This makes the tool's purpose unambiguous and differentiates it from its sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool (Global context, no project filter) and when not to (use deleteProjectEnumeration for a single project). It also provides a clear tip to use dry_run: true first to preview the request, which is actionable usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteLicenseSlotsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| typeId | Yes | License type. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | No Content |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description provides substantial behavioral context beyond annotations: it states the effect is irreversible, explains the dry_run preview behavior, and details how the preview appears as an error-flagged result. These insights go well beyond the destructiveHint and idempotentHint annotations, giving the agent a clear picture of side effects and safety measures.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded with the core action, followed by the platform caveat, irreversibility note, and the dry_run tip. It is efficient in wording, though the sequence could be slightly more organized for scanning. Overall, it earns its place without unnecessary verbosity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the tool's purpose, irreversibility, platform compatibility, and a safety tip for previewing requests. Given the tool's moderate complexity (3 parameters, no output schema) and the rich annotations, this is nearly complete. It lacks explicit details on return values or error handling, but those are not required given the absence of an output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides detailed descriptions for all parameters (typeId, dry_run, requestBody), achieving 100% coverage. The description adds a practical tip about using dry_run but does not elaborate on parameter meaning beyond the schema, so it stays at the baseline of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the action (deletes), the resource (Group license slots), and specifies it operates on a list, distinguishing it from the singular deleteLicenseSlot. It also notes the platform limitation (not supported by cloud-based Polarion X), leaving no ambiguity about what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for bulk deletion of license slots and provides a safety tip to use dry_run first. However, it does not explicitly contrast with alternatives like deleteLicenseSlot (singular) or explain when to choose one over the other. The guidance is present but implicit rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteLinkedWorkItemADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| roleId | Yes | The Role ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| targetProjectId | Yes | The Target Project ID. | |
| linkedWorkItemId | Yes | The Linked Work Item ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond annotations by disclosing irreversibility, exact singular cardinality, and the dry-run preview behavior including the error-flagged result nuance. These details align with the destructive/readOnly annotations and add valuable operational context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured and front-loads the core action, then covers exclusions, cardinality, the batch alternative, effect, and dry-run tip. The Java API reference is minor filler, but the overall density is justified and scannable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive single-link deletion with no output schema, the description covers scope, irreversibility, dry-run safety, and batch alternatives. It does not explicitly describe the normal success/failure response shape, but the abundant schema documentation and behavioral warnings largely compensate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all six parameters. The description adds only a usage tip around `dry_run` and does not materially expand parameter semantics beyond what is already present in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action: deletes a single direct outgoing Work Item link by ID. It distinguishes itself by excluding external links and backlinks and by naming the batch sibling `deleteLinkedWorkItems`, leaving no ambiguity about scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool (single link targeting one item) and when not to: use `deleteLinkedWorkItems` for full collection/batch, and this does not handle external links or backlinks. It also promotes a safe workflow by recommending `dry_run: true` first.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteLinkedWorkItemsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Work Item(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations (destructiveHint true, etc.), the description adds irreversibility warning, dry_run tip, and error-flagged preview behavior. This provides valuable context about consequences and testing without contradicting any annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is appropriately sized, front-loads the core purpose, and each sentence adds distinct value (scope, cardinality, alternative, effect, tip). The dry_run explanation is slightly verbose but not excessive.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite no output schema, the description covers purpose, scope, cardinality, alternative, and behavioral caveats. It doesn't detail return values or edge cases (e.g., empty batch), but for a destructive tool with strong annotations, the info is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are already documented. The description adds minimal extra parameter meaning, mostly reinforcing the dry_run tip and cardinality; it does not introduce new semantics beyond the schema, which is acceptable given high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'deletes' and the resource 'direct outgoing links to other Work Items', distinguishing it from external links and backlinks. It also specifies cardinality (full collection or batch) and names the singular sibling tool, so an agent can immediately differentiate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly directs to 'deleteLinkedWorkItem' for a single item and clarifies that external links/backlinks are out of scope. It doesn't exhaustively cover all related alternatives (e.g., postLinkedWorkItems), but the core usage context and primary alternative are clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteOslcResourcesADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Oslc Item(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds valuable behavioral context beyond the destructiveHint annotation: the operation is irreversible through the API, only the link is removed, and dry_run previews the request without changing anything. It also warns about how the preview may appear as an error-flagged result, which is important for interpreting tool output.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action, then follows with scope boundaries, alternatives, irreversibility, and a practical dry-run tip. Every sentence contributes essential decision-making or usage information without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the annotations, full schema coverage, and no output schema, the description covers everything an agent needs: what is deleted, what is not deleted, how to identify targets, when to use alternatives, and safety/preview behavior. No critical contextual gap remains.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameters are already well documented. The description adds extra meaning by specifying that requestBody.data contains link IDs returned by getOslcResources and by explaining the effect of dry_run, which goes beyond the schema's generic field descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Removes one or more OSLC links from a Work Item'. It also distinguishes itself from sibling tools by explicitly contrasting with postOslcResources and deleteLinkedWorkItems, so an agent can select the correct operation without guessing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: use postOslcResources for adding links and deleteLinkedWorkItems for Polarion-internal links. It also clarifies the boundary by noting the remote OSLC artifact is untouched, which helps agents decide when this tool is not appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deletePageADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds that the effect is irreversible and data cannot be recovered via the API, which goes beyond the annotation. It also explains the dry_run preview behavior, clarifying that the preview returns an error-flagged result. This provides meaningful behavioral context beyond the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the core action ('Deletes the specified Page') followed by the irreversibility warning and the dry_run tip. Every sentence adds value and there is no fluff. The structure is optimal for quick parsing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple delete tool with three required parameters and one optional, the description covers the essential behavioral aspects: irreversibility, dry_run preview, and the preview's error-flag behavior. The output schema is absent, so no need to explain returns. It doesn't mention side effects on related data (e.g., attachments) but that is not required for a basic delete operation. Overall, it is sufficiently complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage with clear descriptions for all four parameters, including dry_run, projectId, spaceId, and pageName. The description does not add meaning beyond the schema; it only references dry_run in the tip. Per calibration, baseline 3 is appropriate when schema covers everything.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action: 'Deletes the specified Page.' It specifies the resource (Page) and the verb (Deletes), and distinguishes it from read/update tools like getPage and patchRichPage by making the destructive nature explicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a useful tip about dry_run but does not mention when to use this tool versus alternatives, nor does it state conditions where it should not be used. There is no explicit comparison to sibling tools like deletePageRelationships or patchPage, leaving the agent to infer usage from the name and action.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deletePageAttachmentADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag destructiveHint and readOnlyHint=false, but the description adds crucial context: the operation is irreversible and data cannot be recovered. It also explains the dry_run preview behavior and how to interpret the error-flagged result, which goes beyond annotation data. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, with the core action front-loaded, followed by irreversibility warning and a practical tip. No wasted words; every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a delete tool with no output schema, the description covers the essential action, irreversibility, and dry_run guidance. It does not specify the success return behavior, but that is often implicit for delete operations and not critical given the lack of output schema. The dry_run preview explanation adds completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and all parameters have thorough descriptions. The tool description does not add any parameter-specific meaning beyond the schema. It mentions dry_run but the schema already explains it. Baseline 3 is appropriate given full schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Deletes') and resource ('Page Attachment'), clearly distinguishing it from sibling get/patch operations. The irreversibility note further clarifies the destructive nature. The purpose is unambiguous and distinguishes from alternatives by verb.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly implies when to use (to permanently remove an attachment) and emphasizes irreversibility, which guides usage caution. It also provides a concrete usage tip (dry_run) for safe preview. However, it does not explicitly name alternatives or when not to use, but for a delete operation that is largely implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deletePageRelationshipsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, readOnlyHint=false, and idempotentHint=true. The description adds valuable context: irreversibility, the dry_run preview tip, and the note about error-flagged results for previews. This goes beyond annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, front-loaded with the primary purpose, then the critical irreversible effect, then the practical dry_run tip. It is concise and well-structured, with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive delete tool with 6 params, nested objects, and no output schema, the description covers the essential operational details: irreversibility, dry_run preview, and preview behavior. It does not explain what a page relationship is, but that is covered by the schema and sibling context. Overall, it is sufficiently complete for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are documented in the schema. The description adds no parameter-specific details beyond what the schema provides, except highlighting dry_run in the tip. Baseline 3 is appropriate given high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('Deletes') and resource ('Page Relationships'), and explicitly notes the irreversible effect. This distinguishes it from read tools like getPageRelationships and update tools like patchPageRelationships, making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for deleting page relationships but does not explicitly contrast with alternatives like postPageRelationships or patchPageRelationships. There is no 'use this when...' or 'use X instead' guidance, though the destructive nature is highlighted. This is adequate but not explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deletePlanADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The Plan ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark destructiveHint=true, but the description adds context about irreversibility ('data removed or overwritten by this call cannot be recovered through the API') and explains the dry_run preview behavior, including the error-flagged result nuance. This goes beyond annotations, providing valuable behavioral insight without contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is structured clearly: purpose, cardinality, alternative, effect, and tip. It is a bit verbose with the dry_run preview explanation, but each sentence serves a purpose and the main point is front-loaded. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a delete tool with no output schema, the description covers all necessary guidance: what it does, when to use alternatives, irreversibility, and a safe workflow via dry_run. Required parameters are handled by the schema. Nothing an agent needs to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so parameters are already well-documented. The tool description reinforces the `dry_run` tip but doesn't add fundamentally new semantics beyond what the schema provides. Baseline 3 is appropriate given high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Deletes the specified Plan.' It also clarifies cardinality ('targets a single item by ID') and explicitly distinguishes from the plural sibling `deletePlans`. An agent can immediately understand the tool's function and how it differs from alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly directs when to use this tool vs. alternatives: 'For the full collection or a batch, use `deletePlans` instead.' It also provides a practical tip about using `dry_run` to preview the request, which is actionable guidance for safe usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deletePlanRelationshipADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The Plan ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the destructiveHint annotation, the description explicitly warns that the operation is irreversible and that removed/overwritten data cannot be recovered through the API. It also discloses the dry_run preview behavior, including the note about error-flagged results. This adds meaningful behavioral context beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded: purpose, then destructive effect, then the dry_run tip. The final sentence about typed output schemas is slightly tangential because this tool does not have an output schema, but the overall length is still appropriate and focused.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the essential intent, irreversibility, and safe preview guidance, which is particularly important for a destructive mutation tool. The schema provides rich parameter descriptions. It does not describe success/error response details, but with no output schema and strong parameter documentation, the description is sufficiently complete for invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description itself does not add parameter-level detail beyond the schema, and it does not need to; the schema already documents planId, projectId, relationshipId, requestBody, and dry_run. No additional semantic value is provided for parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action and resource: 'Removes the specific Relationship from the Plan.' This is clear and matches the tool name. It does not explicitly contrast this with sibling tools like deleteCollectionsRelationship or deleteWorkItemsRelationship, but the Plan-scoped target is evident from the name and description.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies this tool is used when a Relationship on a Plan needs to be removed, and the dry_run tip gives operational guidance. However, it does not explicitly state when to choose this tool over alternatives or mention related tools such as postPlanRelationships or patchPlanRelationships. The usage context is mostly implied rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deletePlansADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Plan(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds crucial context: irreversibility (data cannot be recovered via the API) and the behavior of dry_run (returns error-flagged preview). It also explains how to interpret that preview, which is valuable beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, front-loaded with the core purpose and cardinality, and every sentence adds value. The dry_run tip is practical and the exclusion of deletePlan is clear, with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the destructive nature, the description covers the essential aspects: cardinality, irreversibility, alternative for single deletion, and a safe preview mechanism. It does not need to describe return values since there is no output schema, and annotations already cover idempotency. The description is complete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are fully documented in the schema. The description mentions dry_run but does not add new parameter semantics beyond what the schema already states. Baseline of 3 is appropriate since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it deletes a list of Plans, specifies cardinality (full collection or batch), and distinguishes itself from deletePlan for single-item deletion. This gives a precise verb+resource+scope that an agent can act on without ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly directs users to deletePlan for a single item by ID, providing an alternative and the condition for choosing it. The dry_run tip also guides safe usage by recommending a preview step before actual deletion.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteProjectADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond the destructiveHint annotation by stating the effect is irreversible and that data cannot be recovered through the API. It also explains the dry_run preview behavior, including the unusual error-flagged result, which adds meaningful behavioral clarity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with no filler: it states the action, the risk, and the safe invocation path. The dry-run output caveat is included because it is genuinely important, and the structure is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive two-parameter tool with an output schema and supporting annotations, this description is complete. It covers the destructive effect, irreversibility, the safe preview pathway, and the non-obvious preview output behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already fully documents projectId and dry_run. The description adds a useful tip about setting dry_run first, but does not introduce additional parameter-level semantics beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with an explicit verb and resource: 'Deletes the specified Project.' This clearly states the tool's function and distinguishes it from sibling read/update tools like getProject and patchProject.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is conveyed somewhat implicitly: use this when you need to delete a project. The dry-run tip and irreversibility warning provide useful context, but the description does not explicitly name alternatives or state when deleteProject should not be used.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteProjectCustomFieldsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| resourceType | Yes | The Resource Type. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark destructiveHint=true, but the description adds crucial context: the effect is irreversible and data cannot be recovered via the API. It also discloses the dry_run preview behavior, including the error-flagged result quirk, which is not visible in annotations or schema. This is rich behavioral disclosure beyond structured data.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence serves a distinct purpose: purpose, scope/alternative, irreversibility, and dry_run tip. The information is front-loaded and there is no filler or repetition of schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive tool with no output schema, the description covers all essential call decisions: what it does, scope, the alternative for global scope, irreversible effect, and a safe preview mechanism. The dry_run error-flag behavior is a subtle but critical operational detail that would otherwise be a surprise. Nothing an agent needs to invoke it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds value by tying projectId to scoping ('Scope: one project (requires a project ID)') and by recommending dry_run with a concrete purpose ('preview the exact request... without changing anything'). This goes beyond simply restating schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource ('Deletes the specified Custom Field configuration') and immediately scopes it to one project. It explicitly names the sibling tool deleteGlobalCustomFields and the condition that selects it (across all projects), making differentiation unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance: use for one project, use deleteGlobalCustomFields for all projects. Also gives a practical workflow tip (dry_run first) with a clear rationale. There is no ambiguity about when this tool is the right choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteProjectEnumerationADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| enumName | Yes | The Enumeration Name. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| enumContext | Yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark destructiveHint=true)Skip, but the description adds 'irreversible 'and clarifies the dry_run behavior, including the error-flagged result on preview. This goes beyond annotations and gives critical behavioral context for a destructive operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured, starting with the action, then scope, alternative, effect, and tip. It is a bit verbose, especially the last sentence about typed output schemas which may not apply to this tool (no output schema). However, it remains front-loaded and every sentence provides value, making it appropriately sized for the safety-critical nature.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the key aspects: the operation, scope, irreversibility, and a safe execution tip. It does not describe return values or error handling, but there is no output schema and parameters are fully documented. The sibling alternative is clearly named. Minor omission: no mention of idempotency despite the idempotentHint, but that's covered by annotations. Overall sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for all 5 parameters, so the schema already fully describes each parameter. The description does not add new parameter-level details, only restates the project scope which is already in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states 'Deletes the specified Enumeration from the Project context', giving a clear verb and resource. It further distinguishes itself from deleteGlobalEnumeration by scoping to one project, making the purpose unambiguous and differentiating from a direct sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides explicit when-to-use guidance: 'Scope: one project (requires a project ID). To act across all projects, use deleteGlobalEnumeration instead.' This tells the agent exactly when to choose this tool over the alternative Mandarin, and the dry_run tip adds practical usage advice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteProjectTestParameterDefinitionADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testParamId | Yes | The Test Parameter. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare destructiveHint=true and readOnlyHint=false, so the description correctly aligns with them and adds extra value: it warns the effect is irreversible and that data cannot be recovered through the API. It also explains how the dry-run preview surfaces as an error-flagged result, which is useful beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the primary action and cardinality, and it keeps the alternative and dry-run guidance compact. The note about typed output schemas is slightly generic and not directly applicable here since this tool has no output schema, but it still explains the preview behavior without bloating the text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given there is no output schema, the description still covers the key operational context: what is deleted, that deletion is irreversible, when to use the batch sibling, and how to preview safely with `dry_run`. Combined with the annotations and fully covered parameters, an agent has enough information to invoke this tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3; the description does not need to restate parameter meanings. It does not add substantial semantics beyond the schema, and the schema's `testParamId` description is sparse, but the tool-level text does not compensate for that specifically.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource: it deletes a single Test Parameter Definition scoped to a Project. It also distinguishes itself from the batch sibling `deleteProjectTestParameterDefinitions` by explicitly stating cardinality, so an agent can tell them apart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says to use the plural `deleteProjectTestParameterDefinitions` for a full collection or batch, which routes the agent to the correct sibling. It also recommends `dry_run: true` as a safe preview step before actually deleting.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteProjectTestParameterDefinitionsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Test Parameter Definition(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as destructive, but the description adds meaningful context beyond the hint: the operation is irreversible and data 'cannot be recovered through the API.' It also discloses the dry_run preview behavior and the unusual error-flagged preview result, providing behavioral nuance the annotations alone do not convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact yet information-dense. Every sentence earns its place: purpose, cardinality, sibling alternative, irreversibility, and dry_run guidance are all front-loaded and directly useful. There is no filler or redundant restatement of the tool name.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive batch operation with no output schema, the description is complete: it explains scope, irreversibility, the safer dry_run flow, and how to interpret the preview result. An agent has all necessary context to call this tool correctly and avoid unintended data loss.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents `projectId`, `dry_run`, and `requestBody` adequately. The description does not add significant parameter-level meaning beyond reaffirming the dry_run tip. Baseline 3 is appropriate because the schema carries the full weight.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Deletes a list of Test Parameter Definitions for the specified Project.' It also clarifies cardinality ('full collection or a batch') and explicitly differentiates from the single-item sibling by naming `deleteProjectTestParameterDefinition`. An agent can immediately understand what this tool does and how it differs from related tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use boundaries: batch or full-collection deletion vs. 'For a single item by ID, use `deleteProjectTestParameterDefinition` instead.' It also offers a concrete usage tip (`dry_run: true`) to preview the request. This fully guides an agent on when to choose this tool over alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRecordADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the tool as destructive and not read-only, but the description adds important context beyond those flags: the effect is irreversible and data cannot be recovered through the API. It also explains the non-obvious dry_run behavior, including that preview results are error-flagged on typed-output tools. This materially helps an agent understand consequences before invoking the tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose and uses three concise sentences. The irreversibility warning and dry_run tip are each necessary given the destructive nature of the operation. The final sentence is a bit dense with the error-flag caveat, but every clause earns its place and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a fully documented schema and annotations covering the safety profile, the description is largely complete for a destructive tool. It adds irreversibility and a safe-preview workflow, which are critical for correct usage. A minor gap is that it does not explicitly explain how the parameters collectively identify a Test Record, but the schema's parameter descriptions already cover that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the individual parameter descriptions already carry the semantic load. The tool description mostly refers to 'the specified Test Record' without adding new meaning to parameters like iteration or testCaseProjectId. The dry_run tip reinforces the existing dry_run schema description but does not extend it significantly, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a clear, specific verb and resource: 'Deletes the specified Test Record.' This distinguishes it from sibling tools like deleteTestRun or deleteTestRecordAttachments because the resource is uniquely named. It does not explicitly name a sibling it is not, but the resource itself is unambiguous enough for an agent to identify the operation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The intended use is implied by the first sentence: use this when you want to delete a specific Test Record. The dry_run tip provides practical usage guidance for safe execution, but the description does not mention when to prefer this tool over alternatives or any exclusion criteria. This is implied usage rather than explicit routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRecordAttachmentADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false; the description adds value by stating irreversibility ('cannot be recovered through the API') and explaining the dry_run preview behavior. It does not contradict any annotation. It could have mentioned behavior on missing attachments, but the annotation-plus-description combination is strong.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Each sentence earns its place: operation, cardinality/alternative, irreversibility, and dry_run guidance. The final sentence about typed output schemas is slightly generic and less relevant because this tool has no output schema, but the rest is tight and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive single-item delete with no output schema, the description covers what it does, when to use the plural alternative, irreversibility, and how to preview safely. All required parameters are documented in the schema. The missing response-shape details are acceptable given the absence of an output schema and the relative simplicity of the operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all seven parameters are already documented in detail, including `dry_run` and the nuanced `testCaseProjectId`. The description adds no parameter-level semantics beyond the single-item cardinality, which is appropriate but not an extra contribution.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Deletes the specified Test Record Attachment.' It also clarifies cardinality ('targets a single item by ID') and explicitly names the plural sibling `deleteTestRecordAttachments` for batch operations, so an agent can disambiguate without inspecting other tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use guidance: use this tool for a single targeted attachment, and use `deleteTestRecordAttachments` for the full collection or a batch. The `dry_run: true` tip also provides a safe invocation path before committing to an irreversible operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRecordAttachmentsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Record Attachment(s) body. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal destructiveHint and readOnlyHint=false; the description adds the crucial detail that the operation is irreversible and cannot be undone through the API. It also explains the dry_run preview behavior and how to interpret error-flagged preview results, which is valuable context beyond the structured annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is organized with the core action and scope first, followed by the alternative tool and important safety/dry-run notes. It is slightly verbose due to the detailed preview explanation, but every sentence carries useful information and the structure supports quick scanning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive tool with rich schema coverage and annotations, the description covers cardinality, the singular alternative, irreversibility, and dry-run preview. No output schema exists, but the absence is not a major gap here since the tool's operation and safeguards are well described.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description's dry_run tip is procedural usage guidance rather than new parameter-level semantics; it does not meaningfully enhance understanding of parameters like projectId, requestBody, or iteration beyond what the schema already documents.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Deletes a list of Test Record Attachments.' It also clarifies cardinality ('full collection or a batch') and explicitly distinguishes itself from the singular sibling tool, deleteTestRecordAttachment. An agent can immediately tell which operation this is and how it differs from related tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The tool explicitly says to use deleteTestRecordAttachment for a single item by ID, and implies this tool for full-collection or batch deletions. This provides a clear when-to-use rule and names the relevant alternative, leaving no ambiguity about selection between the two siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRecordTestParameterADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| testParamId | Yes | The Test Parameter. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark destructiveHint=true and readOnly=false, and the description builds on that by stating the effect is irreversible and that removed/overwritten data cannot be recovered via the API. It also discloses the dry_run preview behavior and how to interpret error-flagged preview output, adding valuable context beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with the primary action first, followed by an irreversibility warning and a dry_run tip. The final sentence is somewhat long and contains a general caveat that may be less relevant since this tool has no typed output schema, but it is still useful guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 100% schema coverage, no output schema, and annotations covering the safety profile, the description is largely complete. It adds the irreversibility warning and preview guidance, but it does not explicitly distinguish itself from the nearby deleteTestRecordTestParameters sibling, which would be helpful in this large sibling set.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all seven parameters including dry_run. The description's dry_run tip largely restates what the schema's dry_run description already explains, adding little new parameter-level meaning. Baseline 3 is appropriate since the schema carries the load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Deletes the specified Test Parameter for the specified Test Record' — a specific verb and resource. It clearly identifies the singular object of the deletion, though it never names sibling tools like deleteTestRecordTestParameters or deleteTestRunTestParameter to draw an explicit contrast.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no when-to-use advice or exclusion criteria relative to sibling tools. The only usage guidance is the dry_run tip, which is a how-to tip rather than a selection guide. Usage context is implied from the tool's name and parameter set rather than explicitly stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `destructiveHint: true` and `idempotentHint: true`, but the description adds crucial context: it emphasizes the irreversible nature of the operation and explains how the dry_run preview behaves (returns an error-flagged result that should still be read). This goes beyond the annotations and fully discloses the behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured and front-loaded: it starts with the core purpose, then clarifies cardinality, then the irreversible effect, and finally the dry_run tip. Each sentence earns its place, and the most critical information appears first. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive single-item delete operation with annotations covering the destructive and idempotent hints, the description fully covers what an agent needs: the scope, the irreversibility, the batch alternative, and the safe preview mechanism. No output schema exists, but that is not a gap here since the description adequately conveys the operational context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters in detail. The description adds a useful tip about `dry_run` but doesn't provide additional parameter semantics beyond what the schema offers. This meets the baseline of 3 for full schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the exact action ('Deletes the specified Test Run') with a specific resource, clearly distinguishing it from the batch variant. It explicitly names the sibling tool (`deleteTestRuns`) for batch operations, leaving no ambiguity about what this tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides explicit guidance: 'For the full collection or a batch, use `deleteTestRuns` instead.' This directly tells the agent when to choose the alternative. It also advises using `dry_run: true` to preview the request, which is a clear usage recommendation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunAttachmentADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and idempotentHint=true, and the description reinforces the irreversibility ('irreversible — data removed or overwritten by this call cannot be recovered through the API'). It also discloses the dry_run preview behavior and how to interpret the error-flagged preview result, which is valuable context beyond the annotations. It doesn't detail auth requirements or rate limits, but the destructive nature and preview behavior are well covered.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: the core action and cardinality come first, followed by the sibling distinction, the irreversibility warning, and the dry_run tip. Every sentence earns its place; no filler or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item delete with a typed schema and annotations covering destructive/idempotent behavior, the description is nearly complete. It explains the batch alternative, the irreversible effect, and the dry_run preview. The only minor gap is that it doesn't explicitly state what a successful response looks like, but there is no output schema and the tool's behavior is simple enough that this is not a significant omission.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all four parameters thoroughly. The description adds the dry_run preview semantics and the note that attachmentId comes from list/get-attachment calls, but most parameter meaning is already in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Deletes') and resource ('the specified Test Run Attachment'), and explicitly distinguishes it from the batch sibling `deleteTestRunAttachments`. It also clarifies cardinality ('targets a single item by ID'), which removes any ambiguity about scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool vs the alternative: 'For the full collection or a batch, use `deleteTestRunAttachments` instead.' It also provides a concrete usage tip: set `dry_run: true` first to preview the request without changing anything. This is clear, actionable guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunAttachmentsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Run Attachment(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag destructiveHint=true and idempotentHint=true, and the description goes further by warning that the effect is irreversible and data cannot be recovered through the API. It also explains how the dry-run preview is surfaced (error-flagged but readable text), which an agent would not otherwise know.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose, cardinality, and routing are front-loaded in the first two sentences with no waste. The tail sentence about typed output schemas is useful context but reads as generic boilerplate that may not apply to this tool, which has no output schema, making it slightly less tight than ideal.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers the essential decisions: which tool to pick, the destructive and irreversible nature, and how to preview safely. It does not specify how to encode 'full collection' vs 'batch' in the requestBody, and there is no output schema to describe success/error returns, though annotations and the 100%-documented schema cover most remaining ground.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema itself fully documents projectId, testRunId, requestBody, and dry_run (including redaction and byte-length summary). The description's dry_run tip largely restates the schema, so it adds little parameter-level meaning beyond the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource — 'Deletes a list of Test Run Attachments' — and clarifies cardinality (full collection or batch). It also names the singular sibling deleteTestRunAttachment, so an agent can distinguish them without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly routes single-item deletions to deleteTestRunAttachment, and describes cardinality to signal when this batch/collection tool is appropriate. The dry_run tip adds a concrete recommended workflow for safe previewing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Test Run(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true and readOnlyHint=false, but the description adds the explicit 'Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API' and explains the dry_run preview behavior, including how to interpret error-flagged results. This goes beyond the structured annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is four sentences, each with distinct purpose: what it does, cardinality, irreversibility, and dry-run tip. It is front-loaded with the primary action and avoids fluff. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, batch-delete operation with no output schema, the description covers the essential context: action, scope, irreversibility, and a safe preview mechanism. The schema and annotations cover parameters and safety profile, leaving no critical gap for an agent to call the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description does not add meaning beyond the schema; it only references dry_run without detailing its semantics, which the schema already covers. The requestBody structure is fully described in the schema, so no extra value is needed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Deletes a list of Test Runs', giving a specific verb and resource. It explicitly differentiates from the sibling `deleteTestRun` by noting the cardinality difference ('targets the full collection or a batch' vs 'single item by ID'), so an agent can immediately distinguish the tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description states exactly when to use this tool versus the singular alternative: 'For a single item by ID, use `deleteTestRun` instead.' It also provides a concrete safety tip (dry_run first) that guides usage. No ambiguity remains about scope or alternative selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunTestParameterADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testParamId | Yes | The Test Parameter. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description discloses that the deletion is irreversible and cannot be recovered through the API. It also explains the dry-run preview behavior, including how error-flagged results should be interpreted, which adds valuable behavioral context not present in the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, followed by cardinality, alternative routing, irreversibility, and a practical tip. Every sentence serves a distinct purpose without padding or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the essential selection, safety, and preview behavior, and the schema/annotations already handle parameter details and mutation flags. It is slightly less complete because it does not describe what a successful deletion returns or confirm expected response behavior, though this is not critical for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameters are already fully documented in the schema. The description adds only the dry-run tip, which is useful but does not materially expand the meaning of individual parameters beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource ('Deletes the specified Test Parameter for the specified Test Run') and explicitly states single-item cardinality. It distinguishes itself from the sibling batch operation `deleteTestRunTestParameters`, so an agent can immediately tell which tool to pick.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit selection guidance: use this tool for a single item by ID, and use `deleteTestRunTestParameters` for the full collection or a batch. It also recommends `dry_run: true` as a safe preview step, adding actionable context for when and how to invoke the tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunTestParameterDefinitionADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testParamId | Yes | The Test Parameter. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well beyond the destructiveHint annotation by explicitly stating that data removed is unrecoverable through the API. It also discloses the dry_run preview behavior and the unusual error-flagged result for typed-output tools, which an agent could not reliably infer from annotations or schema alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four front-loaded sentences: the action comes first, followed by irreversibility, the dry_run tip, and the preview-flag caveat. There is no filler or redundant restatement of schema fields.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, simple primitive parameters, and a destructive annotation set, the description covers purpose, safety, and unusual dry_run behavior. An agent has enough information to invoke the tool correctly and interpret the non-standard preview result.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all four parameters in sufficient detail. The description adds a useful dry_run tip but does not materially extend parameter semantics beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly identifies the action ('Deletes') and the resource ('Test Parameter Definition for the specified Test Run'), matching the method name and making the core purpose obvious. It does not explicitly contrast with sibling tools like deleteTestRunTestParameter, so differentiation is carried by the resource phrasing rather than an explicit comparison.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The irreversible-effect warning and the suggestion to set dry_run first provide operational context and imply a safe usage pattern for a destructive operation. However, there is no explicit statement of when this tool should be preferred over related test-parameter tools or when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestRunTestParametersADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Parameter(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (destructiveHint=true, readOnlyHint=false), the description adds critical context: the operation is irreversible and data cannot be recovered through the API. It also discloses the dry_run preview behavior, including the nuance that preview results are error-flagged. This goes well beyond what annotations provide, fully disclosing the destructive and non-idempotent nature despite the idempotentHint annotation (which is about repeatability, not non-destructiveness). No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded with the primary purpose, followed by cardinality, alternative routing, and a practical tip. Each sentence adds value, though the dry_run tip is slightly verbose. Overall, it is well-structured and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers essential operational context: scope (list vs single), irreversibility, and a safe preview mechanism. Given the nested requestBody schema is fully documented and there is no output schema, the description provides sufficient context for an agent to invoke the tool correctly. A small gap is the lack of explicit mention of required parameters, but these are clear from the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides 100% coverage with descriptions for all parameters, including dry_run, projectId, testRunId, and requestBody. The description adds minimal extra semantics beyond what the schema provides, such as the cardinality note. Since the schema carries the parameter meaning effectively, a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Deletes' and the resource 'a list of Test Parameters for the specified Test Run'. It explicitly differentiates from the singular variant `deleteTestRunTestParameter`, making the scope unambiguous. An agent can immediately understand what this tool does and how it differs from its sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use this tool versus the alternative: 'For a single item by ID, use `deleteTestRunTestParameter` instead.' This directly addresses selection criteria, leaving no ambiguity about which tool to choose based on the cardinality of the operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestStepADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| testStepIndex | Yes | The Test Step index. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as destructive and non-read-only, but the description adds specific behavioral detail: changes are irreversible and cannot be recovered via API. It also explains the dry_run preview behavior, including how the error-flagged result should be interpreted, which is not present in annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the action and cardinality, then offers the alternative, effect, and a practical tip. The dry_run explanation is slightly verbose but every sentence contributes useful information; no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive single-item delete tool with no output schema, the description covers the key operational context: scope (single item), irreversibility, batch alternative, and dry_run usage. It could mention error conditions or permissions, but given the annotations and schema, this is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All four parameters are fully described in the input schema (100% coverage), so the baseline is 3. The description's cardinality note ('targets a single item by ID') adds minimal parameter-specific meaning, and the dry_run tip is more usage guidance than parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Deletes the specified Test Step' – a specific verb and resource. It then clarifies cardinality ('targets a single item by ID') and explicitly contrasts with the batch sibling `deleteTestSteps`, so an agent can easily distinguish this tool from alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description directly instructs when to use the batch alternative: 'For the full collection or a batch, use `deleteTestSteps` instead.' It also advises a safe invocation pattern with `dry_run: true`, providing clear conditional guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestStepResultAttachmentADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds meaningful context beyond the annotations: it warns that the operation is irreversible and cannot be recovered through the API, explains the dry_run preview behavior, and clarifies how the preview appears as an error-flagged result. This does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and cardinality, then provides the batch alternative, irreversibility warning, and dry-run tip. It is somewhat dense but each sentence earns its place; only the final explanation about typed output schemas could be trimmed without losing crucial guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive delete operation, the description covers the key aspects: what is deleted, the batch alternative, irreversibility, and a safe preview path. Since there is no output schema, the normal success response is not described, but that is a minor gap given the strength of the other guidance.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all parameters. The description adds some useful framing around dry_run and the single-item-by-ID cardinality, but it does not otherwise add new meaning beyond the structured parameter descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a clear verb and resource: 'Deletes the specified Test Step Result Attachment.' It also states cardinality as a single item by ID and explicitly contrasts itself with the batch sibling tool, making selection unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly names the alternative tool for full-collection or batch operations and explains when to prefer that sibling. The dry_run tip also gives actionable guidance for safe trial usage before committing to the destructive action.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestStepResultAttachmentsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Step Result Attachment(s) body. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate destructiveHint=true and readOnlyHint=false, but the description goes further by stating the effect is irreversible and that data cannot be recovered through the API. It also discloses dry_run preview behavior and warns that the preview may be returned as an error-flagged result, which is important for interpreting tool output.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the primary action and each sentence mostly earns its place. The final sentence about typed output schemas is a generic caveat that does not clearly apply here since this tool has no output schema, making it slightly extraneous.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive batch operation, the description covers what is deleted, when to use the singular alternative, irreversibility, and a safe preview path. Combined with the fully described schema and relevant annotations, an agent has enough information to invoke the tool correctly without critical gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all eight parameters and the baseline is 3. The description adds only a general cardinality note ('full collection or a batch') and a dry_run reminder; it does not meaningfully elaborate on individual parameters, but it does not need to because the schema is already detailed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Deletes a list of Test Step Result Attachments,' a clear verb, object, and cardinality. It further distinguishes itself from the sibling tool deleteTestStepResultAttachment by explicitly stating that the singular variant is for a single item by ID.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: use deleteTestStepResultAttachment for a single item, and this tool for 'the full collection or a batch.' It also provides a concrete safe-usage tip: set dry_run: true to preview the request without changing anything.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteTestStepsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Test Step(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (destructiveHint=true, readOnlyHint=false), the description discloses that the effect is irreversible and unrecoverable through the API. It also surfaces the dry_run preview behavior and the non-obvious quirk that previews may appear as error-flagged results, which an agent would otherwise misinterpret. No contradiction with annotations; idempotentHint=true is consistent with a delete operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, and the labeled sections (Cardinality:, Effect:, Tip:) make it scannable. Every sentence earns its place, though the final sentence about typed output schemas is lengthy and partially inapplicable since this tool has no output schema — it could be tightened.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive batch-delete tool with nested requestBody and safety considerations, the description covers purpose, scope, sibling routing, irreversibility, and the dry_run safety mechanism. The schema covers all parameter semantics, and no output schema exists to explain. An agent has everything needed to call this tool safely and correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters (dry_run, projectId, workItemId, requestBody) are already documented in the schema. The description's mention of dry_run in the Tip reinforces usage but does not add meaning beyond the schema's own explanation, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence, 'Deletes a list of Test Steps,' states a specific verb, resource, and cardinality. The Cardinality note ('full collection or a batch') sharpens the scope, and the explicit pointer to deleteTestStep for single items distinguishes this tool from its closest sibling without requiring schema inspection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names the alternative ('use `deleteTestStep` instead') and the exact condition that selects it ('For a single item by ID'). The Cardinality line further clarifies when this tool applies (full collection or batch), leaving no ambiguity about tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteWorkItemAttachmentADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description discloses that the operation is irreversible, that data cannot be recovered through the API, and exactly how dry_run behaves, including that the preview may surface as an error-flagged result and that the text content should still be read. This is substantial behavioral context that annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, then the irreversible effect, then the dry-run tip. The final sentence about error-flagged previews is slightly verbose and may not apply directly since this tool has no typed output schema, but it serves a real purpose in preventing confusion about dry-run results.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive mutation tool with no output schema, the description plus parameter schema cover what the operation does, its irreversibility, how to obtain the required IDs, and how to safely preview the request. The dry-run guidance is especially valuable for a delete operation and makes the tool safe to invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3; each parameter already has a clear explanation. The description adds practical value by recommending dry_run: true and explaining what the preview does, going beyond the schema's dry_run description with usage-oriented guidance.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Deletes the specified Work Item Attachment.' It clearly distinguishes this tool from siblings like getWorkItemAttachment, postWorkItemAttachments, and patchWorkItemAttachment by naming the exact delete action against a precise resource type.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description makes the deletion intent and destructive consequence explicit, and it gives concrete operational guidance: set dry_run: true first to preview without changing anything. It does not explicitly name sibling alternatives or state when not to use the tool, but the delete semantics are clear enough that an agent would not confuse this with get/post/patch operations.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteWorkItemsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Work Item(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (destructiveHint=true), the description discloses irreversibility ('data removed or overwritten... cannot be recovered through the API') and explains the dry_run preview behavior, including the error-flagged result nuance. This adds meaningful behavioral context not covered by annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with purpose and scope, then adds the alternative and effect. The tip about dry_run and the error-flagged result is useful but includes a somewhat technical implementation note that slightly extends beyond core selection guidance. Still, it is compact and each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive, irreversible operation, the description covers scope, effect, alternative, and a preview mechanism. With no output schema, it explains what the dry_run preview returns. It lacks explicit mention of prerequisites (e.g., authentication), but these are implied by the API context. Overall, it is complete enough for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%—all three parameters (projectId, requestBody, dry_run) already have detailed descriptions in the input schema. The description adds some extra context (e.g., projectId case-sensitivity, dry_run purpose), but it mostly reinforces what the schema states, so the baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States the exact operation (deletes a list of Work Items) and immediately scopes it to one project, distinguishing it from the sibling deleteAllWorkItems. The verb and resource are specific, leaving no ambiguity about what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent when to use this tool vs. the alternative: 'To act across all projects, use deleteAllWorkItems instead.' It also provides a concrete safety tip (use dry_run) that guides invocation, fulfilling the when/alternatives requirement clearly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteWorkItemsRelationshipADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare destructiveHint=true, and the description meaningfully extends this with 'irreversible — data removed or overwritten by this call cannot be recovered through the API,' conveying data-loss consequence beyond the boolean hint. It also discloses a non-obvious behavioral quirk: dry_run previews are surfaced as error-flagged results, which the agent must interpret correctly. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core purpose before the warning and tip. Each sentence earns its place, though the final dry_run explanation is somewhat verbose and partially overlaps with the schema's dry_run parameter description; the error-flag quirk it adds is genuinely new.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema and a nested requestBody containing a large type enum, the description covers purpose, risk, and a safe preview path, while the schema handles parameter details. It omits what a successful response looks like and does not explicitly distinguish this relationship-slot delete from sibling tools that delete individual link entries (e.g., deleteLinkedWorkItems).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all five parameters, including nuanced clarifications (projectId URL segment and case-sensitivity, WI-123 vs combined path, relationship slot vs link-entry ID, and dry_run redaction behavior). The tool description adds no parameter-specific meaning, which is acceptable under the baseline-3 rule since the schema carries the burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States the verb and resource precisely: 'Deletes a list of Work Item Relationships.' The term 'list' signals batch scope, which loosely distinguishes it from single-relationship deletes, but it does not explicitly differentiate from sibling relationship tools (e.g., deleteLinkedWorkItems, patchWorkItemRelationships), leaving that distinction to the schema's parameter descriptions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no explicit when-to-use vs alternatives guidance and names no siblings or exclusion conditions. It does imply a safe usage workflow by recommending `dry_run: true` before executing and warning that deletion is irreversible, which is meaningful operational guidance but not alternative-selection guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteWorkRecordADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| workRecordId | Yes | The Work Record ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already mark this as destructive and non-read-only, but the description adds important behavioral context: the effect is irreversible and data cannot be recovered through the API. It also explains how the dry_run preview is surfaced as an error-flagged result, which is non-obvious behavior beyond the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence earns its place: purpose, cardinality, sibling distinction, irreversibility, and the dry-run tip. The most important facts are front-loaded, and there is no filler or repetition of the schema.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item deletion with three required ID parameters, the description fully covers what an agent needs: the target, the cardinality, the irreversible nature, the safer alternative, and how to preview the request. There is no output schema, so explaining the dry_run error-flag behavior is particularly valuable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already describes all four parameters with 100% coverage, so the baseline is 3. The description does not add much parameter-level meaning beyond the schema; it reinforces that workRecordId identifies a single record, but the schema already conveys this.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description begins with a specific verb and resource ('Deletes the specified Work Record') and immediately clarifies cardinality ('targets a single item by ID'). It explicitly distinguishes itself from the batch sibling deleteWorkRecords, so an agent can select the correct tool without inspecting other definitions.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool (single item by ID) versus an alternative (deleteWorkRecords for full collection or batch). It also gives a concrete pre-flight instruction—use dry_run: true first—which is actionable guidance for a destructive operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deleteWorkRecordsADestructiveIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Work Record(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, but the description adds valuable context: 'irreversible — data removed or overwritten by this call cannot be recovered through the API.' It also discloses the unusual dry_run behavior (returned as an error-flagged result) and advises reading the text content. This goes beyond the annotation signals.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is structured logically: purpose → cardinality → alternative → effect → tip. Each sentence adds distinct value, though it's slightly longer than necessary. The most critical information (purpose, alternative, irreversibility) is front-loaded, making it efficient for an agent to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a destructive batch operation with no output schema, the description covers the what, when-not, side effects, and a safety mechanism (dry_run). It doesn't describe the return format or error handling, but those are often standard for delete endpoints and the nested requestBody is fully documented in the schema. Overall, it's sufficiently complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% – every parameter (projectId, workItemId, requestBody, dry_run) is documented in the schema. The description only reiterates the dry_run tip without adding new semantics. Baseline 3 is appropriate since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Deletes a list of Work Records' – a specific verb and resource. It also notes cardinality ('full collection or a batch') and explicitly contrasts with the singular `deleteWorkRecord`, making the scope unambiguous and differentiating it from a key sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent when NOT to use this tool: 'For a single item by ID, use `deleteWorkRecord` instead.' It also provides a practical tip about using `dry_run` for preview, which is directly actionable. No alternative tools for batch deletion are mentioned, but the guidance for the singular case is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
executeJobA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Execute Job parameters. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses critical behavioral traits beyond the annotations: it triggers a server-side action, is not guaranteed idempotent (reinforcing idempotentHint=false), and explains the dry_run preview behavior, including the fact that the preview is returned as an error-flagged result and instructs the agent to read the text content regardless. This goes beyond the annotations and provides actionable context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise (4 sentences) and well-structured: it starts with the purpose, then the effect and idempotency caveat, followed by a practical tip and a clarification about the preview output. Every sentence provides essential information without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the core action, the non-idempotent nature, and the dry_run preview mechanism. The presence of an output schema handles return-value documentation, and annotations cover safety hints. A minor gap is the lack of explicit success criteria, but that is likely addressed by the output schema. Overall, it is sufficiently complete for an agent to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already has 100% coverage with detailed descriptions for all parameters, including dry_run's behavior, requestBody structure, and field meanings. The description's tip about using dry_run first adds a usage recommendation but no new parameter semantics. The schema does the heavy lifting, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Executes a Job.' It also specifies the effect as a server-side action rather than plain resource creation, distinguishing it from read-only job tools like getJobs, getJob, and getJobResultFileContent. The verb and resource are specific, making the tool's function unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a clear usage recommendation: 'set dry_run: true first to preview the exact request Polarion would receive, without changing anything.' It also warns that idempotency is not guaranteed, guiding the agent on how to handle repetition. However, it does not explicitly contrast with sibling tools (e.g., getJobs), though the distinction is implicit from the action-oriented nature of the tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generateCompletionA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Generate completion parameters. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | The result of a completion generation request. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the annotations by explaining that this triggers a server-side action, that repetition may be safe, a no-op, or rejected, and that idempotency should not be assumed. It also discloses the dry_run preview behavior, including the important quirk that the preview is returned as an error-flagged result despite being valid output. This is exactly the kind of behavioral context annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: purpose, behavioral caveat, and actionable dry_run tip. The most important information is front-loaded, and there is no filler or redundant restatement of schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the nested request body, the presence of an output schema, and annotations that already signal read/write and idempotency, the description covers the remaining operational essentials: what the tool does, how to preview safely, and what to expect from the preview result. Nothing needed to call the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already provides 100% coverage of both parameters, so the baseline is 3. The description adds extra value for dry_run by clarifying that the preview is returned as an error-flagged result and should be read from the text content regardless of the flag, which is not stated in the schema. This enrichment justifies an above-baseline score.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Generates a chat completion using a Large Language Model (LLM).' This clearly distinguishes the tool from siblings like getLlms, which list LLMs rather than generate completions. The 'server-side action' clarification further positions it against resource CRUD operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The intended use case is obvious from the first sentence, and the dry_run tip gives concrete operational guidance. It does not explicitly name alternative tools or state when not to use this tool, but for a chat-completion endpoint the trigger condition is clear enough. The 'not guaranteed idempotent' note also helps an agent avoid unsafe repetition.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAllDocumentsARead-only
Returns a list of Documents from all Projects. Scope: spans every project (no project filter). To act on a single project, use getDocuments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, and the description adds a valuable behavioral warning: results span every project with no project filter, which is a meaningful data-scope consequence. This is more than a restatement of the annotations. The lack of pagination or response-shape detail is acceptable because the schema and output schema already cover those.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The core purpose and scope are front-loaded first, and the sibling alternative that disambiguates the tool is placed immediately after. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list operation, the description plus the annotations, 100% schema coverage, and an output schema provide everything an agent needs to select and invoke the tool correctly. The scoping rule and the alternative route are both explicit, leaving no critical gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and all seven parameters (sort, query, fields, include, revision, page_size_, page_number_) are fully documented in the schema. The description adds no parameter-level detail, but it does not need to; the baseline of 3 applies because the schema carries the full load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: it returns a list of Documents across all Projects. It explicitly contrasts itself with getDocuments, making the cross-project vs single-project distinction unambiguous even before the schema is inspected.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when not to use this tool ('To act on a single project') and names the alternative ('use getDocuments instead'). It also clearly defines the tool's scope as spanning every project with no project filter, giving an agent a strong selection rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAllPagesARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With readOnlyHint=true and openWorldHint=true annotations already covering the safety profile, the description adds the key behavioral context: this operation spans every project and cannot be scoped by a project filter. It does not discuss pagination behavior or large-result implications, but the schema documents paging parameters. This goes meaningfully beyond the annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with zero filler. It front-loads the action and scope before naming the alternative, and every sentence contributes decisional value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list operation with complete parameter documentation, an output schema, and safe annotations, the description covers the main decision an agent faces: repository-wide versus single-project pages. It does not contrast with getGlobalPages or getAllDocuments, but those differ in resource type and are unlikely to be confused once the repository-wide scope is stated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so every parameter already carries a detailed description. The tool description adds no parameter-level guidance, but none is needed because the structured schema fully explains sort, query, fields, include, revision, and pagination. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('Pages'), and clearly identifies repository-wide scope spanning every project. It also names getPages as the single-project alternative, which distinguishes it from a likely sibling. The wording is slightly redundant but unambiguous about scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says the scope is all projects with no project filter, and tells the agent to use getPages instead when acting on a single project. This gives both a clear when-to-use and a concrete alternative. No additional inference is required.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAllWorkItemsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already communicates safety, and the description adds a meaningful behavioral boundary: the tool spans all projects and deliberately accepts no project filter. It does not restate the annotation, and there is no contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler: the core behavior and scope are stated first, followed by a precise pointer to the alternative. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete for a read-only list tool: annotations cover safety, the rich input schema covers all seven parameters, an output schema exists, and the sibling distinction is explicit. Nothing needed for correct selection or invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and every parameter already has a detailed explanation. The tool description adds no additional parameter semantics, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource ('Returns a list of Work Items') and immediately distinguishes itself from 'getWorkItems' by stating the scope spans every project with no project filter. An agent can unambiguously tell this tool apart from its sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool (when you need work items spanning all projects) and when not to, directing the agent to 'getWorkItems' for single-project scope. This is clear, actionable routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAvailableEnumOptionsForDocumentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fieldId | Yes | The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| documentName | Yes | The Document name. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the agent knows it is a safe read operation. The description adds context beyond that: it explains the result is narrowed by Document type and that fieldId must reference an enumeration-typed field. No contradiction with annotations; the additional type-narrowing note is useful behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero filler. The main purpose is front-loaded, followed by concrete usage guidance and sibling differentiation. Every clause earns its place; no redundant phrasing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 6-parameter tool with an output schema, the description covers the essential context: what it does, when to call it (before patchDocument), the field-type constraint, and how it differs from the two most similar siblings. The output schema handles return format, and annotations cover safety, so nothing an agent needs to invoke it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%—every parameter, including fieldId, spaceId, and pagination params, is documented with meaningful descriptions. The tool description does not add new parameter semantics beyond what the schema already states (e.g., the fieldId requirement is already in the schema). Baseline 3 applies because the schema carries the burden effectively.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb ('Returns') and a precise resource ('enumeration options that may be set on one field of one existing Document'), immediately conveying scope and the narrowing by Document type. It further differentiates from sibling tools by naming getCurrentEnumerationOptionsForDocument and getAvailableEnumOptionsForDocumentType, so an agent can disambiguate without inspecting their schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs when to use the tool: 'Call it before patchDocument to pick a valid value.' It also lists the exact alternatives for different scenarios (current values vs. non-existing Document), leaving no ambiguity about selection among the closely related siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAvailableEnumOptionsForDocumentTypeARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | The Type of the object. Use '~' without quotes to represent no target Type. | |
| fieldId | Yes | The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so safety is covered. The description adds useful behavioral context beyond that: the pre-creation constraint, the `type=~` wildcard semantics, and the enum-typed field requirement. It does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each earning its place: core behavior, fieldId constraint, type=~ behavior, and usage guidance with sibling routing. The description is front-loaded with the main result and contains no fluff or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return structure is already documented. The description supplies the workflow context, the key edge case, and the sibling alternative, while annotations cover safety. Nothing an agent needs to invoke this tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already covers all 5 parameters with detailed descriptions, including the `~` sentinel for `type` and the enum-typed requirement for `fieldId`. The description mostly restates this, so it adds little beyond the schema. Baseline 3 applies due to 100% schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('enumeration options ... for a Document type') and clarifies the temporal scope ('before any concrete Document exists'). It explicitly distinguishes itself from the sibling getAvailableEnumOptionsForDocument, so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly instructs when to call it ('Call it before postDocuments to choose valid values') and names the alternative for existing Documents ('use getAvailableEnumOptionsForDocument'). It also gives the special `type=~` case and the prerequisite that fieldId must be enumeration-typed.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAvailableEnumOptionsForWorkItemARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fieldId | Yes | The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the read-only nature is known. The description adds useful context about narrowing by item type and dependent enumerations, and the prerequisite that fieldId must be enumeration-typed. It does not contradict annotations, and the added behavioral details are valuable beyond what annotations provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no wasted words. The core purpose is front-loaded, followed by usage guidance and sibling differentiation. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only enumeration tool with an output schema, the description covers purpose, narrowing behavior, field type prerequisite, and usage context. Pagination and return format are handled by the schema and output schema, so nothing essential is missing for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are documented in the schema. The description reinforces the fieldId constraint but does not add meaning beyond the schema's own description. Baseline 3 is appropriate since the schema carries the parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('enumeration options for one field of one existing Work Item'), and explicitly differentiates from siblings by naming getCurrentEnumOptionsForWorkItem and getAvailableEnumOptionsForWorkItemType. An agent can immediately understand what this tool does and how it differs from related tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use guidance: 'Call it before patchWorkItem to pick a valid value', and clearly routes to alternatives for different scenarios (currently set values vs. non-existent items). This leaves no ambiguity about when this tool is the right choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAvailableEnumOptionsForWorkItemTypeARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | The Type of the object. Use '~' without quotes to represent no target Type. | |
| fieldId | Yes | The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the read-only nature is handled. The description adds meaningful behavioral context beyond that: it requires `fieldId` to be an enumeration-typed field, clarifies that the call is valid before an item exists, and explains that the sibling applies dependent enumerations. It does not contradict the annotations, and the added constraints help an agent use it correctly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, each earning its place: the first states the core purpose and scope, the second states a key constraint on `fieldId`, and the third gives usage timing plus the alternative. It is front-loaded and contains no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has a full parameter schema with 100% description coverage, an output schema, and read-only annotations, the description fills the remaining gaps: the pre-item usage context, the enum-field prerequisite, and the sibling for existing items. An agent has everything needed to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by illustrating `type=requirement`, explaining the `type=~` special value in context, and emphasizing the enum-typed precondition for `fieldId`. This goes beyond simply restating parameter descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('enumeration options... for a Work Item type'), and qualifies the scope with 'before any concrete item exists'. It explicitly distinguishes itself from the sibling `getAvailableEnumOptionsForWorkItem` by noting that the sibling applies to existing items, so an agent can select the correct tool without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance: 'Call it before postWorkItems to choose valid values'. It also provides a clear exclusion, directing users with an existing item to `getAvailableEnumOptionsForWorkItem`, and explains the special `type=~` value for type-independent options. This is unambiguous and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getAvatarARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses a critical behavioral trait: the file body is returned as UTF-8 text, which garbles binary files like images. Since avatars are images, it warns the tool is rarely useful. This goes beyond the readOnlyHint and openWorldHint annotations, which only cover safety and open-world assumptions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with zero fluff. The core purpose is front-loaded, followed by a caveat and alternative routing. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter read tool with no output schema and readOnly annotation, the description covers all necessary context: what it does, the caveat about binary files, and which alternatives to use. Nothing an agent needs to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema fully documents the single userId parameter (coverage 100%), so the baseline is 3. The description adds no extra meaning about the parameter itself—it's already obvious that userId identifies the user. The description focuses on the output behavior rather than the parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool downloads a user's avatar image, which is a specific verb and resource. It distinguishes itself from siblings by naming getUser (for profile data) and updateAvatar (for replacement), so an agent can tell it apart immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when not to use the tool ('rarely useful') and names the exact alternatives (getUser for profile data, updateAvatar for replacement). This leaves no ambiguity about which sibling to choose.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getBacklinkedWorkItemsARead-only
Returns the incoming links from other Work Items (also known as backlinks). Does not pertain to External links.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true and openWorldHint=true, lowering the burden on the description. The description adds useful semantic context about link directionality and external-link exclusion, but it does not disclose other behavioral details such as pagination defaults or revision handling, which are left to the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences that state the operation, define the key term, and provide an exclusion. The action is front-loaded and every word contributes signal.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a detailed input schema, a full output schema, and readOnly/openWorld annotations, the description only needs to establish the semantic scope, which it does. It lacks an explicit pointer to sibling tools for other link directions, but no critical invocation information is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all seven parameters. The description adds no parameter-level meaning beyond restating the link direction, so the baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly identifies a specific verb ('Returns') and resource ('incoming links from other Work Items') and defines 'backlinks'. It also distinguishes the tool from external-link endpoints, though it does not explicitly contrast it with the similarly named sibling getLinkedWorkItems.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The statement 'Does not pertain to External links' provides a useful negative boundary, telling the agent not to use this tool for external-link lookups. However, it does not explicitly state when to prefer this tool over getLinkedWorkItems or other relationship endpoints, so the positive selection criteria are only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCollectionARead-only
Returns the specified Collection. Cardinality: targets a single item by ID. For the full collection or a batch, use getCollections instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| collectionId | Yes | The Collection ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the agent knows this is a safe read operation. The description adds the single-item-by-ID scoping constraint, which is useful, but it doesn't disclose behavior beyond that, such as what happens if the collection is not found or whether the response includes nested resources by default. With annotations covering the safety profile, a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The core purpose and cardinality are front-loaded, and the sibling alternative is stated in the second sentence. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has a rich output schema and 100% parameter documentation, so the description doesn't need to explain return values or parameter syntax. The only minor gap is that it doesn't mention error behavior (e.g., 404 for unknown collectionId), but given the annotations and schema coverage, the description is complete enough for an agent to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all five parameters thoroughly, including the sparse fieldset selector, include, revision, projectId, and collectionId. The description adds no parameter-level detail beyond what the schema provides, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('the specified Collection'), and explicitly notes it targets a single item by ID. It also distinguishes itself from the sibling `getCollections` by naming it as the alternative for full collection or batch retrieval, so an agent can tell them apart without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool (single item by ID) and when not to ('For the full collection or a batch, use `getCollections` instead'). This is a clear when/when-not/alternative routing statement, leaving nothing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCollectionsARead-only
Returns a list of Collections. Cardinality: targets the full collection or a batch. For a single item by ID, use getCollection instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the description appropriately avoids restating that. It adds the cardinality note, but no deeper behavioral detail (e.g., pagination semantics, response size implications, or open-world behavior) beyond what the schema already conveys. This is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with the core purpose front-loaded and the alternative guidance concisely stated. No filler or redundancy—each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (8 parameters, nested fields object, output schema exists), the description covers the essential decision point (when to use vs getCollection) and cardinality. The remaining details are well captured in the schema and output schema, so nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so every parameter is already documented in the input schema. The description adds no parameter-specific information, which meets the baseline but provides no additional value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States 'Returns a list of Collections' with a specific verb and resource. It explicitly clarifies cardinality (full list or batch) and names the sibling `getCollection` for single items, making the purpose unambiguous and well-differentiated.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs to use `getCollection` for a single item by ID, providing clear when-to-use arguments against the most relevant alternative. Also clarifies the cardinality scope, so an agent knows this tool is for list/batch retrieval.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCollectionsRelationshipARead-only
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).
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| collectionId | Yes | The Collection ID. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering safety. The description adds the key behavioral detail that it returns only identifiers (linkage) without related resources' attributes, which is not in annotations. However, it does not mention pagination behavior (though schema includes page_size/page_number) or potential empty results. With annotations handling the read-only nature, the added output-format context is valuable but not exhaustive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, no fluff. The main purpose is front-loaded, the relationshipId clarification is included, and usage guidance is provided in a compact manner. Every sentence serves a distinct purpose: describing output, clarifying a parameter, and giving routing advice.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the read-only nature (annotations), a full schema with 100% parameter coverage, and an output schema present, the description is complete for an agent to decide when to call it and what to expect. It covers the core purpose, the output format, and alternatives. Nothing essential for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are documented in the schema. The description reiterates the relationshipId clarification (that it is the relationship's name, not an entry ID) which is already in the schema. It does not add new parameter semantics beyond the purpose of the tool. Since the schema already carries the parameter definitions, baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns resource identifiers linked from a Collection via a named relationship, formatted as JSON:API linkage without attributes. It distinguishes itself from sibling tools by specifying it is for Collections and contrasts with the get Collection tool (which embeds resources via `include`). The verb 'returns' and resource 'Collection relationship' are explicit, and it clarifies the relationshipId semantic.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use this tool: 'Use this to inspect one relationship cheaply' and when not to: 'to read the Collection with its related resources embedded, call its get tool with `include` instead.' It also names the alternative tools for changing relationships (post/patch/delete). This provides clear selection criteria among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCommentARead-only
Returns the specified Work Item Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getComments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations provide readOnlyHint=true and openWorldHint=true, which already cover safety and non-exhaustive results. The description adds useful context about targeting a single item, but does not disclose details like potential 404 errors, authorization requirements, or pagination concerns. Given the annotations cover safety, this is adequate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with no fluff. The core purpose is stated first, followed by a clear pointer to the alternative tool. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has an output schema, and the input schema is fully documented with examples. The description covers the key aspect of cardinality and routing to the sibling. No critical information is missing for an agent to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema descriptions are very detailed (100% coverage), explaining each parameter's purpose and providing examples. The description itself does not repeat parameter info, but the schema does the heavy lifting. The description adds no extra meaning, but the baseline 3 is justified, and a 4 is given because the schema is exceptionally clear.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it returns a specific Work Item Comment by ID, and explicitly distinguishes it from the collection tool `getComments`, which is important given the sibling context. The verb 'Returns' and resource 'specified Work Item Comment' are specific, and the contrast with `getComments` prevents confusion.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool (for a single item by ID) and directs users to `getComments` for the full collection or batch. However, it does not mention alternatives for related resources or other comment types (e.g., page comments), though this is partially covered by the sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCommentsARead-only
Returns a list of Work Item Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getComment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds only that the tool targets a collection or batch and returns a list; this is useful but modest. No contradiction with annotations is present.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences with the core purpose front-loaded and the alternative tool named in one clause. Every sentence earns its place and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, read-only annotations, and an output schema, the description does not need to enumerate return fields or parameter formats. It could slightly unpack what 'a batch' means, but an agent still has enough context to call the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema documents all seven parameters. The description adds little parameter-specific meaning beyond the cardinality remark, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Returns a list of Work Item Comments.' The cardinality qualifier and the explicit contrast with `getComment` make the tool's scope clear and distinguish it from the singular variant and from other comment endpoints.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives an explicit when-not-to-use signal: for a single item by ID, use `getComment` instead. It does not enumerate conditions against document/page/test-run comment endpoints, but the 'Work Item' resource qualifier and sibling context provide adequate routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCurrentEnumerationOptionsForDocumentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fieldId | Yes | The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| documentName | Yes | The Document name. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is clear. The description adds useful behavioral context: it resolves to full option objects (ID, name, color/icon) and requires fieldId to be an enumeration-typed field. This goes beyond what annotations provide, though it doesn't cover error conditions or pagination details, which the schema partially addresses.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, with the core purpose front-loaded, followed by a constraint and an explicit alternative. Every sentence contributes value; there is no redundancy or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (7 parameters, output schema, many siblings), the description is nearly complete. It covers the return behavior, the field-type requirement, and when to use it versus the alternative. It doesn't explicitly mention that it only applies to documents (not work items), but the name and context make that evident. The output schema handles return format details, so no further explanation is needed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description does not add material parameter semantics beyond the schema. It does reiterate that fieldId must be enumeration-typed, but that is already stated in the schema's fieldId description. No extra insight into parameter usage is provided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action ('Returns'), the exact resource (enumeration options in one field of one Document), and clarifies the key distinction that it resolves to full option objects rather than bare stored IDs. It explicitly mentions the field type requirement and names a sibling tool (getAvailableEnumOptionsForDocument) to differentiate itself, which makes the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit guidance: 'Use it to display or compare the current value; for the options you could switch to use getAvailableEnumOptionsForDocument.' This directly tells the agent when to use this tool and when to use the alternative, leaving no room for guesswork.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCurrentEnumOptionsForWorkItemARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fieldId | Yes | The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds valuable behavioral context beyond annotations by explaining that results are resolved to full option objects (ID, name, color/icon), that only enumeration-typed fields are valid, and that the tool reads the current selected value rather than available choices.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The primary behavior is front-loaded, and the second sentence delivers both a constraint and the key sibling alternative. Every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the readOnly/openWorld annotations, a fully documented 6-parameter schema, and an existing output schema, the description is complete. It explains the core value proposition, the field-type requirement, and how this tool relates to its closest sibling, so an agent has enough to select and invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The prose reinforces that fieldId must be an enumeration-typed field and that the tool reads current selection, which aligns with schema descriptions but does not add substantial new parameter-level meaning beyond what the schema already documents.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns'), resource ('enumeration option(s) currently selected in one field of one Work Item'), and a distinctive behavior (resolving to full option objects rather than bare IDs). It also explicitly distinguishes itself from getAvailableEnumOptionsForWorkItem by contrasting 'currently selected' with 'options you could switch to.'
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit usage context: 'Use it to display or compare the current value.' It also names the sibling alternative and the condition for choosing it ('for the options you could switch to use getAvailableEnumOptionsForWorkItem'). The field-typing requirement ('must be an enumeration-typed field') adds clear scope guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getCurrentUserARead-only
Returns the current User.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint and openWorldHint, so the read-only nature is covered. The description adds only the 'current User' scoping and does not explain authentication requirements, what 'current' means, or how the revision parameter affects the result, but it does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence with no filler or redundant words. 'Returns the current User.' is appropriately front-loaded and every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the readOnlyHint, complete parameter schema, and existing output schema, the description largely suffices for a simple read-only tool. It falls just short of a 5 by not explicitly differentiating from getUser/getUsers or providing authentication context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with fields, include, and revision each fully documented. The description itself adds no additional parameter semantics, so it meets the baseline without needing to repeat schema details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Returns') and names a clear resource ('current User'), so an agent knows exactly what object is being retrieved. The word 'current' distinguishes it from sibling tools like getUser/getUsers, though it does not explicitly name them.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no explicit when-to-use or when-not-to-use guidance, and it does not mention alternatives such as getUser/getUsers for retrieving other users. The phrase 'current User' is the only implied usage signal: use this when you need the current caller's identity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDefaultIconARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| iconId | Yes | The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons). |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safe read-only nature. The description adds the single-item cardinality and default-context scoping, but reveals no additional behavioral traits such as error behavior or prerequisites; acceptable for a simple annotated getter.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, with the core action and cardinality front-loaded before the alternative tool reference. No filler or repetition of schema details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only getter with an output schema and complete parameter schema, the description covers selection semantics and points to the correct sibling for batch use. It leaves global/project context differentiation to tool naming, but that is a minor omission given the explicit 'default context' phrase.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema is fully documented (100% coverage), including the fields sparse-fieldset semantics and iconId source. The description only reinforces that the ID identifies a single icon and does not add new parameter-level information, so it is at the baseline 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Returns') and resource ('specified Icon from the default context'), and clarifies cardinality as a single item by ID. The contrast with getDefaultIcons in the second sentence helps differentiate it from the nearest sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly tells the agent to use getDefaultIcons for full collection or batch requests, and the cardinality sentence implies using this when a single default icon ID is known. It does not explicitly address getGlobalIcon/getProjectIcon, though the default-context wording and sibling names make the distinction inferable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDefaultIconsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the 'default context' scoping and a cardinality note ('targets the full collection or a batch'), which is helpful, but it does not describe pagination behavior or result-set limits beyond what the schema already exposes.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is exactly two sentences, front-loaded with the action and resource, followed by a cardinality note and a sibling pointer. There is no wasted wording or redundant repetition of schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list endpoint with a rich input schema and an output schema, the description covers the core plural-vs-singular distinction and the default-context scope. It lacks explicit comparison with global/project icon tools, which is a modest gap, but the schema and annotations carry most of the remaining burden for a correct call.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with all three parameters (fields, page_size_, page_number_) already thoroughly documented in the input schema. The description adds no meaningful parameter-level detail beyond the vague 'batch' hint, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource ('Returns a list of Icons from the default context') and explicitly disambiguates from the singular sibling getDefaultIcon by stating 'For a single item by ID, use `getDefaultIcon` instead.' This makes the tool's collection-level purpose and its relationship to the closest alternative clear.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names getDefaultIcon as the alternative for single-item lookups, giving a clear when-not-to-use condition. However, it does not address other similar list tools like getGlobalIcons or getProjectIcons, so the routing guidance is useful but partial rather than exhaustive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentARead-only
Returns the specified Document. Cardinality: targets a single item by ID. For the full collection or a batch, use getSpaceDocuments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds cardinality context but no further behavioral details (e.g., response shape, side effects). Since the output schema exists, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action and cardinality, and a clear pointer to the alternative. No wasted words; every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema provided, annotations covering read-only and open-world hints, and a simple single-item read operation, the description is complete. It names the alternative for batch access and covers all essential selection criteria.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All 6 parameters are thoroughly documented in the input schema (100% coverage), so the description adds no extra parameter semantics. The schema already explains fields, include, revision, spaceId, projectId, and documentName. Baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's action ('Returns the specified Document') and specifies the cardinality ('targets a single item by ID'), distinguishing it from batch/collection operations. It is a precise verb+resource statement that stands out among many sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names an alternative tool ('getSpaceDocuments') for the full collection or batch case, providing a clear condition for when not to use this tool. This directly guides the agent on selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentAttachmentARead-only
Returns the specified Document Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getDocumentAttachments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds cardinality context (single item by ID) and the sibling alternative, but does not disclose additional behavioral details such as response shape or revision behavior; still, with annotations present the burden is lower.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, purposeful sentences with no filler. The core operation and cardinality are front-loaded, and the sibling routing is stated immediately after.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item read tool with an output schema, clear annotations, and a fully documented input schema, the description is complete. It tells the agent what the tool returns, its scope, and when to use the plural alternative.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all seven parameters are already documented in the input schema. The description adds no parameter-level meaning beyond referring to the single attachment by ID, so a baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Returns') and resource ('the specified Document Attachment'), and explicitly states cardinality ('single item by ID'). It also distinguishes itself from the plural sibling getDocumentAttachments, so an agent can tell the two apart without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to prefer a sibling tool ('For the full collection or a batch, use getDocumentAttachments instead'), giving clear routing guidance. This makes the selection criterion unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentAttachmentContentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| documentName | Yes | The Document name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds valuable behavioral context beyond annotations: the UTF-8 text decoding behavior, the warning that binary files arrive garbled, and the distinction between bytes vs metadata. It doesn't describe pagination or error behavior, but for a simple read tool this is sufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with zero waste. The core action and return type are front-loaded, the binary-file caveat is placed early, and the sibling routing is at the end. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only, 5-param tool with 100% schema coverage and no output schema, the description is nearly complete. It explains the return format, the binary-file limitation, and the sibling tools for metadata and ID discovery. The only minor gap is that it doesn't mention the revision parameter's behavior, but the schema already covers that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all five parameters. The description adds the semantic distinction between this tool (bytes) and getDocumentAttachment (metadata), which helps an agent understand what attachmentId refers to, but it doesn't add syntax or format details beyond the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Downloads'), a specific resource ('raw file content of one Document attachment'), and the exact return type ('UTF-8 text'). It also explicitly distinguishes itself from sibling tools getDocumentAttachment and getDocumentAttachments, so an agent can tell them apart without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance ('Use this only when you need the file's bytes') and names the alternatives for metadata and ID discovery. It also warns about binary files arriving garbled, which is a clear exclusion condition. This fully routes the agent to the correct tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentAttachmentsARead-only
Returns a list of Document Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentAttachment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| documentName | Yes | The Document name. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds useful cardinality context ('full collection or a batch') but does not elaborate on pagination behavior, ordering, or how 'batch' is expressed, leaving some behavior implicit.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The main purpose is stated first, the cardinality constraint is next, and the sibling-routing guidance is last. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list tool with a rich 100%-covered schema, an output schema, and safety annotations, the description is nearly sufficient. It clearly establishes collection-level cardinality and routes single-item lookups away. A slightly deeper note on what distinguishes a 'batch' from the full collection would make it fully complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all eight parameters are documented in the schema itself. The description does not add additional parameter-level meaning beyond the cardinality statement, so a baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action and resource: 'Returns a list of Document Attachments.' It also differentiates itself from the singular sibling `getDocumentAttachment`, so an agent can immediately understand this is the plural/collection variant and not the single-item-by-ID variant.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent to use `getDocumentAttachment` when a single item by ID is needed, providing a clear exclusion. It does not discuss other attachment-list siblings like `getPageAttachments` or `getWorkItemAttachments`, but the resource type is evident from the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentCommentARead-only
Returns the specified Document Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getDocumentComments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The read-only nature is already declared by readOnlyHint and openWorldHint, and the description adds the key behavioral trait of single-item cardinality. It does not mention error or auth behavior, but the output schema plus annotations make this a minor gap for a simple get-by-id operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler; the core action and cardinality are front-loaded, and the sibling reference is compact. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema, complete input schema, and annotations, nothing essential is missing. The description supplies the one piece of contextual guidance not inferable from the schema — when to use the plural sibling instead.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all seven parameters including the required projectId, spaceId, documentName, and commentId. The description does not need to add parameter-level detail, and it doesn't.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a precise operation — 'Returns the specified Document Comment' — and immediately clarifies cardinality as a single item by ID. It also differentiates itself from the plural sibling getDocumentComments, leaving no ambiguity about what resource this targets.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit routing instruction: for the full collection or a batch, use getDocumentComments instead. This tells an agent when this tool is appropriate and which sibling to choose otherwise.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentCommentsARead-only
Returns a list of Document Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentComment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| documentName | Yes | The Document name. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish the read-only and open-world safety profile, lowering the burden on the description. The description adds the useful cardinality trait ('full collection or a batch') but does not disclose other behavioral details such as pagination or how a batch is requested; this is acceptable because the schema covers pagination and the output schema exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, front-loaded with the primary action and followed by an explicit alternative. Every clause earns its place; there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description, combined with the full input schema, read-only annotations, and presence of an output schema, gives an agent enough to select and call the tool. The only minor gap is the vague 'or a batch' cardinality phrasing, which is not expanded on, but the necessary invocation details live in the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so every one of the eight parameters is documented in the schema itself. The tool description adds no parameter-level detail, so it stays at the baseline for this dimension.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: it returns a list of Document Comments. It also clarifies the operation's cardinality and explicitly distinguishes itself from getDocumentComment for single-item access, so there is no ambiguity about what this tool selects.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly gives the when-not: for a single item by ID, use getDocumentComment instead. The cardinality statement signals that this tool is for collection-level or batch retrieval, which is enough to route an agent to the correct sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentPartARead-only
Returns the specified Document Part. Cardinality: targets a single item by ID. For the full collection or a batch, use getDocumentParts instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| partId | Yes | The Document Part ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint: true` and `openWorldHint: true`, so the safety profile is covered. The description adds useful behavioral context: this is a single-item fetch by ID, not a collection or batch operation. While it doesn't discuss auth or error behavior, the annotation coverage lowers the burden and the cardinality clarification is genuinely valuable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The primary action is front-loaded, the cardinality constraint is stated clearly, and the sibling alternative is given in the second sentence. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item read tool with detailed parameter descriptions in the schema, an output schema, and annotations covering read-only behavior, nothing essential is missing. The sibling pointer for batch/full-collection needs completes the contextual picture.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and each parameter already has a thorough description, including `partId`, `projectId`, `spaceId`, `documentName`, and optional `fields`, `include`, and `revision`. The tool description adds no parameter-level detail beyond referencing the item ID, so a baseline score of 3 is appropriate when the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb ('Returns') and resource ('the specified Document Part'), and explicitly states cardinality ('targets a single item by ID'). It also distinguishes itself from the sibling `getDocumentParts`, so an agent can immediately tell which tool matches a single-item request.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly gives the condition for using an alternative: 'For the full collection or a batch, use `getDocumentParts` instead.' This tells the agent when not to use this tool and names the correct sibling, leaving no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentPartsARead-only
Returns a list of Document Parts. Cardinality: targets the full collection or a batch. For a single item by ID, use getDocumentPart instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| documentName | Yes | The Document name. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint: true` and `openWorldHint: true`, so the safety profile is covered elsewhere. The description adds the cardinality scoping ('full collection or a batch') but does not disclose pagination behavior or other runtime characteristics; given the annotations and output schema, this is adequate but not extensive.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. It front-loads the main action and cardinality, then immediately gives the sibling alternative, making it easy to parse in one read.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the read-only annotations, a rich output schema, and a fully self-describing input schema, the description covers the key decision an agent needs: when to use this tool versus `getDocumentPart`. Nothing critical is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so every parameter already has a meaningful description in the schema. The tool description adds no parameter-level semantics, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('list of Document Parts') and clarifies cardinality: full collection or batch, not a single item. It explicitly distinguishes itself from the sibling tool `getDocumentPart`, so an agent can tell them apart immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use guidance: target the full collection or a batch. It also names the alternative `getDocumentPart` for the single-item case, making the decision between the two tools unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getDocumentsARead-only
Returns a list of Documents from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllDocuments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the description does not need to restate that it is read-only. The description adds the scope constraint (one project) and the requirement for a project ID, which is useful context. However, it does not disclose additional behavioral details such as default ordering, result limits, or error handling, though these are covered by the schema. Given the annotations cover the safety profile, a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no wasted words. The main purpose is front-loaded, followed by the critical scope requirement and the alternative tool. Efficient and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list tool with a required projectId and an existing output schema, the description is complete. It tells the agent what the tool does, the scope, and how it differs from the cross-project sibling. No critical information is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all eight parameters are already documented in the schema. The tool description itself does not add any parameter-specific information, so it relies on the schema. The baseline of 3 applies when the schema does the heavy lifting, which it does here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Returns'), resource ('Documents'), and scope ('Project context'), and explicitly distinguishes from the sibling getAllDocuments by noting the one-project scope and the requirement for a project ID. This clearly differentiates it from other list tools like getWorkItems or getPages.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use this tool (within a single project, requiring a project ID) and when not to (for cross-project actions, use getAllDocuments). This is direct, actionable guidance that removes ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getExportExcelTestsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| sortBy | No | The property to sort the test results. | |
| template | No | The export template string. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description fully discloses the asynchronous behavior—that it returns a jobs resource, not the file, and that polling is required. It also mentions the import alternative, giving the agent a full picture of the operation's lifecycle. The annotations already provide readOnlyHint=true, but the description adds crucial context about the job-creation side effect and the polling/download workflow, which is beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured: it states the purpose first, then the async workflow, and finally the import alternative. Each sentence earns its place, and there is no redundant or filler content. The front-loaded purpose makes it immediately scannable for an agent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete for the tool's complexity. It covers the async behavior, the optional parameters, and the follow-up tools (getJob, getJobResultFileContent, importExcelTestResults). An output schema exists, so return values are already specified. Nothing an agent needs to call this tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema descriptions cover all five parameters, and the description adds semantic meaning by explaining the role of query ('filtered'), sortBy ('ordered'), and template ('shaped'). This goes beyond the schema's field-level descriptions and helps the agent understand how the parameters interact. Since schema coverage is 100%, the baseline is 3, but the additional context elevates it to 4.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Starts an asynchronous export'), the resource ('one Test Run's test cases'), the target ('Excel workbook'), and the optional filters (query, sortBy, template). It distinguishes itself from sibling tools by specifying the export-to-Excel workflow and explicitly noting it returns a jobs resource rather than the file, which sets it apart from getJobResultFileContent and importExcelTestResults.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit guidance on the complete workflow: poll getJob until finished, then download with getJobResultFileContent, and mentions importExcelTestResults for importing results back. It also implies when to use this tool (when exporting test cases to Excel) and provides context on the asynchronous nature. This is comprehensive and leaves no ambiguity about the next steps.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getExternallyLinkedWorkItemARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| roleId | Yes | The Role ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| hostname | Yes | The Target Hostname. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| targetProjectId | Yes | The Target Project ID. | |
| linkedWorkItemId | Yes | The Linked Work Item ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint=true` and `openWorldHint=true`, so the safety profile is covered. The description adds cardinality context and a Java API equivalence note, but does not disclose error behavior, auth requirements, or how external links differ semantically from linked/backlinked work items. Acceptable given the annotations, but not richer than necessary.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loads purpose and cardinality. The parenthetical 'The same as the corresponding Java API method' adds little value for an AI agent and prevents a perfect score, but the overall structure is efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema, rich parameter documentation, and read-only annotations, the agent has most of what it needs to call this tool correctly. The description could more clearly explain when 'external links' is the right concept versus `getLinkedWorkItems` or `getBacklinkedWorkItems`, but that gap is minor.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and each parameter already has meaningful documentation, including examples, case-sensitivity notes, and field-set behavior. The tool description itself adds no parameter-level meaning, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete operation ('Returns the external links to other Work Items') and names the resource being targeted. It also distinguishes itself from the plural sibling `getExternallyLinkedWorkItems` by cardinality, so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly gives the selection rule: use this tool for a single item by ID, and use `getExternallyLinkedWorkItems` for the full collection or a batch. This is a direct when-to-use vs. when-not-to-use statement with a named alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getExternallyLinkedWorkItemsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true and openWorldHint=true, and the description does not contradict them. It adds a cardinality note and the alternative tool, but does not disclose further behavioral details such as pagination or result formatting. Given the annotations cover the read-only safety profile, the description's added value is modest.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no redundancy. The main purpose is front-loaded, followed by a cardinality note and a clear pointer to the alternative tool. Every word contributes.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and full parameter documentation, the description need not cover return values or parameter details. It provides essential context on cardinality and the singular alternative, and the tool name clarifies its scope (external links). It does not explicitly contrast with other link getters like getLinkedWorkItems, but the name makes that distinction inherent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all 7 parameters are already documented in the input schema. The description adds no additional parameter semantics beyond what the schema provides, meeting the baseline for full coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns external links to other Work Items and explicitly differentiates it from the singular variant getExternallyLinkedWorkItem. The verb 'Returns' plus the resource 'external links' makes the purpose unambiguous, and the sibling distinction is direct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly directs the agent to use getExternallyLinkedWorkItem for a single item, providing a clear when-not condition. The cardinality note (full collection vs. batch) gives additional usage context without ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFeatureSelectionARead-only
Returns the specified Feature Selection. Cardinality: targets a single item by ID. For the full collection or a batch, use getFeatureSelections instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| selectionTypeId | Yes | The Selection Type ID. | |
| targetProjectId | Yes | The Target Project ID. | |
| targetWorkItemId | Yes | The Target Work Item ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only (readOnlyHint=true). The description adds the cardinality constraint (single item vs collection) but does not detail response format or pagination. It does not contradict annotations, and the added context is modest but useful.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences with the key cardinality constraint and sibling alternative front-loaded. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and full parameter descriptions in the schema, the description covers what's needed for a single-item getter: scope (single item) and fallback for batch. It doesn't need to explain return values or behavior already captured by annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers 100% of parameters with descriptions, so the baseline is 3. The description adds no new parameter semantics beyond the word 'ID', which is already implied by the schema parameter names and descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Returns') and resource ('the specified Feature Selection'), and explicitly notes cardinality (single item by ID), which distinguishes it from the batch variant getFeatureSelections.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent when to use this tool (single item by ID) and when to use the sibling `getFeatureSelections` (full collection or batch). This is direct routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFeatureSelectionsARead-only
Returns a list of Feature Selections. Cardinality: targets the full collection or a batch. For a single item by ID, use getFeatureSelection instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds cardinality context (full collection or batch) and the pointer to the singular variant. This adds some value beyond annotations but does not describe output format; however, the output schema exists, so that isn't required.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The purpose is front-loaded, and the alternative is given immediately. Each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema, full parameter coverage, and annotations covering safety, the description is nearly complete. The only slight gap is that 'batch' isn't precisely defined, but pagination parameters in the schema clarify this. Overall, nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all 7 parameters are documented in the schema. The description adds no parameter-specific information that isn't already in the schema, so it doesn't need to compensate. Baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it returns a list of Feature Selections, with the specific verb 'Returns' and resource 'Feature Selections'. It explicitly distinguishes from the sibling getFeatureSelection by noting the singular case, so an agent can tell them apart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit guidance on when to use this tool vs. the alternative: 'For a single item by ID, use getFeatureSelection instead.' This covers the key alternative. It doesn't mention other exclusions, but for this context it's sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFieldsMetadataForCollectionARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| collectionId | Yes | The Collection ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint and openWorldHint, so the safety profile is covered. The description adds meaningful behavioral context beyond annotations: the output is keyed by field ID, it details the type taxonomy, and it includes custom fields. It does not mention errors, auth, or rate limits, but for a read-only metadata getter these are minor omissions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three tight sentences: the first states what it returns, the second states when to use it, and the third routes to alternatives. There is no filler, and the most important information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a two-parameter, read-only metadata getter with an output schema and explicit sibling routing, the description is complete. An agent knows what the tool returns, why it should be called, and which related tools to choose instead. The remaining absences around error behavior are not essential for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already explains projectId as a case-sensitive Polarion URL segment with a pointer to getProjects. The description does not need to repeat parameter meanings; collectionId remains terse as 'The Collection ID,' but since the schema covers both parameters, a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Returns the field definitions that apply to one specific Collection.' It also describes the returned content in useful detail (field ID keys, labels, type kinds, enumeration names, custom fields), and it explicitly distinguishes this tool from getProjectFieldsMetadata and getGlobalFieldsMetadata, making sibling selection easy.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use the tool: 'Use it before writing to the Collection to learn which field keys and value types are valid.' It also names alternatives for other scopes: project-wide definitions via getProjectFieldsMetadata and global defaults via getGlobalFieldsMetadata, giving clear when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFieldsMetadataForDocumentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| documentName | Yes | The Branch Document Name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds useful behavioral context beyond that: it returns definitions keyed by field ID, includes custom fields, describes the kinds of types returned, and frames the operation as a prerequisite for writing to a document. This is richer than merely restating the safe read behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core return value, followed by usage context and sibling routing. Every sentence adds distinct information: what is returned, when to use it, and which tools to use instead or next. There is no filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the detailed input schema, available output schema, and annotations covering read-only safety, the description covers what the tool returns, why it should be called, and how it relates to nearby metadata and enum tools. No critical information needed for correct invocation or selection is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with detailed parameter descriptions for projectId, spaceId, and documentName, including case-sensitivity and the `_default` space convention. The description reinforces that this is about 'one specific Document,' but it does not add parameter-level syntax beyond what the schema already documents, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns the field definitions that apply to one specific Document'), explains what is included (label, type kind, custom fields), and differentiates itself from sibling tools like getProjectFieldsMetadata and getGlobalFieldsMetadata by emphasizing 'one specific Document' and 'custom fields configured for its type.' This is precise and not a tautology.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use it ('Use it before writing to the Document') and names the appropriate follow-up tool for enum values (getAvailableEnumOptionsForDocument) as well as alternatives for project-wide and global metadata (getProjectFieldsMetadata, getGlobalFieldsMetadata). It provides clear when/alternative guidance with no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFieldsMetadataForPlanARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The Plan ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry readOnlyHint=true and openWorldHint=true, so the safety profile is established. The description adds value beyond annotations by disclosing the return structure (keyed by field ID, includes custom fields configured for the Plan's type) and the intended role of the data in validating writes. No contradiction with the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: the definition, the when-to-use guidance, and sibling differentiation. The core purpose is front-loaded and the alternatives are introduced only after the primary use case, with zero redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and readOnly/openWorld annotations provided, the description covers what the caller gets, when to call it, and how it differs from the sibling metadata tools. Nothing an agent needs to select and invoke this tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so both parameters are already documented; projectId even includes format, case-sensitivity, and a pointer to getProjects. The description adds broad usage context (learning valid field keys before writing) but no parameter-level detail, so the baseline 3 for high schema coverage is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Returns the field definitions that apply to one specific Plan, keyed by field ID,' and enumerates what the definitions contain (label, type kind, custom fields). 'One specific Plan' clearly separates it from the other getFieldsMetadataFor* siblings, and the named alternatives (getProjectFieldsMetadata, getGlobalFieldsMetadata) reinforce the scope distinction.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use it: 'Use it before writing to the Plan to learn which field keys and value types are valid.' It also names the two alternatives and the exact conditions that select them: project-wide definitions without a concrete instance → getProjectFieldsMetadata, global defaults → getGlobalFieldsMetadata.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFieldsMetadataForTestRecordARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint and openWorldHint, so the safety profile is covered. The description adds behavioral context beyond those annotations by describing the return structure (keyed by field ID, labels, type kinds, custom fields) and the intended use before a write operation. It could mention pagination or error behavior, but the core behavior is transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured: first the return value, then usage guidance, then alternatives. However, the parenthetical "one test case execution within a Test Run iteration" appears verbatim twice, which is slightly redundant. Otherwise every sentence earns its place and the key scoping information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With five required parameters, an output schema present, and read-only annotations, the description covers the essential context: what is returned, when to use it, how it differs from related metadata tools, and the scope of the response. It could add a note about field-definition freshness or error scenarios, but overall an agent can call this tool correctly with the information provided.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% — all five parameters have meaningful descriptions covering project scoping, test run, test case, and iteration. The description adds framing by explaining the composite identity of a Test Record, but it does not substantially expand on individual parameter semantics beyond what the schema already states, so the baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a precise verb and resource: "Returns the field definitions that apply to one specific Test Record" and elaborates with the exact keying by field ID and type kinds. It further differentiates from siblings by naming the project-wide and global alternatives, making the scope unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use the tool: "Use it before writing to the Test Record ... to learn which field keys and value types are valid." It also gives exclusions and alternatives: for project-wide definitions use getProjectFieldsMetadata, and for global defaults use getGlobalFieldsMetadata, leaving no ambiguity about when to choose a different tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFieldsMetadataForTestRunARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint and openWorldHint annotations already establish the read-only, dynamic nature of the operation, so the description does not need to restate safety semantics. It adds useful scoping context ('one specific Test Run', custom fields configured for its type), but does not disclose additional behavioral traits such as authentication, rate limits, or response size; the output schema covers return structure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded, with the core return semantics in the first sentence, usage guidance in the second, and sibling-tool differentiation in the third. No sentence is redundant or wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given two required parameters, full schema coverage, read-only/open-world annotations, and an output schema, this is a complete description. It gives purpose, usage timing, alternatives, and return expectations without requiring the agent to infer missing call context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%: both projectId and testRunId have meaningful descriptions in the schema. The tool description does not add parameter-level meaning beyond the schema, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Returns' with a specific resource: field definitions for one Test Run. It explains the keying structure, label/type-kind coverage, and custom-field inclusion, and the final sentence distinguishes it from getProjectFieldsMetadata and getGlobalFieldsMetadata.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to use this tool before writing to a Test Run to learn valid field keys and value types. It also names the alternatives for project-wide and global-field definitions, giving clear routing guidance among sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getFieldsMetadataForWorkItemARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds behavioral context beyond annotations: it explains the return structure (keyed by field ID, with label and type kind), the inclusion of custom fields configured for the type, and the distinction between primitive/list/structure/enumeration types. It doesn't describe pagination or error behavior, but for a read-only metadata lookup with an output schema present, the description adds meaningful context without contradicting annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, each earning its place: the first defines the return value and scope, the second gives the primary use case, and the third routes to related tools. The most important information (what it returns and for which resource) is front-loaded. No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only metadata lookup with two well-documented parameters, an output schema, and annotations covering read-only/open-world behavior, the description is complete. It tells the agent what the tool returns, when to use it, and which sibling tools to use for enum values, project-wide definitions, and global defaults. Nothing an agent needs to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters thoroughly. The description adds value by clarifying the relationship between the parameters and the returned metadata ('one specific Work Item', 'custom fields configured for its type'), and by warning that workItemId is not the combined 'project/id' path used in some link payloads. This goes beyond the schema's own parameter descriptions, which already explain the project ID and Work Item ID formats.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns'), a specific resource ('field definitions that apply to one specific Work Item'), and the keying/contents ('keyed by field ID: each field's label and type kind...'). It clearly distinguishes itself from sibling tools like getFieldsMetadataForCollection, getFieldsMetadataForPlan, getFieldsMetadataForDocument, getFieldsMetadataForTestRun, getFieldsMetadataForTestRecord, getProjectFieldsMetadata, and getGlobalFieldsMetadata by explicitly naming the alternatives and their scopes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance: 'Use it before writing to the Work Item to learn which field keys and value types are valid.' It also names follow-up and alternative tools: '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.' This is exemplary routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalCustomFieldsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| resourceType | Yes | The Resource Type. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish readOnlyHint and openWorldHint, so the description does not need to repeat safety. It adds a meaningful behavioral/scope trait beyond annotations: the call spans every project and applies no project filter, which prevents a costly mistaken assumption. The output schema covers return structure, so the only minor omission is lack of discussion of response size or pagination, which is not critical here.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tight sentences: the action, the scope caveat, and the routing to the sibling tool. Every sentence earns its place and the key constraint is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given high schema coverage, an output schema, and annotations covering read-only/open-world behavior, the description is complete for tool selection and invocation. It conveys purpose, scope, and the alternative without requiring an agent to open the schema to pick the right endpoint.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3 even with no parameter enrichment in the description. The description echoes resourceType/targetType generically but does not add meaning beyond the schema entries for fields or include.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource ('Returns the defined Custom Fields') and sharply delimits scope: Global context, spanning every project with no project filter. It also names the sibling tool getProjectCustomFields, so an agent can disambiguate immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit guidance is given for when to use this tool (global scope, no project filter) and when to use the alternative instead ('To act on a single project, use getProjectCustomFields instead'). This is the clearest possible when/when-not guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalEnumerationARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| enumName | Yes | The Enumeration Name. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| enumContext | Yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the agent knows this is a safe read operation. The description adds useful behavioral context by specifying the global scope and single-item cardinality, which are not in the annotations. It doesn't discuss errors or auth, but for a read-only get with an output schema, this is sufficient. It does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The primary action and scope are front-loaded, and the alternative routing is stated compactly. Every sentence earns its place, and there is no redundant filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists, return values are covered. The description provides the essential context: scope, cardinality, and sibling differentiation. All parameters are documented in the schema. There is nothing an agent needs to call this tool correctly that is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all five parameters are documented in the input schema. The description adds the context that this targets a global enumeration rather than a project one, which helps interpret enumContext, but the schema already explains allowed values (including '~' for global). The description does not add syntax or format details beyond the schema, so the baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource ('Returns the specified Enumeration from the Global context'), then immediately clarifies scope (global, no project filter) and cardinality (single item by ID). It explicitly differentiates from two sibling tools by name (getProjectEnumeration and getGlobalEnumerations), so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use and when-not-to-use guidance: 'To act on a single project, use getProjectEnumeration instead' and 'For the full collection or a batch, use getGlobalEnumerations instead'. This directly routes the agent to the correct alternative based on context, leaving nothing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalEnumerationsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds useful context about scope (global) and cardinality (batch vs. full collection), which goes beyond what annotations provide. It does not contradict annotations and adds enough behavioral context for a read-only list operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with no wasted words. The first sentence states purpose, the second gives scope and an alternative, and the third gives cardinality and another alternative. It is front-loaded with the core purpose and efficiently routes the agent to the correct sibling tools.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that an output schema exists and annotations cover the safety profile, the description is complete for an agent to call the tool correctly. It covers scope, cardinality, and sibling differentiation. There is no missing information an agent would need, such as prerequisites or response format, because those are handled by the output schema and annotations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with detailed descriptions for fields, page_size_, and page_number_. The tool description does not add any parameter-specific information beyond what the schema already provides, so the baseline score of 3 is appropriate. The mention of 'batch' aligns with pagination parameters but doesn't explain them further.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns a list of Enumerations from the Global context, using a specific verb and resource. It explicitly differentiates from sibling tools by specifying scope (every project) and naming alternatives (getProjectEnumerations for a single project, getGlobalEnumeration for a single item). This makes it unambiguous which tool an agent should select.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit usage context: it targets the global scope, warns that it spans every project, and gives precise alternatives with the conditions for using them. It also mentions cardinality (full collection or batch), covering both when to use this tool and when to use siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalFieldsMetadataARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| targetType | No | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| resourceType | Yes | The Resource Type. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the key behavioral trait that the scope spans every project with no project filter, which is important context beyond the annotations. It doesn't describe return format, but the output schema exists and annotations cover the read-only nature.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The core purpose is front-loaded, and the scoping constraint and alternative are stated efficiently. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only metadata lookup tool with a full output schema and 100% parameter coverage, the description is nearly complete. It clearly states scope and the alternative for single-project use. The only minor gap is not describing what the returned fields look like, but the output schema covers that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters. The description mentions 'resource type and its target type' which maps to the two parameters, but doesn't add meaning beyond what the schema provides. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns fields for a resource type and its target type in the Global context, and explicitly distinguishes it from getProjectFieldsMetadata. The verb 'Returns' plus the resource scope makes the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool (Global context, spanning every project) and when not to (single project, use getProjectFieldsMetadata instead). This is a clear usage guideline with an explicit alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalIconARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| iconId | Yes | The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons). |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the scope (every project) and cardinality (single item by ID), which are behavioral constraints but not deep behavioral details like error behavior, return shape (already via output schema), or side effects. Given the annotations, a 3 is appropriate—it adds context without redundancy.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with zero filler. The core purpose is front-loaded, followed by scope and explicit alternative routing. Every sentence serves a distinct purpose—purpose, scope/sibling differentiation, and collection/alternative. No waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item read tool with an output schema present, the description covers all essential usage context: purpose, scope, cardinality, and explicit alternatives. Nothing an agent needs to select and call this correctly is missing. The optional fields parameter is documented in the schema, and the output schema handles return expectations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so both parameters (iconId and fields) are fully documented in the input schema. The description only mentions the ID concept ('targets a single item by ID') but does not add syntax or format details beyond the schema. Baseline 3 is correct as the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the exact operation: 'Returns the specified Icon from the Global context.' It clearly identifies the resource (Icon), scope (Global), and per-item cardinality, and explicitly contrasts with siblings getProjectIcon (single project) and getGlobalIcons (collection/batch). This leaves no ambiguity about what the tool does and how it differs from similar tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use and when-not-to-use guidance: it declares the global scope, then directs use of getProjectIcon for single-project needs and getGlobalIcons for collections/batches. The reader immediately knows the conditions that select this tool versus its alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalIconsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety and non-mutating nature. The description adds scoping (global vs project) and cardinality (collection/batch) context, but does not describe pagination behavior, default field sets, or other runtime details. Since annotations carry the safety burden, the description's added context is modest but helpful.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with zero redundancy. The core action is stated first, followed by scope and two disambiguating alternatives. Every sentence earns its place and is front-loaded with the most important information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value details are covered. The description covers scope and cardinality, and differentiates from the two most relevant siblings. However, it does not mention getDefaultIcons or getDefaultIcon, which also deal with icons; while not strictly required, naming them would improve completeness. Overall, the essential info is present.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% – all three parameters (fields, page_size_, page_number_) have detailed descriptions. The tool description adds no parameter-specific guidance beyond what the schema already provides, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the operation (returns a list of Icons) and the resource (Global context). It explicitly distinguishes from getProjectIcons (project-scoped) and getGlobalIcon (single item), making the tool's purpose unambiguous even among many siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit when-to-use guidance: use this for global scope and collection/batch operations, use getProjectIcons for single-project scope, and getGlobalIcon for single items by ID. It also notes the cardinality (full collection or batch), leaving no ambiguity about which tool to select.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getGlobalPagesARead-only
Returns a list of all Pages on the Repository level.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already covers the safety profile, so this is a read-only operation. The description adds the repository-level scope, which is useful context, but it does not disclose pagination behavior, result completeness, or any caveats beyond what annotations and schema already convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single clear, front-loaded sentence with no filler. Every word contributes to identifying the tool's purpose and scope, making it highly concise and well structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, output schema, and read-only annotations, the description is largely complete for a simple list endpoint. The main missing context is explicit guidance on when to choose this tool over similarly scoped siblings, but that gap is partly covered by the clear repository-level scope.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all six parameters, including sort, query, fields, include, and pagination. The description adds no parameter-level detail, matching the baseline of 3 for fully covered schemas.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly identifies the verb ('Returns'), the resource ('a list of all Pages'), and the scope ('Repository level'). It is unambiguous about what the tool does, but it does not explicitly differentiate from closely named siblings like getAllPages, getPages, or getRepositorySpacePages, so it falls short of a full 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'on the Repository level' gives a clear usage context, telling an agent this tool is for repository-scoped Pages rather than project- or space-scoped pages. However, it does not name alternatives or provide when-not-to-use guidance, so it lacks the explicit routing of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getJobARead-only
Returns the specified Job. Cardinality: targets a single item by ID. For the full collection or a batch, use getJobs instead.
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true, so the description's emphasis on polling is additional context that helps the agent understand the asynchronous nature. However, it doesn't state potential 'not found' behavior or that repeated calls may be needed; still, the polling hint adds value beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences: first states the core purpose, second provides the alternative. No fluff, and the cardinality note is front-loaded, making it easy to scan. Perfectly concise.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is sufficient for a read operation with a rich schema and output schema. It explains the polling context via jobId. Missing details like error handling or cache behavior, but that's not critical for correct invocation. The presence of output schema reduces the need to describe return values.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers 100% of parameters, so baseline is 3. The description of jobId in the schema explains its origin, and the fields/include parameters have detailed descriptions in the schema. The tool description itself doesn't elaborate on parameters, but the schema is rich, so the description adds minimal but sufficient value. Slightly above baseline because the schema is very clear.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that the tool returns a single Job by ID, which is a specific verb and resource. It also explicitly distinguishes it from getJobs for collection/batch retrieval, making it unambiguous even among many sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a clear alternative (getJobs) for full collection or batch operations, but doesn't elaborate on when to use this versus other related tools like getJobLogContent or getJobResultFileContent. It implies this is for checking status, but could explicitly state not for fetching logs/results.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getJobLogContentARead-only
Downloads the Log content for a specified job.
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true and openWorldHint=true. The description adds minimal behavioral context beyond annotations: it states it downloads log content but doesn't disclose what 'log content' entails, potential errors (e.g., if job not found), or auth requirements. With annotations covering safety as a read operation, the bar is lower; the description provides sufficient basic context but lacks deeper behavioral details.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that is concise and front-loaded with the verb and resource. It avoids redundancy and gets straight to the point. It is appropriately sized for a simple one-parameter GET-like tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has a single parameter, no output schema, and annotations covering safety, the description is fairly complete. It fully explains the return content ('Log content') and purpose. The only missing piece could be mentioning that the job must be completed or the format of the log, but those are not critical for an agent to invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema provides 100% coverage for the single parameter jobId, including a detailed description that explains its origin and how to use it for polling. The tool description adds no additional semantic information about jobId beyond what the schema states. With high schema coverage, baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool downloads log content for a specified job. It uses a specific verb ('Downloads') and resource ('Log content'), which distinguishes it from the sibling tool 'getJobResultFileContent' which likely downloads result files. However, it does not explicitly name the sibling or elaborate on the distinction beyond the description.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage in the context of a job that has completed or produced logs. The schema description for jobId in the input schema adds context about polling getJob for completion. However, there is no explicit statement of when to use this tool versus alternatives like getJobResultFileContent or getJob, nor any exclusions. The context is clear for a job-related download tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getJobResultFileContentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status. | |
| filename | Yes | The Download File Name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds real behavioral value beyond that: the file body is returned as UTF-8 text, plain-text formats are readable, and binary formats (images, PDF, Office) 'arrive garbled' — a genuinely useful caveat an agent cannot infer from the schema. This is clear, non-contradictory enrichment.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with zero waste: purpose, behavioral caveat, precondition, and alternative routing are each given exactly one clause. The critical gotcha (binary garbling) is front-loaded near the top, and the sibling routing is saved for the end as a natural pointer. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description correctly carries the burden of describing the return value ('returned as UTF-8 text... binary files arrive garbled'), so an agent knows what response shape to expect. It also covers the invocation contract (finished job, filename source, log alternative). Only minor edge cases like error behavior or size limits are left out, which are not essential for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters (jobId's polling flow and filename's Download File Name role). The description adds modest value by pointing out that the job resource lists the available file names, which hints at how to populate filename, but it does not go beyond that baseline meaningfully.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource pair ('Downloads one result file produced by a finished asynchronous job') and names a concrete example (the spreadsheet from getExportExcelTests). It explicitly distinguishes itself from getJobLogContent, telling the agent exactly which sibling handles the log case instead.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit preconditions are given: 'Call it only after getJob reports the job as finished' and 'the job resource lists the available file names' tells the agent where to source the filename. It also names the alternative for logs ('use getJobLogContent'), so an agent receives both when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getJobsARead-only
Returns the list of Jobs. Cardinality: targets the full collection or a batch. For a single item by ID, use getJob instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| projectId | No | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint: true` and `openWorldHint: true`, so the description's 'Returns the list of Jobs' adds little safety context. However, the cardinality note ('full collection or a batch') is a behavioral nuance not covered by annotations, providing some added value. No contradictions or missing side-effect warnings.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is only two sentences, with the primary purpose stated first and the alternative routing second. There is zero fluff; every word adds value. This is a model of concise front-loaded writing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema is present, so return values are documented externally. The schema fully covers the 5 optional parameters. The description covers the purpose, cardinality, and the key alternative. It omits only peripheral context like authentication/authz, which is typical for these tools. This is complete enough for a read-only list operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so every parameter (fields, include, projectId, page_size_, page_number_) already carries a detailed description. The tool description adds no parameter-specific insights, so a baseline of 3 is appropriate given the high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool 'Returns the list of Jobs' with an explicit cardinality note ('full collection or a batch') and immediately distinguishes it from the sibling `getJob` for single-item fetches. This makes the purpose unambiguous and well-differentiated from the large set of sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly tells the agent when NOT to use this tool ('For a single item by ID, use `getJob` instead.'), which is a clear exclusion. While it doesn't mention every alternative, for the primary decision (collection vs. single) it gives direct guidance. The presence of sibling `getJob` reinforces the clarity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLicenseARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, which covers the read-only/no-side-effects profile. The description adds the contextual behavior of returning capacity-vs-limit numbers and links, which helps the agent anticipate the response shape. It doesn't contradict annotations, and for a simple read-only lookup the description plus annotations are sufficient; it doesn't go into depth about pagination or error conditions, but that's not a major gap for this kind of tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, all meaningful: the first gives the payload, the second gives the primary use case, the third routes to the two sibling tools. Every sentence earns its place and the critical capacity-checking purpose is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only, zero-required-parameter tool with a full schema and output schema, the description is complete. It explains the kind of data returned, the use case, and how it differs from the two closest license siblings. Nothing needed for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents both parameters (fields and include). The description doesn't need to repeat them; it doesn't add much parameter-level detail beyond the schema, but the baseline is 3 when the schema is complete. It does briefly reinforce that omitting fields returns the default set, which is a small bonus.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific resource ('server-wide license limits') and the data it returns (current count vs. maximum for Work Items, Documents/Pages, projects, plus links to default license slots). It clearly distinguishes itself from the sibling tools getLicenseAssignments and getLicenseSlots, which is exactly what an agent needs to pick it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use it: 'to check remaining capacity before bulk-creating items or projects.' It also names two alternatives and their use: getLicenseAssignments for who holds which license, getLicenseSlots for slot details. This gives the agent both a positive trigger and exclusion conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLicenseAssignmentsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| activeOnly | No | If set to true, only active (with status LOGGED_IN or EXPIRING) License Assignments will be returned, otherwise all the License Assignments will be returned. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds value beyond that by disclosing the cloud-environment unavailability and the cardinality behavior (full collection vs. batch), which are genuine behavioral traits. It does not address response shape or pagination defaults, but the presence of an output schema partially covers return-value expectations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, roughly 30 words, with purpose front-loaded and every sentence earning its place: purpose, environment limitation, cardinality, and sibling routing. Minor deduct for the jargon-y 'Cardinality:' framing and the awkward parenthetical run ('Polarion X.).'), but there is no waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich annotations, fully documented schema, and existing output schema, the description covers the critical context: the read-only nature, the cloud limitation, the cardinality scope, and the sibling distinction. The main gap is that 'batch' is never tied to a specific parameter (e.g., how an agent requests a batch vs. the full collection), which is slightly ambiguous even though the pagination params are documented.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema fully documents all five parameters (fields, include, activeOnly, page_size_, page_number_) with detailed descriptions. The description adds no parameter-specific meaning beyond what the schema provides, so the baseline of 3 applies. The 'full collection or a batch' phrasing loosely maps to pagination parameters but doesn't clarify how a batch is requested.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns a list of License Assignments') and differentiates itself from its sibling `getLicenseAssignmentsForUser` by explicitly noting that tool handles single-item-by-ID lookups. The cardinality note ('full collection or a batch') further pins down the scope, so an agent can distinguish this from the many license-related siblings without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: use `getLicenseAssignmentsForUser` instead for a single item by ID. It also discloses a hard environmental exclusion ('Not supported by cloud-based Polarion X.'), which prevents an agent from attempting this call in unsupported contexts. This is clear when-to-use and when-not-to-use guidance with a named alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLicenseAssignmentsForUserARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| userId | Yes | ||
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering safety and world assumptions. The description adds valuable behavior beyond annotations: the cloud incompatibility and the cardinality (single item by ID). These are not captured in the annotations or schema, so the description enriches the agent's understanding.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each carrying essential information: purpose, limitation, and alternative. No filler or redundancy. The most critical scoping (single item) is front-loaded, and the alternative is given explicitly. Perfectly sized for a quick agent read.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, return structure is covered. The description handles purpose, cardinality, platform restriction, and routing to the sibling tool. It doesn't mention error handling, but that is not expected for a read-only get. Overall, nothing critical is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 67% (fields and include are documented). The description compensates for the undocumented 'userId' by stating 'targets a single item by ID', clarifying that userId is the identifier. This adds meaning beyond the raw schema, and the other two parameters are already well described.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Returns' and the resource 'specified License Assignment', and further clarifies cardinality as a single item by ID. It explicitly distinguishes itself from the sibling tool getLicenseAssignments, which handles collections/batches, so an agent can immediately tell which tool fits the need.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides explicit guidance on when not to use this tool: for the full collection or a batch, use getLicenseAssignments instead. It also discloses a critical platform limitation (not supported by cloud-based Polarion X), which is essential for selecting the correct tool in cloud environments.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLicenseSlotARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| group | Yes | ||
| model | Yes | ||
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| typeId | Yes | ||
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the description does not need to restate that it is a safe read operation. The description adds useful context about cloud support and cardinality, but does not disclose details about authentication, response structure beyond the output schema, or any other operational behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three concise sentences, with the core action front-loaded, the caveat right after, and the sibling routing at the end. No filler or redundant restatement of the tool name.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with five parameters, three required and undocumented, plus nested objects, the description is too thin to enable correct invocation. It handles high-level selection well, but an agent still lacks enough information about how to construct the required identifiers.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is only 40%, and the three required parameters (typeId, model, group) have no descriptions. The description says 'targets a single item by ID' but does not explain how those required parameters identify the slot or map to an ID, so it fails to compensate for the schema gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Returns the specified License Slot.' It also clarifies cardinality ('targets a single item by ID') and distinguishes itself from the plural sibling getLicenseSlots. This makes the tool's purpose clear and non-confusable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent when not to use this tool: 'For the full collection or a batch, use getLicenseSlots instead.' It also adds an environmental caveat ('Not supported by cloud-based Polarion X.'), giving clear usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLicenseSlotsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| typeId | Yes | ||
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the description doesn't need to restate safety. It adds the behavioral constraint about cloud-based Polarion X not being supported and clarifies the cardinality. This adds useful context beyond the annotations, though it doesn't describe return format or error handling—acceptable given the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, with the core purpose first, followed by a limitation and an explicit alternative. No unnecessary words—every sentence earns its place. The structure is well front-loaded with the key information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the 6 parameters, nested objects, and presence of an output schema, the description adequately covers the essential context: purpose, cardinality, platform limitation, and alternative. Pagination details are handled by the schema, and return values are defined by the output schema. It does not mention prerequisites or error conditions, but for a read-only operation with strong annotations, this is sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema descriptions cover 83% of parameters (fields, include, revision, page_size_, page_number_ all have descriptions; typeId lacks one). The description does not add parameter-specific meaning beyond what the schema already provides, but the cardinality note ('full collection or a batch') indirectly relates to pagination parameters. This meets the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Returns' and the resource 'available License Slots', and it distinguishes itself from the sibling getLicenseSlot by explicitly noting cardinality (full collection/batch) versus single item by ID. This makes the tool's purpose unambiguous and differentiates it from similar tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly provides usage guidance: it targets the full collection or a batch, and for a single item by ID, it directs the agent to use getLicenseSlot instead. It also notes the platform limitation (not supported by cloud-based Polarion X), giving a clear condition for when not to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLinkedWorkItemARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| roleId | Yes | The Role ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| targetProjectId | Yes | The Target Project ID. | |
| linkedWorkItemId | Yes | The Linked Work Item ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true, covering the read-only nature. The description adds behavioral detail: it explicitly states the tool does not pertain to external links or backlinks, and clarifies that it targets a single item by ID. But it does not describe the return format or any error conditions, and those are likely in the output schema. Given annotations, the description adds modest value.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, all essential: first states the core function, second excludes other link types, third distinguishes from the batch sibling. No filler, and the most critical info is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that the output schema exists (as indicated by context signals) and the annotations provide safety hints, the description is sufficient for an agent to know what the tool does and when to use it. It covers the key distinction from the sibling tool, but could mention whether the link is directional or any constraints on the role/target project, though those are likely in parameter descriptions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100%, meaning every parameter is already documented in the input schema. The description does not add new parameter meanings beyond stating the cardinality (single item by ID), which is already implied by the parameter list. Baseline of 3 is appropriate as the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns direct outgoing links'), a specific resource ('Work Items'), and explicitly excludes external links and backlinks. It also distinguishes from the sibling `getLinkedWorkItems` by clarifying cardinality (single item vs. collection), matching the tool's name and purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly states when to use this tool (for a single linked work item) and when to use the alternative (`getLinkedWorkItems` for the full collection or batch). However, it does not explicitly mention when to use related tools like `getBacklinkedWorkItems` or `getExternallyLinkedWorkItem`, though the exclusion of backlinks/external links implies their alternative use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLinkedWorkItemsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark this as read-only and open-world, so the safety profile is covered. The description adds useful behavioral context: the scope of returned data (direct outgoing links only, no backlinks/external links) and cardinality (full collection or batch). This goes beyond the annotation hints, though it withholds deeper details like default page size or empty-result behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: the core function, the scope exclusions, and the routing to the singular alternative. A model of compact, front-loaded documentation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a read-only annotation, an output schema, and 100% schema coverage for parameters, the description's job is mostly routed to structured fields. The description covers scope and exclusions well. Missing is a brief note on default batch size or maximum results, but the completeness is solid overall.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all 7 parameters. The description adds little parameter-specific meaning; it only hints at cardinality/pagination and IDs. This meets the baseline for fully-documented schemas but doesn't elevate it further.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description identifies a specific verb and resource: 'Returns the direct outgoing links to other Work Items.' It clearly distinguishes the tool from related ones by excluding external links and backlinks, and it names the singular sibling getLinkedWorkItem. An agent can tell exactly what this tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides an explicit exclusion ('Does not pertain to external links or backlinks') and an explicit routing to getLinkedWorkItem for single-item lookups. However, it doesn't name the specific sibling tools that handle backlinks (getBacklinkedWorkItems) or external links (getExternallyLinkedWorkItems), leaving the agent to infer those alternatives from the sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getLlmsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already covers the safety profile, and the description adds meaningful context beyond that: the tool is paginated, returns only configured models, and an empty result signals that AI features are unavailable. This goes beyond a bare 'list models' statement while not over-describing.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with no filler. The core purpose is front-loaded, and the usage guidance is delivered immediately after, each sentence earning its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only list operation with no required parameters, an output schema present, and readOnlyHint/openWorldHint annotations, the description is complete. It covers what is returned, how results are paginated, and what an empty result means for downstream AI actions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameters `page_size_` and `page_number_` are already fully documented. The description only mentions pagination generically and adds no new parameter-level meaning, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns'), a specific resource (Large Language Models configured on this Polarion server), and the exact output fields (ID and name). It also distinguishes itself from the related sibling `generateCompletion` by positioning itself as the prerequisite lookup, so an agent can tell what it does and what it is not.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells the agent when to use this tool: before `generateCompletion`, to pick a valid model. It also explains the consequence of an empty list (no LLM configured and AI actions will fail), which gives clear decision-making context even without naming an alternative tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getMetadataARead-only
Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover readOnlyHint and openWorldHint, so the safety profile is established. The description adds a useful access detail ('Available to all REST API users'), but otherwise does not disclose additional behavioral traits such as response size, pagination, or side effects. With annotations present, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and front-loaded with the core purpose, followed by a useful access note. The only minor flaw is the vague 'etc.', which slightly reduces precision, but overall the description is efficient and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that annotations cover safety, the input schema fully documents parameters, and an output schema exists, the description does not need to explain return values or parameter mechanics. It provides enough context about the tool's scope and accessibility for an agent to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema provides detailed descriptions for both fields and include. The tool description itself adds no parameter-level meaning, but it is not required to compensate because the schema already carries that burden. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource: 'Returns global metadata' and gives concrete content examples such as version, build, and REST API configuration properties. These examples clearly distinguish it from similar sibling getters like getGlobalFieldsMetadata or getGlobalEnumerations, which target narrower metadata domains.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no guidance about when to prefer this tool over alternatives. It does not mention related siblings such as getGlobalFieldsMetadata or getGlobalEnumerations, nor does it state any selection criteria beyond the tautological need for global metadata. 'Available to all REST API users' is an access note, not a usage-vs-alternative guideline.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getOslcResourcesARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already communicates that this is a safe read operation, and the description adds useful behavioral context beyond that: it clarifies that the result contains cross-tool OSLC artifacts with URI, label, and link role. This goes beyond simple annotation repetition and explains the nature of the returned links.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact: two sentences front-load the core purpose and return contents, then immediately provide the exclusionary guidance for sibling tools. Every sentence earns its place with no redundant wording.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only, 9-parameter tool with a full output schema and complete schema descriptions, the description provides the missing semantic context: what OSLC resources are, what the response contains, and which alternative tools cover related but different cases. An agent has enough to select and call the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage for all 9 parameters, so the schema already carries the documentation burden. The tool description does not add parameter-level detail, which is acceptable but not value-adding beyond the structured schema; baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Returns') with a precise resource ('OSLC resources linked to one Work Item') and elaborates with concrete examples and return fields (URI, label, link role). It also distinguishes itself from the sibling tools getLinkedWorkItems and getExternallyLinkedWorkItems, so an agent can reliably tell them apart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool ('Use it to trace cross-tool links') and when not to, naming the alternative tools for Work Item links in Polarion. This gives clear selection guidance without requiring schema or sibling-tool inspection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageARead-only
Returns the specified Page. Cardinality: targets a single item by ID. For the full collection or a batch, use getSpacePages instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the read-only safety profile is covered. The description adds useful behavioral context about single-item cardinality, but it does not disclose potential error conditions, revision behavior, or response variability beyond what the schema and annotations imply. It is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two brief sentences with no filler. The core behavior and cardinality are front-loaded, and the alternative tool is mentioned only after the main purpose is established. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The combination of a detailed input schema (100% parameter coverage), a readOnlyHint, an openWorldHint, and an output schema covers what an agent needs to invoke this correctly. The description's single-item cardinality and sibling routing fill the main semantic gap beyond the structured metadata.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all six parameters, including nested fields and the meaning of pageName, spaceId, and revision. The description itself adds no parameter-level information, which is acceptable given the high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns the specified Page') and clarifies the cardinality ('targets a single item by ID'), which distinguishes it from collection-style siblings. It also names getSpacePages as the alternative, so an agent can tell this tool apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly defines when to use this tool (single item by ID) and when not to ('For the full collection or a batch, use getSpacePages instead'). This is direct, actionable routing guidance that leaves little to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageAttachmentARead-only
Returns the specified Page Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getPageAttachments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds useful behavioral context by clarifying that this targets a single item by ID and that a batch alternative exists. Auth details and failure modes are not described, but they are not essential for a read-only single-resource getter with an output schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short, purposeful sentences: the first names the operationhare, the second pins cardinality and disambiguates from the plural sibling. No filler or redundant wording.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a fully documented input schemaại, an output schema, and annotations covering read-only safety, the description provides enough context for correct selection and invocation. The only missing details, such as exact parameter syntax and return shape, are already supplied by the schema and output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage, so all parameters are already documented at the schema level. The description adds no parameter-specific meaning beyond saying the item is targeted 'by ID', so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Returns the specified Page Attachment') and explicitly fixes cardinality to a single item by IDetermined. This clearly distinguishes it from the plural sibling getPageAttachments without needing to inspect the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Directly tells the agent when to use this tool versus an alternative: for the full collection or a batch, use getPageAttachments instead. This explicit routing is exactly what an agent needs to select the correct tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageAttachmentContentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true and openWorldHint=true, so the description is not burdened with establishing read-only safety. It adds valuable behavioral detail beyond annotations: the file body is returned as UTF-8 text, plain-text formats are readable, and binary formats arrive garbled. This gives the agent realistic expectations about output quality.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with no filler. The core action is stated first, the critical encoding limitation follows, and the routing guidance to sibling tools closes it. Every sentence earns its place and the structure is easy to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description compensates by explaining the return format and its limitations. It also covers how to obtain both metadata and attachment IDs, which are the obvious prerequisite lookup steps. For a read-only download tool with five well-documented parameters, nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters including projectId, spaceId, pageName, attachmentId, and revision. The description adds only modest value by explaining the attachmentId origin indirectly via getPageAttachments, but it does not need to because the schema is complete.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Downloads the raw file content') and names the exact resource ('one Rich Page attachment'). It clearly distinguishes itself from sibling tools by contrasting with getPageAttachment for metadata and getPageAttachments for discovering IDs, so an agent can disambiguate at a glance.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool ('only when you need the file's bytes') and names the alternatives with their purposes (getPageAttachment for metadata, getPageAttachments for attachment IDs). It also warns about binary-file limitations, which helps the agent decide whether this tool is appropriate for the task.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageAttachmentsARead-only
Returns a list of Page Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getPageAttachment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the description doesn't need to state safety. It adds the cardinality behavior ('full collection or a batch') and the alternative routing. It doesn't discuss pagination or response format, but given the annotation coverage and simple listing purpose, a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero redundancy. The primary purpose is stated first, followed by a clear routing hint. No wasted words, and the structure is ideal for an agent scanning descriptions.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is a straightforward listing operation with an output schema present. The description covers the essential information: what it returns, the cardinality, and the single-item alternative. Pagination and required params are documented in the schema, so the description is complete enough for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds no parameter-level guidance beyond what the schema already provides. It neither improves nor detracts from parameter understanding.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb ('Returns'), the exact resource ('Page Attachments'), and explicitly distinguishes itself from the singular `getPageAttachment` for single-item fetches. This fully disambiguates the tool from its siblings in the same domain.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly directs users to `getPageAttachment` for single items, which is a clear when-not to use this tool. It also indicates the cardinality (full collection or batch). However, it doesn't mention when to use it over other attachment tools (e.g., document or work item attachments), though the name makes the context obvious.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageCommentARead-only
Returns the specified Page Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getPageComments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark the operation as read-only, so the description's main behavioral addition is the cardinality constraint and the batch alternative. It does not describe edge-case behavior or response details, but the output schema covers the return shape. This is adequate but not rich disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences; the core action is front-loaded and the sibling routing is in the second sentence. No filler or repetition that undermines clarity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item read tool, the description plus the rich input schema and output schema cover the selection and invocation needs. The only possible gap is more nuanced guidance around optional revisions or sparse fields, but those are already well documented in the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema carries the parameter documentation. The description only points to 'by ID', which reinforces `commentId` but adds no format or usage detail beyond the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Returns the specified Page Comment', naming the verb and resource, then clarifies cardinality ('targets a single item by ID'). It explicitly differentiates from the sibling `getPageComments` ('full collection or a batch'), so an agent can disambiguate immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states the single-item scope and gives an explicit exclusion: 'For the full collection or a batch, use `getPageComments` instead.' This effectively tells the agent when this tool is appropriate and which sibling to choose otherwise.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageCommentsARead-only
Returns a list of Page Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getPageComment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, covering the safety profile. The description adds a meaningful behavioral detail—cardinality (full collection or batch)—which is not visible elsewhere. It stops short of describing pagination behavior or ordering, but those are not critical for a read-only list endpoint.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, both earning their place: the first states the action and resource, the second clarifies cardinality and routes single-item requests to the correct sibling. No filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a read-only annotation, a fully documented 8-parameter schema, and an output schema present, the description provides the essential scope information and sibling routing. A slightly richer pointer distinguishing Page Comments from Document Comments or general Comments would improve it, but the current definition is functional for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers 100% of parameters with detailed descriptions, so the schema carries the parameter-semantics burden. The tool description adds no additional parameter-level meaning beyond the sibling pointer, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Returns') and resource ('Page Comments'), and immediately clarifies cardinality: full collection or a batch. It explicitly distinguishes this tool from getPageComment, so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives an explicit when-not-to-use signal: for a single item by ID, use getPageComment instead. However, it does not address broader sibling alternatives such as getDocumentComments or getComments, so the usage guidance is useful but incomplete.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPageRelationshipsARead-only
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).
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, and the description adds useful behavioral context: it returns only linkage identifiers rather than full related resources, it is a cheap inspection, and it operates on a single named relationship. It does not cover every edge behavior, but it meaningfully augments the annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: it opens with the core behavior and output format, then clarifies the key parameter ambiguity, and closes with usage routing. Every sentence earns its place and no filler is present.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given 9 parameters with full schema descriptions and an output schema, the tool description covers what an agent needs to select and invoke it correctly: purpose, output semantics, parameter caveat, and alternatives. Pagination and field filtering are already documented in the input schema, so the description is adequately complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description's clarification that `relationshipId` is the relationship's name, not an entry ID, is helpful but the schema already states the same thing explicitly. No additional parameter meaning is added beyond what the input schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns'), resource ('one Rich Page'), and precise output shape ('JSON:API linkage (`{type, id}` entries) without the related resources' attributes'). It also distinguishes itself from getPage and the relationship-mutating siblings by naming them explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use guidance ('inspect one relationship cheaply') and contrasts with the alternative ('call its get tool with `include` instead'). It even names the exact mutating tools for add, replace, and remove operations, leaving no ambiguity about when to choose this getter.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPagesARead-only
Returns a list of Pages from the Project context. Scope: one project (requires a project ID). To act across all projects, use getAllPages instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint and openWorldHint, covering the safety profile. The description adds project-scoping context, but it does not mention pagination behavior, default field sets, or any other runtime trait beyond what the schema and annotations already convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three short sentences with the core behavior and scope front-loaded, followed by the sibling routing. There is no filler or redundant restatement.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-project list endpoint, the description, combined with the rich input schema, output schema, and read-only annotations, is sufficient. The agent knows the required input, the scope, the safe-read nature, and the alternative for cross-project queries.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all eight parameters are already documented in the input schema. The description only restates that `projectId` is required, which the schema already marks as required; it adds no new parameter-level meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns a list of Pages') and a clear scope ('from the Project context', 'one project'). It also distinguishes the tool from the cross-project sibling (`getAllPages`), so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says this tool is for one-project scope and requires a project ID. It also gives a clear when-not rule: 'To act across all projects, use getAllPages instead.' This is direct, actionable routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPlanARead-only
Returns the specified Plan. Cardinality: targets a single item by ID. For the full collection or a batch, use getPlans instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| planId | Yes | The Plan ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true. The description adds the 'single item by ID' limiting scope, which is useful. But it doesn't specify return format or error conditions, though output schema exists. No contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The primary purpose and cardinality are front-loaded, and the alternative is clearly stated. Ideal structure for quick agent parsing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple get-by-ID tool with rich output schema and strong annotations, the description is mostly complete. Could add a note about required fields or error handling, but the schema already covers required fields. Minor gap: no mention of revision or include usage, but those are optional and self-documenting.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all parameters. The description does not add extra parameter details beyond what's in the schema, but it correctly implies the need for both projectId and planId to target a single item. Baseline 3 applicable.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it returns a single Plan by ID, using specific verbs and resource. It explicitly distinguishes itself from getPlans for collection/batch operations, which is critical given the sibling tool list.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool (single item by ID) versus when to use getPlans for full collection/batch. However, it doesn't mention when not to use it for related resource embedding, but the schema covers that via include parameter.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPlanRelationshipARead-only
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).
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| planId | Yes | The Plan ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already convey readOnlyHint and openWorldHint, so the description does not need to restate safety. It adds meaningful behavioral context beyond annotations: the response contains only linkage (`{type, id}` entries) and omits related resource attributes, and `relationshipId` is a relationship name rather than an entry ID. This helps prevent misuse.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: the first states the result and format, the second disambiguates the key parameter, and the third gives usage and alternative routing. The most important information is front-loaded and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists and annotations cover the safety profile, the description provides the missing conceptual context: what a relationship response contains, how `relationshipId` should be interpreted, and when to use sibling tools. Nothing needed for correct selection or invocation is absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description reinforces the meaning of `relationshipId` in plain language, but the schema already says it is the relationship's name, not an individual link entry ID. It does not add substantial new meaning for the other parameters beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: it returns the resource identifiers linked from one Plan through a single named relationship, and specifies JSON:API linkage format. It also distinguishes itself from getPlan and the relationship-mutation siblings, so an agent can tell this tool apart without inspecting the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states the intended use case: 'inspect one relationship cheaply'. It names alternatives and the conditions for choosing them: use getPlan with `include` for embedded resources, and use postPlanRelationships, patchPlanRelationships, or deletePlanRelationship for changes. This is clear routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getPlansARead-only
Returns a list of Plans. Cardinality: targets the full collection or a batch. For a single item by ID, use getPlan instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| templates | No | If true, only return template resources; if false or omitted, return only actual (non-template) instances. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds useful behavioral context: the collection-or-batch cardinality and the exclusion of single-item lookup. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences with zero filler. The primary purpose is front-loaded, and the cardinality and sibling-routing sentences each earn their place. Nothing extraneous is included.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a 100%-covered schema, an output schema, and readOnly/openWorld annotations, the description only needs to handle scope and routing, which it does well. The only gap is not elaborating on what Plans are or the implications of the open-world hint, but these are minor against the rich structured data.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so every parameter is thoroughly documented in the schema itself, which is the baseline-3 case. The description adds no parameter-specific detail beyond hinting at cardinality, but none is needed given the thorough schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource ('Returns a list of Plans') and explicitly names the sibling it is not ('use getPlan instead'). The cardinality note ('targets the full collection or a batch') further pins down the scope. An agent can distinguish this from getPlan without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Names the alternative (getPlan) explicitly and the condition that selects it (single item by ID). The cardinality statement reinforces when this tool is appropriate versus single-item access. Clear routing guidance is provided upfront.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectARead-only
Returns the specified Project. Cardinality: targets a single item by ID. For the full collection or a batch, use getProjects instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the cardinality constraint (targets a single item by ID), which is useful behavioral context beyond the schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler; the core purpose and key differentiator are stated immediately. 'Cardinality: targets a single item by ID' is an efficient, informative addition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is a simple single-item read with output schema, annotations, and complete parameter descriptions; the description correctly identifies scope and the sibling alternative. Nothing needed by an agent to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and every parameter already has a descriptive schema entry (fields, include, revision, projectId). The description adds no parameter-level explanation, so it does not go beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States that it returns a specific Project and explicitly distinguishes itself from getProjects for collection/batch queries. The single-item cardinality is front and center, so an agent can tell it apart without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the alternative (getProjects) for the full collection or batch case, giving an unambiguous when-not-to-use rule. No other exclusion is needed for this single-item read tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectCustomFieldsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| resourceType | Yes | The Resource Type. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds context beyond the annotations: it highlights the project-scoping requirement and directs to the global alternative. While annotations already declare readOnlyHint=true, the description's explicit scope constraint and sibling reference provide useful behavioral context that the annotations alone do not cover.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The primary purpose is stated first, followed by the scope constraint and the alternative. Every sentence earns its place and the structure is clean and front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, annotations covering the read-only/open-world behavior, and 100% parameter descriptions, the description only needs to clarify the distinguishing project scope and the sibling alternative. It does exactly that, making it complete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema fully documents all five parameters. The description adds little parameter-level meaning beyond echoing 'resource type and target type' and noting the project ID requirement, which is already in the schema. A baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns the defined Custom Fields') and the context ('for the resource type and target type in the Project context'). It explicitly differentiates from the sibling getGlobalCustomFields, making the tool's purpose unambiguous and immediately distinguishable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states the scope ('one project (requires a project ID)') and names the alternative for cross-project scenarios ('use getGlobalCustomFields instead'). This gives clear when-to-use and when-not-to-use guidance, leaving nothing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectEnumerationARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| enumName | Yes | The Enumeration Name. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| enumContext | Yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish readOnlyHint=true and openWorldHint=true, so the description is not burdened with safety disclosure. It adds scoping context (requires a project ID) and singular cardinality, which is helpful, but it does not disclose return format, pagination, or other behavioral details. With annotations carrying the safety profile, this is adequate but not especially rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence earns its place: it states what the tool returns, its scope, its cardinality, and the two key sibling alternatives. The text is compact, front-loaded, and free of filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, the presence of an output schema, and read-only annotations, the description covers what an agent needs to select and invoke this tool correctly. It clearly distinguishes the tool from collection-level and global-level siblings, while the schema handles parameter-level detail. Minor gaps remain only around response behavior, but the output schema mitigates that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all six parameters are already documented. The description reinforces that projectId is needed for scoping but does not meaningfully explain parameter semantics beyond what the schema provides. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action ('Returns the specified Enumeration') and a specific scope ('Project context'). It also explicitly differentiates this tool from getGlobalEnumeration and getProjectEnumerations, so an agent can distinguish it from closely related siblings without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: use getGlobalEnumeration for cross-project access and getProjectEnumerations for full collection or batch operations. This directly tells the agent when to use this tool versus the most likely alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectEnumerationsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true, so the read-only nature is covered. The description adds scoping (one project) and cardinality (full collection or batch), which are useful behavioral details beyond the annotations. It does not contradict annotations and adds meaningful context, though it stops short of disclosing error conditions or rate limits, which are not expected here.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: the main purpose, the scope requirement, and two explicit alternatives. The most critical info (what it returns) is front-loaded, and there is zero waste.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and parameters fully documented, the description covers the essentials: scope, cardinality, and alternatives. It doesn't need to explain return values. It could mention the meaning of 'batch' more explicitly, but for a list operation this is sufficient for an agent to decide and invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are well-documented in the schema. The description mentions 'requires a project ID' but that is already in the schema. It adds no extra semantics beyond what the schema provides, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states what the tool does: returns a list of Enumerations from the Project context. It also distinguishes itself from getGlobalEnumerations (across all projects) and getProjectEnumeration (single item), making it unambiguous which sibling it complements.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use this tool vs alternatives: 'To act across all projects, use getGlobalEnumerations instead' and 'For a single item by ID, use getProjectEnumeration instead.' Also notes the requirement of a project ID, giving clear context for invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectFieldsMetadataARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | No | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| resourceType | Yes | The Resource Type. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the description need not repeat safety. The description adds the project-scoping constraint, which is also encoded in the parameter descriptions. It does not disclose additional behaviors like pagination or error conditions, but for a simple read-only getter with an output schema, this is adequate. The description adds minimal value beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the core purpose and immediately followed by the scoping constraint and alternative. Every word earns its place; there is no redundancy or fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists, return value details are not needed. The description covers what the tool does, the required scope, and the alternative for global use. It is complete for a simple read-only metadata getter, with no missing information that would prevent correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers 100% of parameters, providing detailed descriptions for projectId and targetType, but resourceType is only described as 'The Resource Type.' The description clarifies that both resourceType and targetType are used to select the fields, giving semantic context beyond the schema. It does not fully explain targetType's role, but the schema's example and the description's mention of 'target type' add meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and a clear resource ('fields for the resource type and its target type') scoped to a Project context. It also explicitly contrasts with the global sibling, making it easy for an agent to distinguish from getGlobalFieldsMetadata and other metadata tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance: 'Scope: one project (requires a project ID)' and directly names the alternative for cross-project use ('use getGlobalFieldsMetadata instead'). This clearly indicates when to use this tool versus the global variant, leaving no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectIconARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| iconId | Yes | The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint true. The description adds useful behavioral context beyond those annotations by specifying project scoping, requiring a project ID, and clarifying the single-item cardinality, which helps the agent predict the tool's boundaries.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact, front-loaded with the core purpose, and every sentence earns its place by either stating scope or routing to alternatives. There is no redundant or filler content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the read-only annotation, full schema coverage, and presence of an output schema, the description is sufficiently complete. It tells the agent what the tool does, when to use it, and how it differs from closely related siblings, leaving no critical gap for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds extra semantic meaning by connecting projectId to project scoping and iconId to the single-item cardinality, which reinforces the schema's purpose and helps the agent interpret the parameters correctly.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the specific verb 'Returns', the resource ('the specified Icon'), and the scope ('from the Project context'). It clearly distinguishes this tool from siblings by emphasizing single-item cardinality and project scope.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names alternatives: 'getGlobalIcon' for cross-project access and 'getProjectIcons' for the full collection or batch operations. This gives an agent clear decision criteria for selecting this tool over related siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectIconsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, setting a safe-read baseline. The description adds useful behavioral context by noting the cardinality ('targets the full collection or a batch') and by reinforcing the project scoping, which goes beyond what annotations alone convey. It does not contradict any annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three short sentences with no filler. It front-loads the core purpose, then immediately provides scoping and differentiation cues, making the most relevant information immediately visible.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a list-returning tool with an output schema and fully documented parameters, the description is complete. It addresses scope, cardinality, and sibling alternatives, and the pagination details are already covered in the schema. Nothing an agent needs to make a correct call is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers 100% of the parameters with detailed descriptions, so the baseline is 3. The description adds only a general mention that a project ID is required, which is already explicit in both the schema's required array and the projectId description. It does not compensate further, but it doesn't need to given the high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns a list') and resource ('Icons from the Project context'), clearly identifying the scope. It explicitly differentiates from getGlobalIcons (across all projects) and getProjectIcon (single item by ID), so an agent can select it correctly without ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: use getGlobalIcons when acting across all projects, and getProjectIcon for a single item by ID. It also states that projectId is required and scopes the request to one project, effectively indicating the prerequisite for calling this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectsARead-only
Returns a list of Projects. Cardinality: targets the full collection or a batch. For a single item by ID, use getProject instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations include readOnlyHint=true and openWorldHint=true, which the description implicitly supports by stating it returns a list. The description adds the cardinality detail (full collection or batch) but doesn't elaborate on pagination or potential large result sets, relying on annotations and schema for that.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single sentence that packs the essential information: what it does, its scope (full collection/batch), and the alternative for single items. No wasted words, front-loaded with the primary action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema and high schema coverage, the description is sufficient. It covers the purpose and usage distinction; combined with the schema, an agent has enough to call this correctly. Missing only deeper behavioral notes like default sort, but that's minor.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so parameters are well-documented. The description itself doesn't add much beyond noting the collection/batch scope, but it does clarify that the tool targets the full collection or batch, which is helpful. Since the schema covers everything, baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it returns a list of Projects, specifies the cardinality (collection or batch), and distinguishes itself from getProject for single-item retrieval. This makes the tool's purpose unambiguous and differentiates it from siblings like getCollections.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to use getProject for a single item, providing clear context for when to use this tool. However, it doesn't mention alternatives for related operations like getting collections or work items, though that may not be necessary for a list tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectTemplatesARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds useful behavioral detail: results are paginated and include specific template attributes. This goes beyond the annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no filler. The main purpose is front-loaded, and the usage instruction is direct and actionable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only paginated lookup with a rich output schema and fully documented parameters, the description supplies the missing usage context: call it before createProject to obtain a valid templateId. Nothing essential is omitted.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage and thoroughly documents all four parameters, including examples and pagination guidance. The description adds no parameter-level semantics, but none is needed given the schema's completeness.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('project templates'), identifies the returned data (ID, name, description, default flag, parameters), and notes pagination. This clearly distinguishes it from siblings like createProject and getProjects.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says to call this tool before createProject to choose a valid templateId. This provides a concrete invocation context and a clear reason to select this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectTestParameterDefinitionARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testParamId | Yes | The Test Parameter. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate read-only and open-world behavior, so the description doesn't need to repeat those. The description adds a useful cardinality note and hints that no write is performed, but the open-world aspect isn't elaborated (e.g., potential for null returns). No explicit caveats about fields or include behavior, though those are in the schema. No contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, extremely concise, with the key purpose and differentiation front-loaded. No redundant phrasing or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a full output schema and detailed parameter definitions, the description is largely complete for a simple read operation. It could mention that the response might be null if not found (open-world), but that's a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all parameters comprehensively, including descriptions for fields and include. The description doesn't add much beyond the schema, but the schema itself is rich, so the baseline is acceptable. The testParamId description is vague ('The Test Parameter.'), but the description doesn't improve it either.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it returns a specific Test Parameter Definition by ID, distinguishing it from the sibling collection tool. Cardinality is explicit, removing ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly contrasts with the plural variant, telling the agent to use the collection tool for full collections or batch operations, which is direct and helpful.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getProjectTestParameterDefinitionsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true and openWorldHint=true, and the description adds collection/batch cardinality without implying side effects. It does not describe pagination behavior in prose, but the schema and annotations cover the practical profile.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The verb, resource, and scope are front-loaded, followed immediately by cardinality and the singular-item alternative.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema, fully documented parameters, and read-only annotations, the remaining contextual need is scope and routing, which the description provides. An agent has enough information to select and invoke the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and every parameter has a detailed description, including projectId semantics, sparse fieldsets, includes, and pagination. The tool description itself adds no parameter-specific detail, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states the verb ('Returns'), the resource ('Test Parameter Definitions'), and the scope ('specified Project'). It also names the cardinality and explicitly distinguishes itself from the singular sibling, so an agent can immediately tell what this tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit routing rule: use getProjectTestParameterDefinition for a single item by ID. However, it does not mention other related sibling fetchers such as getTestRunTestParameterDefinitions or getWorkItemTestParameterDefinitions, so the guidance is clear but not exhaustive.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getRepositorySpacePagesARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds useful behavioral context beyond that: the resource lives at repository level 'outside any project', and results are 'paginated and filterable with `query`'. It could have added constraints like authorization or default pagination behavior, but for a read-only list tool this is strong context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no filler. The first sentence leads with the action, resource, and scope; the second provides precise sibling routing. Every phrase earns its place, and the most decision-relevant information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has an output schema, all parameters are documented in the schema, and the description provides the contextual scope and sibling distinctions necessary to select it correctly. Nothing critical for invoking this tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents all 8 parameters. The description contributes only a high-level mention of query filtering and pagination, which is consistent with the schema but does not add new meaning beyond it. This meets the baseline for fully documented parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Returns'), the resource ('Rich Pages'), and the scope ('one space at the repository (server) level, outside any project'). It explicitly names sibling tools (`getSpacePages`, `getGlobalPages`) to disambiguate, so an agent can distinguish this tool without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives direct 'when to use this' guidance: 'Use it for global wiki pages'. It also names the alternatives and their selection conditions: pages inside a project space should use `getSpacePages`, and repository-level pages regardless of space should use `getGlobalPages`. This leaves no ambiguity about routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getRevisionARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | Yes | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| repositoryName | Yes | The Repository Name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true and openWorldHint=true, so the description does not need to re-establish safety. It adds useful behavior beyond annotations: singleton cardinality, targeting by revision number, and the returned fields. This is meaningful context for an agent deciding how to handle the result.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core operation, then provides a concrete use case, then routes to the sibling tool. Every sentence earns its place, and the formal 'Cardinality' marker succinctly summarizes the singleton behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only singleton accessor with an output schema, annotations, and full parameter documentation, the description is complete. An agent knows what the tool returns, when to use it, how it differs from getRevisions, and which parameters matter for invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description clarifies that the revision parameter is the target commit identifier, but it does not add substantive syntax or format details beyond the already-complete schema. The fields and include parameters are left to the schema, which is acceptable.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Returns one repository revision (commit) by its number', and names the returned content (author, timestamp, commit message). It also distinguishes itself from the sibling getRevisions by explicitly noting singleton cardinality, so an agent can select it correctly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives an explicit use case ('see who changed data at a known revision') and names the alternative for related but different needs: 'to search or page through revision history use getRevisions' and 'For the full collection or a batch, use getRevisions instead.' This is clear when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getRevisionsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint` and `openWorldHint`, covering the safety profile. The description adds useful behavioral context by noting pagination, query filtering, and collection/batch cardinality, but it doesn't go beyond this into side effects, permissions, or response behavior; this is adequate given the read-only annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The definition is front-loaded with the core behavior and usage guidance, but it repeats the 'use `getRevision` instead' instruction twice ('for one known revision number' and 'for a single item by ID'). Tightening this redundancy would make every sentence necessary.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich parameter schema, read-only annotation, and presence of an output schema, the description supplies the remaining context: collection scope, cardinality, and the exact sibling for single-item needs. A small gap is that 'repository revisions' is not tied to a concrete endpoint or default ordering, but no crucial invocation detail is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameter list already carries full meaning. The description only names `query` in passing and does not add semantic detail beyond the schema, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Returns repository revisions (commits) with author, timestamp, and commit message', and it explicitly separates collection behavior from the single-item sibling `getRevision`. This leaves no ambiguity about what the tool does or which tool to pick.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states the intended use case ('Use it to audit recent changes across the repository') and the exclusion ('for one known revision number use `getRevision`'). It also explains cardinality as collection or batch, which guides selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getRoleARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| roleId | Yes | The Role ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds meaningful behavioral context beyond that: it clarifies the global vs. project scope and that the response includes the role's users. This is useful additional context without contradicting the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The core purpose is front-loaded, followed by usage scope and a pointer to the alternative. Every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has a full output schema, so return values are defined. Annotations cover safety, and the description covers scope, usage, and alternatives. Nothing an agent needs to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents all three parameters (fields, roleId, include). The description adds no parameter-level detail beyond what the schema provides; it only hints at role examples ('admin', 'user'). Thus it meets the baseline for high schema coverage but adds no extra value.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns'), a clear resource ('one global role'), and the content ('and the users that hold it'). It also explicitly distinguishes itself from project-level roles and from getUser, so an agent can tell exactly what this tool covers versus alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use ('check who has server-wide permissions'), what it does NOT cover ('project-level roles are not covered'), and names the alternative ('use getUser') for a user's own profile and roles. This is complete routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpaceDocumentsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint: true` and `openWorldHint: true`, covering the read-only nature. The description adds the cardinality note ('targets the full collection or a batch'), which is some extra context. However, it does not elaborate on pagination behavior, default return size, or any side effects—though the schema covers pagination parameters. Given the annotation coverage, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The core purpose and scope are front-loaded in the first sentence, and the alternative is given in the second. Every word contributes to the agent's understanding, making it highly concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema (100% parameter coverage) and the presence of an output schema, the description does not need to explain return formats or parameter details. It covers the essential use case (list documents in a space) and the primary alternative (single document by ID). It could mention pagination advice, but that is already documented in the `page_size_` and `page_number_` parameters, so the description is sufficiently complete for the tool's purpose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, meaning every parameter is documented in detail in the input schema (e.g., `spaceId`, `projectId`, `sort`, `query`, `fields`, `include`, `page_size_`, `page_number_`). The tool description does not add any parameter-level guidance beyond the schema, so the baseline score of 3 applies as appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Returns a list of Documents'), the scope ('from a given Project Space'), and the cardinality ('full collection or a batch'). It explicitly distinguishes from `getDocument` by naming the alternative for single-item retrieval, making it easy for an agent to select this tool over the sibling for list operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a clear when-not-to-use instruction by directing agents to `getDocument` for single-item ID lookups. However, it does not mention other list-related siblings like `getAllDocuments` or `getDocuments`, leaving some ambiguity about when this tool is preferred over those. The mention of 'Project Space' hints at scoping but is not explicit about excluding alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getSpacePagesARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, so the read-only nature is covered. The description adds useful context about cardinality (full collection or batch), which hints at pagination behavior and helps set expectations beyond the raw annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, no filler, and the core purpose is front-loaded. The alternative guidance is appended without diluting the primary message. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a collection-list tool with an output schema and full schema coverage of parameters, the description is adequate. It covers the core function and the most likely confusion (single vs. collection). It doesn't explicitly discuss filtering or pagination mechanics, but those are fully documented in the schema, so the description remains complete enough for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all 8 parameters are fully documented in the input schema. The description adds no parameter-specific details beyond what the schema provides; the mention of 'batch' loosely relates to pagination but doesn't add technical value. Baseline 3 is appropriate when the schema covers everything.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('a list of Pages from a given Project Space'), and explicitly differentiates from the sibling tool `getPage` by noting the single-item case. This makes the tool's purpose unambiguous and distinct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states the cardinality scope (full collection or batch) and provides a clear alternative: 'For a single item by ID, use `getPage` instead.' This gives the agent a direct routing rule without ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordARead-only
Returns the specified Test Record. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRecords instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds the behavioral distinction of single-item-by-ID cardinality, which is useful, but it does not elaborate on edge cases such as missing records or revision-specific behavior beyond what the schema already implies.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with no waste. The core action and cardinality are front-loaded, and the alternative tool is mentioned in the second sentence without repetition of schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, annotations, and an output schema, the description does what it needs to: it states the singular scope, differentiates from the plural sibling, and leaves parameter semantics to the fully documented schema. Nothing an agent needs to select or invoke this tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema fully documents all 8 parameters. The description adds little beyond 'by ID' and does not name which identifiers constitute that ID, but the schema already supplies this detail. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource ('Returns the specified Test Record') and immediately clarifies cardinality ('targets a single item by ID'). It also names the sibling it is not (getTestRecords), making it distinguishable from the plural collection variant.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool versus the alternative: 'For the full collection or a batch, use getTestRecords instead.' This gives clear routing guidance and leaves no ambiguity about when the singular form is appropriate.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordAttachmentARead-only
Returns the specified Test Record Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRecordAttachments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint: true`, so the read-only nature is covered. The description adds useful single-item cardinality and a pointer to the collection endpoint, but does not describe error behavior, authentication needs, or response characteristics beyond that.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler. The core action and cardinality are front-loaded, and the sibling alternative is stated in one clause.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only single-item retrieval with full schema coverage and an output schema, this is mostly complete. The main gap is not explicitly distinguishing attachment metadata from raw content given the existence of `getTestRecordAttachmentContent`, but the provided cardinality and collection alternative cover basic correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All nine parameters have descriptions in the input schema, so the description does not need to compensate for missing parameter docs. The general 'single item by ID' idea is already conveyed by the schema's required `attachmentId` field.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Returns') and resource ('specified Test Record Attachment'), and immediately pins cardinality to a single item by ID. It explicitly distinguishes itself from its collection sibling `getTestRecordAttachments`, making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives an explicit when-not-to-use signal: for a full collection or batch, use `getTestRecordAttachments` instead. It does not distinguish from the sibling content endpoint `getTestRecordAttachmentContent`, but the single-item routing is clear enough for basic selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordAttachmentContentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, indicating a safe read operation. The description adds crucial behavioral context: the file body is returned as UTF-8 text, with binary files arriving garbled. This is valuable beyond the annotations, though it does not mention error handling or response size limits, which are minor gaps. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with zero wasted words. It front-loads the primary action, then adds the encoding caveat, and finally gives usage guidance. Every sentence earns its place, making it concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a download tool with a well-documented schema and read-only annotations, the description is complete. It covers the purpose, when to use it, the return format, and the binary limitation. It does not need to explain return values since there is no output schema, and all parameters are already documented. Nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are already well-documented in the schema. The description does not add significant parameter-specific meaning beyond what the schema provides, but it does mention how to obtain attachmentId (via list/get attachments call), which is already noted in the schema. Baseline 3 is appropriate since the schema carries the parameter documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool downloads raw file content of a Test Record attachment, and distinguishes it from metadata retrieval (getTestRecordAttachment) and attachment listing (getTestRecordAttachments). It specifies the verb 'Downloads', the resource ('raw file content of one Test Record attachment'), and differentiates among siblings by naming the alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit guidance is provided: 'Use this only when you need the file's bytes; for its metadata... call getTestRecordAttachment, and to discover attachment IDs call getTestRecordAttachments.' This directly tells the agent when to use this tool versus alternatives, leaving no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordAttachmentsARead-only
Returns a list of Test Record Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecordAttachment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint and openWorldHint annotations already cover the safety profile. The description adds a useful cardinality clarification ('full collection or a batch') but does not disclose additional behavioral details such as whether this returns only metadata or where to fetch actual attachment content.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The primary action and cardinality are front-loaded, and the singular-endpoint alternative is stated efficiently.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The schema fully documents the complex required parameters, and an output schema exists, so return-value details are covered. The main gap is that the description does not explicitly say whether this returns only metadata or point to getTestRecordAttachmentContent for content, but this is a minor omission for a collection-list tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All 10 parameters are already described in the input schema with 100% coverage, so the description does not need to repeat them. The description adds no extra parameter-level meaning, which is acceptable given the strong schema documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns a list of Test Record Attachments') and explicitly distinguishes this collection endpoint from the singular getTestRecordAttachment. The cardinality note reinforces that this is not a single-item fetch.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It clearly says to use getTestRecordAttachment for a single item by ID, giving a concrete when-not-to-use rule. It does not mention other related attachment endpoints (e.g., test run or work item attachments), but the resource name and sibling context make the intended scope reasonably clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordsARead-only
Returns a list of Test Records. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRecord instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| testCaseId | No | The Test Case's ID being referenced. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| testResultId | No | testResultId | |
| testCaseProjectId | No | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds useful cardinality context and an explicit single-item alternative, but it does not explain batch semantics or response behavior beyond that. This is an adequate contribution given the annotations and output schema, but not a rich one.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The purpose is front-loaded, the cardinality constraint is stated, and the sibling routing is compact. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only collection tool with a fully described schema and an output schema, the description provides solid orientation: list vs single-item, cardinality, and the correct alternative tool. It is slightly thin on defining what constitutes a 'batch,' but pagination and sparse-field parameters in the schema compensate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All 10 parameters have descriptions in the input schema, with 100% coverage. The tool description adds no parameter-specific meaning, but the schema carries the full burden, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Returns a list of Test Records.' It explicitly states the cardinality target ('full collection or a batch') and distinguishes itself from the single-item sibling getTestRecord, so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a clear selection rule: use this tool for a collection or batch, and use getTestRecord instead for a single item by ID. It does not explain how a 'batch' is requested or when pagination becomes necessary, but the schema's page parameters fill in much of that context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordTestParameterARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| testParamId | Yes | The Test Parameter. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the cardinality detail (single item by ID) and the batch alternative, but does not disclose behaviors such as missing-resource errors or authorization requirements. This is consistent with the annotation so no contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences: the first states the operation and cardinality, the second routes to the sibling for collections. No filler or repeated schema content, and the key distinguishing information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a full input schema, read-only annotations, and an output schema present, the description is nearly complete for a single-item getter. It clearly names the batch alternative. However, the description refers to a 'specified Test Record' without explaining that the record is identified via the composite of testRunId, testCaseProjectId, testCaseId, and iteration, which is a minor ambiguity given the absence of a literal testRecordId parameter.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%: every one of the 9 parameters has an individual description, so the schema carries the semantic weight. The tool description adds only the concept of targeting a single item by ID, which is useful but does not explain any parameter beyond what the schema already provides, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The verb 'Returns' plus the resource 'specified Test Parameter for the specified Test Record' states exactly what the tool does. It further distinguishes itself from the plural sibling by declaring cardinality ('targets a single item by ID') and naming getTestRecordTestParameters as the batch alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells the agent when not to use this tool: 'For the full collection or a batch, use getTestRecordTestParameters instead.' This is a clear when-not/alternative statement, and the single-item cardinality implies the appropriate use case.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRecordTestParametersARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered elsewhere. The description adds useful behavioral context by clarifying that the tool targets the full collection or a batch, which helps set expectations about the result scope. It does not contradict annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, with the core behavior first, followed by cardinality and the sibling alternative. Every sentence earns its place and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is reasonably complex with 10 parameters and 5 required ones, but 100% schema coverage and an output schema carry most of the load. The only minor gap is that the description does not explicitly state how the Test Record is addressed (e.g. via the combination of the required test run/test case/iteration parameters), though the required fields make this discoverable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all 10 parameters. The description adds no per-parameter meaning beyond the schema, which meets the baseline for a fully covered schema but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb-resource pair: 'Returns a list of Test Parameters for the specified Test Record.' It also states the cardinality and explicitly differentiates itself from the singular sibling `getTestRecordTestParameter`, so an agent can tell them apart without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool (full collection or batch) and when not to ('For a single item by ID, use `getTestRecordTestParameter` instead'). This is clear alternatives-based usage guidance with no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunARead-only
Returns the specified Test Run. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRuns instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true and openWorldHint=true, covering the safety profile. The description adds the cardinality nuance and the sibling pointer, which is useful context beyond the annotations. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action, then cardinality and alternative. Zero waste, perfectly scoped.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and annotations covering safety, this is complete for a single-ID fetch tool. Nothing an agent needs is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are already fully documented. The description adds no extra parameter meaning; baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Returns the specified Test Run' – a specific verb and resource. It also distinguishes from the sibling 'getTestRuns' by noting the cardinality (single item vs. collection), so an agent can immediately tell them apart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the alternative 'getTestRuns' and the condition (full collection or batch) when to use it instead. This is clear when-to-use/when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunAttachmentARead-only
Returns the specified Test Run Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunAttachments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the cardinality constraint and identifies the batch sibling, which is useful but not deeply behavioral. It does not describe response shape or side effects, but the output schema exists and the read-only nature is already annotated, so this is an adequate baseline.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The core action and resource are front-loaded, followed by the cardinality clarification and the pointer to the collection-level sibling. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of an output schema, 100% schema coverage for parameters, and read-only annotations, the description supplies the missing selection context: this is the single-item counterpart to `getTestRunAttachments`. An agent has everything needed to decide whether to invoke this tool and how to specify the required IDs.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all six parameters thoroughly, including examples and guidance for `projectId`, `fields`, `include`, and `revision`. The description only adds the single-item-by-ID cardinality, which is already reflected in the `attachmentId` parameter context. This is the correct baseline when the schema carries the parameter documentation burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the exact resource ('Test Run Attachment') and the operation ('Returns'), and explicitly states cardinality ('targets a single item by ID'). It also distinguishes itself from the sibling 'getTestRunAttachments' by pointing to that tool for full collection/batch retrieval, so an agent can immediately tell the two apart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit usage direction: use this tool for a single specified item, and use `getTestRunAttachments` instead for the full collection or a batch. This is a clear when-to-use and when-not-to-use statement naming the alternative, leaving no inference required for the cardinality decision.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunAttachmentContentARead-only
Downloads the file content for a specified Test Run Attachment.
| Name | Required | Description | Default |
|---|---|---|---|
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, which covers the safety and scope. The description adds minimal behavioral context by stating 'Downloads' (implying a read operation returning the raw file), but does not disclose details like content type, size, or error behavior. Given annotations, a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, efficient sentence that front-loads the core action and resource. No wasted words or redundant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a straightforward download tool with a read-only hint and no output schema, the description sufficiently conveys the purpose and expected return (file content). It lacks explicit details about return encoding or limits, but these are minor for this operation. The required parameters are clear from the schema, so the tool is adequately specified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters (revision, projectId, testRunId, attachmentId) are already documented in the input schema. The description adds no additional parameter-level context, meeting the baseline for fully covered schemas.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Downloads the file content') and the specific resource ('Test Run Attachment'), which is unambiguous and distinguishes it from sibling tools like getTestRunAttachment (which likely returns metadata) and getTestRunAttachments (which lists attachments).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for retrieving file content, but it does not explicitly contrast it with alternatives such as getTestRunAttachment or state when to prefer this tool over metadata retrieval. An agent can infer from the name, but no explicit guidance is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunAttachmentsARead-only
Returns a list of Test Run Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRunAttachment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety and scope characteristics are known. The description adds no further behavioral context such as pagination behavior or response details, but it also does not contradict the annotations. This is adequate but not enriched.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The primary purpose is front-loaded, and the sibling distinction is provided efficiently in the second sentence.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is a read-only list operation with complete schema documentation, an output schema, and annotations covering its behavioral profile. The description's guidance on cardinality and the singular alternative completes the picture needed for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all parameters. The description adds no parameter-specific semantics, but given the complete schema, the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb and resource ('Returns a list of Test Run Attachments') and explicitly distinguishes itself from the singular getTestRunAttachment sibling. The agent can immediately understand what this tool does and how it differs from similar tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly defines cardinality ('full collection or a batch') and gives a clear when-not-to-use directive with a named alternative ('For a single item by ID, use getTestRunAttachment instead'). This is exactly the level of guidance needed for tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunCommentARead-only
Returns the specified Test Run Comment. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestRunComments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, so the read-only nature is covered. The description adds only the cardinality detail (single item), which is more about purpose than behavior. It does not describe error cases, response structure, or any side effects. Since annotations cover the safety profile, the description adds minimal value, warranting a 3.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences long, with the core function stated first and the alternative routing second. It contains no extraneous information and is front-loaded with the primary purpose. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has an output schema, return values are defined elsewhere. The description covers the essential selection mechanism (single item by ID), the alternative for batch operations, and the read-only nature is implied by annotations. All necessary information for an agent to correctly call this tool is present, making it complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema covers all 6 parameters with descriptions, including projectId, testRunId, commentId, fields, include, and revision. The tool description does not add any parameter-specific semantics beyond what the schema already provides. With 100% schema coverage, the baseline is 3, and no additional value is contributed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the function 'Returns the specified Test Run Comment', identifying the specific resource and the action. It also differentiates from the sibling tool getTestRunComments by noting cardinality: 'targets a single item by ID' versus the plural for collections or batches. This makes the tool's purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly provides a when-not-to-use condition: 'For the full collection or a batch, use `getTestRunComments` instead.' This directly guides the agent to the appropriate alternative for a different cardinality, making the usage context clear. No other guidance is needed given the simplicity of the operation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunCommentsARead-only
Returns a list of Test Run Comments. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRunComment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already discloses the safety profile, so the description does not need to repeat that. The description adds the cardinality trait (collection or batch), which is useful, but otherwise provides no additional behavioral context such as pagination behavior or response shape. This is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler. The primary action is front-loaded, and the distinguishing alternative is stated immediately. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a complete input schema, an output schema, and readOnly/openWorld annotations, the description covers the essential selection and invocation context. The only minor gap is that the 'batch' mechanism is not elaborated, but paging parameters in the schema already cover that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already fully documents all seven parameters. The description does not add parameter-level meaning beyond the schema, which matches the baseline-3 case where the schema carries the weight.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns a list of Test Run Comments') and clarifies cardinality ('full collection or a batch'). It explicitly distinguishes itself from the single-item sibling getTestRunComment, so an agent can select the right tool without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit routing guidance: for a single item by ID, use getTestRunComment instead. This directly addresses when to prefer an alternative, which is exactly what an agent needs to disambiguate between the collection and single-item tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunsARead-only
Returns a list of Test Runs. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestRun instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| templates | No | If true, only return template resources; if false or omitted, return only actual (non-template) instances. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the agent knows this is a safe read operation. The description adds a small behavioral note about cardinality ('full collection or a batch') but does not go deeper into pagination behavior, result size, or error conditions. Given the annotation coverage, the description offers some value but not extensive behavioral detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences carry the full message: what the tool returns, the cardinality, and the alternative for single-item lookup. There is no filler, and the most important information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list operation, the description plus fully documented schema and output schema is sufficient. The agent knows what the tool returns, when to use it, and every parameter is explained in the schema. Nothing critical for invoking the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all nine parameters in detail. The description adds no parameter-level meaning beyond what the schema provides, which matches the baseline 3 for high-coverage schemas.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Returns a list of Test Runs.' It also clarifies cardinality and explicitly differentiates itself from the single-item sibling getTestRun. An agent can immediately understand what the tool does and how it relates to nearby tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives an explicit when-not case and a named alternative: 'For a single item by ID, use `getTestRun` instead.' This is clear routing guidance that helps an agent choose between the plural collection tool and the singular item tool without inspecting schemas.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunTestParameterARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testParamId | Yes | The Test Parameter. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safe-read nature is covered. The description adds the single-item-by-ID cardinality behavior, which is useful context, but it does not discuss error cases, permissions, or return shape. Given annotation coverage, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The core action is front-loaded, and the cardinality note and sibling alternative are presented immediately. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only single-item getter, the description plus the fully documented schema and existing annotations give an agent everything needed to select and invoke the tool correctly. The output schema covers return-value expectations, so no additional return-format explanation is required.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and each parameter already has a meaningful description. The tool description itself does not add parameter-level detail, but it does not need to; the schema carries the burden. This matches the baseline for high schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('Returns') and resource ('the specified Test Parameter for the specified Test Run'), and further distinguishes it from the plural sibling by explicitly noting single-item cardinality. This makes the tool's purpose unambiguous even without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names the alternative `getTestRunTestParameters` for full collection or batch access, which tells an agent both when this tool is appropriate and when it is not. This is direct, actionable usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunTestParameterDefinitionARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testParamId | Yes | The Test Parameter. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already communicate readOnlyHint and openWorldHint, so the bar is lower. The description adds the cardinality constraint but not deeper behavioral context such as error behavior, revision handling, or sparse-field effects. It does not contradict the annotations, so a mid score is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences carry all essential information with no filler. The purpose is front-loaded, and the cardinality plus sibling alternative appear immediately after, making it easy to scan and act on.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item getter, the description is complete: purpose, cardinality, and the alternative for batch retrieval are covered, and the output schema plus annotations fill in the remaining context. The rich parameter descriptions in the schema mean nothing critical is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all six parameters, including the required projectId, testRunId, and testParamId. The description does not add parameter-level meaning beyond the schema, which matches the baseline expectation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb-resource pair: returns the specified Test Parameter Definition for a specified Test Run. It also disambiguates cardinality (single item by ID) and explicitly names the sibling `getTestRunTestParameterDefinitions` for the collection or batch case, so the agent can distinguish the tools without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: use this tool for a single definition by ID, and use `getTestRunTestParameterDefinitions` for the full collection or a batch. This directly tells the agent when to select this tool versus its alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunTestParameterDefinitionsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds useful behavioral context by stating the cardinality ('full collection or a batch') and by pointing to the singular sibling, which clarifies the expected scope of the operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler: the core purpose is stated first, the cardinality is clarified, and the relationship to the singular sibling is given. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only collection operation, the description plus complete input schema plus output schema is sufficient. Required parameters are clear, pagination and field selection are documented in the schema, and the singular alternative is named where relevant.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all parameters thoroughly. The description adds no parameter-level meaning beyond reinforcing that the operation is scoped to a specified Test Run, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Returns a list of Test Parameter Definitions for the specified Test Run') and distinguishes itself from the singular sibling getTestRunTestParameterDefinition by using 'Cardinality' to indicate collection vs. single-item targeting.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly names the alternative getTestRunTestParameterDefinition and provides the deciding condition ('For a single item by ID, use ... instead'). This gives clear when-to-use versus when-not-to-use guidance without ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestRunTestParametersARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds a behavioral trait beyond annotations by disclosing cardinality ('full collection or a batch'). It also clarifies the relationship to the singular variant. No contradiction exists, and the description need not repeat what annotations already provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two short sentences with no filler. The primary action is front-loaded, and the sibling differentiation is placed at the end. Every phrase earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete enough given the output schema, annotations, and fully documented schema. It identifies the resource, cardinality, and the singular alternative. It does not explicitly contrast with Test Parameter Definitions tools, but the naming and context make the distinction clear without requiring extra prose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all 7 parameters are already documented with rich explanations (fields, include, revision, pagination, required IDs). The description adds no parameter-specific semantics beyond the broad cardinality hint. Baseline 3 is appropriate when the schema carries the full parameter burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: 'Returns a list of Test Parameters for the specified Test Run.' It also distinguishes itself from the singular sibling by stating 'For a single item by ID, use getTestRunTestParameter instead.' This leaves no ambiguity about what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names an alternative and the condition that selects it: for a single item by ID, use getTestRunTestParameter. The cardinality statement 'targets the full collection or a batch' clarifies that this tool is the list-oriented option. This is sufficient routing guidance for an agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepARead-only
Returns the specified Test Step. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestSteps instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| testStepIndex | Yes | The Test Step index. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the agent knows this is a safe read operation that may return unknown fields. The description adds the cardinality behavior (single item by ID) and the existence of a sibling for batch operations, which is useful but not deep behavioral context. It doesn't disclose what happens if the ID doesn't exist, whether the step is returned within a work item context, or how the index is interpreted (0-based vs 1-based). With annotations covering the safety profile, a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The primary purpose is front-loaded, and the sibling routing is stated in the second sentence. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item read tool with readOnlyHint=true, openWorldHint=true, a 100%-covered schema, and an output schema present, the description is nearly complete. The only gap is the ambiguous testStepIndex semantics (0-based vs 1-based, format), which the schema also fails to clarify. The sibling routing and cardinality are covered. This is a minor gap against an otherwise well-specified tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all six parameters. The description adds no parameter-level detail beyond what the schema provides. The testStepIndex parameter description in the schema is notably thin ('The Test Step index.') and the tool description doesn't compensate by explaining its format or whether it's zero-based. Baseline 3 is correct when schema does the heavy lifting, but the description misses an opportunity to clarify the index semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns a single Test Step by ID, with a specific verb ('Returns') and resource ('specified Test Step'). It explicitly distinguishes itself from the sibling getTestSteps by noting cardinality ('targets a single item by ID') and directing users to the plural variant for full collection or batch. This is a model of sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool vs the alternative: 'For the full collection or a batch, use getTestSteps instead.' This is a clear exclusion/alternative statement. The cardinality note ('targets a single item by ID') further reinforces the selection criterion. No ambiguity remains about when to invoke this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepResultARead-only
Returns the specified Test Step Result. Cardinality: targets a single item by ID. For the full collection or a batch, use getTestStepResults instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the cardinality context (single vs. collection) and the fact that it targets by ID, which is useful beyond the annotations. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The purpose is front-loaded, and the alternative is mentioned succinctly. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only getter with a clear ID-based scope, the description plus annotations and schema are sufficient. It doesn't explain error conditions, but that is not necessary given the annotations and output schema. The description covers the key routing decision between singular and plural.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so all nine parameters have detailed descriptions in the schema. The tool description itself does not add extra parameter semantics, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns a specific Test Step Result by ID, and distinguishes it from the plural sibling getTestStepResults by explicitly naming the alternative. The verb-resource pair is specific and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states the cardinality (single item by ID) and directs the user to getTestStepResults for the full collection or batch. This is clear when-to-use vs. when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepResultAttachmentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the read-only nature is covered. The description adds only the cardinality detail ('targets a single item by ID'), which is useful but not deep behavioral context. It doesn't describe response behavior, error conditions, or permissions, and no contradiction exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences with no filler. The core operation is front-loaded, followed by a compact cardinality note and a clear routing pointer. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-item read endpoint with 100% parameter schema coverage and an output schema present, the description and annotations provide enough context for selection and invocation. It slightly under-serves by not mentioning the attachment-content sibling tool, but that gap is minor and inferable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with every parameter individually described in the input schema. The description itself adds no parameter-level meaning beyond the generic 'by ID' reference, so it appropriately relies on the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Returns the specified Test Step Result Attachment for the specified Test Record.' It explicitly differentiates from the sibling collection tool by noting cardinality ('targets a single item by ID') and naming getTestStepResultAttachments as the batch alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit routing rule: 'For the full collection or a batch, use getTestStepResultAttachments instead,' and clarifies single-item scope. However, it does not disambiguate from the sibling getTestStepResultAttachmentContent, though the resource distinction is largely inferable from the tool name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepResultAttachmentContentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, the description discloses the output behavior: content is returned as UTF-8 text, plain-text files are readable, and binary files arrive garbled. This is critical for the agent to set expectations and decide whether to call this tool. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the core purpose, followed by behavioral detail and routing. Every sentence earns its place with no redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the 8-parameter schema (fully documented) and the description covering output format and alternative tools, the definition is nearly complete. It could optionally mention error conditions or size limits, but those are not essential for selection and invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description does not add parameter-level meaning beyond what the schema already provides, but that is acceptable because the schema is thorough.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a precise action ('Downloads the raw file content of one Test Step Result attachment') and distinguishes it from the metadata and list siblings by explicitly naming them. This leaves no ambiguity about which resource is acted on.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use guidance ('Use this only when you need the file's bytes') and names the exact alternatives for metadata and ID discovery, with the sibling tool names. This fully routes the agent to the correct tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepResultAttachmentsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, so the description only needs to add context beyond that. It adds the cardinality note, which is useful behavioral information. It does not contradict annotations and provides some extra context without over-explaining.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no filler. The first states the primary purpose, the second clarifies cardinality and directs to the singular alternative. It is front-loaded and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the straightforward nature of a list retrieval, the description is sufficient. Required parameters identify the test step result, the output schema covers return structure, and pagination is documented in the schema. The only minor omission is explicit mention of pagination behavior, but that is covered by the schema parameters and descriptions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage for all 11 parameters, so each parameter is already documented. The description adds no parameter-specific details beyond what the schema provides, so a baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb and resource: returns a list of Attachments for a specified Test Step Result. It also differentiates from the singular sibling getTestStepResultAttachment by explicitly noting the singular variant for a single item by ID, which removes ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly mentions the cardinality (full collection or batch) and names the alternative getTestStepResultAttachment for single-item retrieval. This gives the agent clear when-to-use guidance and points to the correct sibling tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepResultsARead-only
Returns a list of Test Step Results. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestStepResult instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the tool is known to be safe. The description adds the cardinality distinction (collection/batch) but provides no further behavioral detail such as pagination expectations or ordering. It does not contradict the annotations, so a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, zero fluff. The purpose and the critical alternative are front-loaded, and every word adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The output schema covers return values, and the description provides enough context for a list tool. It could include a brief note on how the 'batch' cardinality is controlled (e.g., via page parameters), but the schema already documents those, so the description is sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the parameters are fully documented in the schema. The description adds no extra parameter-level semantics beyond the cardinality hint; the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Returns a list of Test Step Results', a specific verb and resource. It explicitly distinguishes itself from the singular sibling 'getTestStepResult', making its purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly states the cardinality ('full collection or a batch') and explicitly names the alternative for single-item retrieval: 'For a single item by ID, use getTestStepResult instead.' This gives the agent an actionable when-not rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getTestStepsARead-only
Returns a list of Test Steps. Cardinality: targets the full collection or a batch. For a single item by ID, use getTestStep instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true and openWorldHint=true, so the description does not need to revisit safety or world-completeness. The cardinality statement adds a bit of behavioral context, but the description does not discuss pagination, ordering, or how batching is expressed. Given the annotation coverage, a 3 is appropriate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact: two sentences, no filler, and the primary 'returns a list' statement is front-loaded. The 'Cardinality' phrasing is slightly jargon-heavy but still earns its place by clarifying scope. It could be slightly clearer, hence 4 rather than 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a list-oriented read tool, the description is largely complete: it identifies the result type, cardinality, required scope, and the sibling to use for single items. The output schema covers return structure, the input schema covers parameters, and annotations cover safety/open-world behavior. The only notable gap is the vague 'batch' terminology.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all seven parameters are already documented in the input schema. The tool description adds no parameter-specific meaning beyond the notion of collection/batch, and it does not map that notion to concrete parameters. Baseline 3 is warranted.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Returns a list of Test Steps.' It also states cardinality ('full collection or a batch') and explicitly contrasts itself with getTestStep, which handles single items by ID. This makes the tool's purpose unambiguous and distinguishable from its sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a clear alternative: 'For a single item by ID, use getTestStep instead.' This tells the agent when not to use this tool. It does not, however, explain when to request the full collection versus a batch, which remains somewhat implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getUserARead-only
Returns the specified User. Cardinality: targets a single item by ID. For the full collection or a batch, use getUsers instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| userId | Yes | The User ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already convey readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the single-item cardinality constraint, which is useful but modest. It does not add details about error behavior or edge cases, but for a simple read-only GET this is acceptable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with no fluff. The primary purpose is stated first, the cardinality constraint is explicit, and the alternative tool is named. Every sentence earns its place and the description is easy to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the read-only annotations, an output schema, and 100% schema coverage for all parameters, nothing essential is missing. The description supplies the missing semantic distinction from getUsers and the single-item cardinality, making it complete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and each parameter already has a meaningful description in the schema, including sparse fields, includes, and revision. The tool description adds no parameter-level information, but it does not need to because the schema carries the full burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool 'Returns the specified User' and specifies exact cardinality: 'targets a single item by ID.' It also distinguishes itself from getUsers by naming the sibling and the batch/collection case, so there is no ambiguity about what this tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells the agent when to use this tool (single item by ID) and when not to: 'For the full collection or a batch, use getUsers instead.' This is direct, actionable guidance that prevents misuse.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getUserGroupARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| groupId | Yes | The Group ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the specific fields returned, which is useful context, but it does not disclose any error conditions, pagination, or other behavioral nuances. It adds some value beyond annotations but not rich detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The primary purpose is front-loaded, and the alternative is mentioned in the second sentence. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only tool with an output schema and full parameter documentation, the description is sufficient. It covers what the tool returns and when to use it. It doesn't mention optional parameters, but those are fully documented in the schema, so nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with detailed descriptions for all four parameters. The description adds no parameter-specific information beyond what the schema already provides, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('one user group') and enumerates the exact contents (ID, name, description, member users, roles). It also explicitly distinguishes itself from the sibling `getUser`, so an agent can tell them apart without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use the tool ('to resolve group membership') and names the alternative for a different use case ('for a single user's details use getUser'). This is clear, actionable guidance with no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getUsersARead-only
Returns a list of Users. Cardinality: targets the full collection or a batch. For a single item by ID, use getUser instead.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, covering the safety and open-world profile. The description adds only the cardinality detail, which is useful but not a major behavioral disclosure. It does not contradict annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The primary action and scope are front-loaded, and the alternative is mentioned second. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema, fully documented parameters, and annotations covering read-only and open-world behavior, the description is complete for an agent to invoke correctly. It also notes the sibling for single-item cases, rounding out the context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with detailed descriptions for all 7 parameters, so the schema carries the parameter documentation. The description adds no additional parameter-specific meaning, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Returns a list of Users') and clarifies cardinality (full collection or batch). Explicitly distinguishes from getUser for single-item lookups, so an agent can select the right tool without ambiguity.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit when-not guidance by naming getUser as the alternative for single-item retrieval. The cardinality note further clarifies batch vs. collection use, leaving no doubt about when to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkflowActionsForTestRunARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true. The description adds valuable context about user-specific action availability, unavailableReason, and required fields/roles/signatures, as well as a call-sequence hint. These enrich the behavioral profile beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two dense sentences: the first fully specifies the return payload, the second gives usage and sibling routing. No filler, and the key purpose is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With full schema coverage, an output schema, and annotations conveying read-only safety, the description covers purpose, usage, output contents, and sibling differentiation. Nothing an agent needs for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for all 5 parameters, so the schema already fully documents them. The description does not add any parameter-specific meaning beyond what the schema provides. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Returns the workflow actions (transitions) possible from one Test Run's current status') and enumerates the output fields. It explicitly names the sibling for Work Items, making differentiation immediate.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells when to call it ('before patchTestRun with workflowAction') and routes the agent to the alternative for Work Items ('for Work Items use getWorkflowActionsForWorkItem'). This is clear when/when-not guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkflowActionsForWorkItemARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and openWorldHint, and the description adds meaningful behavioral context beyond that: it reports caller-specific availability with `unavailableReason`, discloses required fields/roles/signatures, and highlights the critical consequence of bypassing workflow conditions by setting `status` directly. No contradiction with annotations exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences carry the full semantic load with no filler. The return content is front-loaded, and the usage guidance follows naturally; every clause adds information an agent needs to select and invoke the tool correctly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the read-only annotations and the presence of an output schema, the description supplies the missing workflow context: why to call it, what it returns, and how direct status setting differs. Nothing essential for correct invocation or tool selection is left unexplained.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% description coverage for all five parameters, so the schema already explains projectId, workItemId, revision, and pagination fields. The tool description does not add syntax or format details for this tool's parameters beyond what the schema provides, which matches the baseline-3 expectation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Returns') and names the precise resource ('workflow actions possible from one Work Item's current status'). It enumerates the returned content (action ID, name, target status, availability, required fields/roles/signatures) and clearly separates it from the related patchWorkItem tool by explaining its role in the transition flow.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells the agent when to call this tool: before patchWorkItem with `workflowAction` to choose a valid transition. It also gives an exclusion by warning that setting `status` directly bypasses workflow conditions and functions, which prevents misuse.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemARead-only
Returns the specified Work Item. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkItems instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the read-only nature is covered. The description adds useful scoping behavior ('Cardinality: targets a single item by ID'), but it does not disclose additional behavioral traits such as error behavior, exact return shape, or what happens when a revision is specified. With annotations present, this is adequate but not rich.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with no filler. The core function is front-loaded, and the second sentence adds essential disambiguation while pointing to the correct sibling tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-resource read operation, the description is complete in context: output schema exists, annotations cover safety, and the input schema fully documents parameters. The only additional guidance needed—when to use getWorkItems instead—is present.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all five parameters in detail. The description adds no parameter-level meaning beyond 'single item by ID,' which is also reflected in the workItemId schema description. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states exactly what the tool does: 'Returns the specified Work Item.' It also clarifies cardinality ('targets a single item by ID') and explicitly differentiates from the sibling getWorkItems, making selection unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives direct when-to-use guidance: call this for a single Work Item by ID. It names the alternative tool and condition: 'For the full collection or a batch, use getWorkItems instead.' This is explicit and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemApprovalARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| userId | Yes | The User ID. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the description correctly adds context beyond that: it specifies the cardinality (single item by ID), the statuses returned, and the scoping. It does not mention error handling or edge cases, but does not contradict annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences long, front-loads the core purpose, and each sentence adds distinct value (purpose+statuses, then usage guidance). No fluff or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (6 params, nested objects) and availability of an output schema, the description covers the essential context: what it does, how it scopes, when to use it vs. alternatives. Nothing necessary for an agent to call it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are already well-documented. The description adds meaning by clarifying that the userId is the addressing key for the approval entry, and reinforces the single-item cardinality, which the schema alone does not convey.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('one user's approval entry on a Work Item'), and addresses it by user ID. It also distinguishes from siblings like getWorkItemApprovals and patchWorkItemApproval, making it unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly tells when to use this tool ('to check a single approver's decision') and when to use alternatives ('to record or change it use patchWorkItemApproval', 'For the full collection or a batch, use getWorkItemApprovals instead'), providing clear routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemApprovalsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true, so the safe-read profile is established. The description adds useful behavioral context: the response contains approver/status pairs and the endpoint targets a collection or batch. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four dense sentences, each earning its place: purpose, usage guidance, cardinality, and the single-item alternative. The purpose is front-loaded, and there is no redundant filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only list endpoint with a fully documented input schema and an output schema, the description covers what it returns, when to use it, what not to use it for, and the cardinality distinction. Nothing essential is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all seven parameters. The description references workItemId conceptually ('on one Work Item') but does not add parameter-level detail beyond what the schema already provides, matching the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Returns the approval entries on one Work Item') and enumerates the returned data (approver and status values). It also distinguishes itself from getWorkItemApproval, postWorkItemApprovals, and patchWorkItemApproval, so an agent can select it correctly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says when to use this tool ('check sign-off progress') and names the alternatives for other actions: postWorkItemApprovals to add approvers, patchWorkItemApproval to record a decision, and getWorkItemApproval for a single item by ID. This is clear routing guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemAttachmentARead-only
Returns the specified Work Item Attachment. Cardinality: targets a single item by ID. For the full collection or a batch, use getWorkItemAttachments instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the description doesn't need to restate safety. It adds a useful behavioral clarification: 'Cardinality: targets a single item by ID.' This is beyond what the annotations convey and helps the agent understand that a single resource is returned. It doesn't cover mutation or side effects, but none are present given the read-only hint. Overall, adds meaningful context without contradicting annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, efficient and front-loaded with the core purpose, followed by the cardinality detail and the alternative. There is zero waste; every word contributes value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (6 params, output schema present) and the annotations covering read-only and open-world hints, the description is complete. It states the exact scope (single item by ID) and the sibling for batch retrieval. Nothing an agent needs to decide to call this tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents all six parameters, including required IDs and optional fields like sparse fieldset and include. The description adds no parameter-specific semantics beyond pointing to 'the specified' item. Baseline of 3 is appropriate given that the schema carries the full burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Returns the specified Work Item Attachment', a specific verb and resource. It also differentiates from the plural sibling by explicitly naming 'getWorkItemAttachments' and explaining the cardinality distinction ('targets a single item by ID'), making it easy for an agent to pick the right tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly provides an alternative: 'For the full collection or a batch, use `getWorkItemAttachments` instead.' This tells the agent exactly when to use this tool versus the sibling, leaving no ambiguity. The cardinality statement further reinforces the single-item use case.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemAttachmentContentARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the readOnlyHint annotation, the description discloses the return format (UTF-8 text), the readable file types, and the garbled result for binary files. This is valuable behavioral context that helps the agent anticipate outcomes and decide whether this tool is appropriate for the file type.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each carrying distinct value: purpose, behavior/limitation, and usage routing. The most important information is front-loaded, and no words are wasted on repeating schema or annotation content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only download tool with no output schema, the description adequately explains what the response will look like, warns against using it for binary files, and names the sibling tools for related operations. The input schema already covers parameter semantics, so nothing critical for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the parameter descriptions in the schema are thorough, so the description does not need to repeat them. It adds conceptual context by referencing how attachment IDs are obtained, but does not add parameter-specific semantics beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description uses a specific verb ('Downloads') and resource ('raw file content of one Work Item attachment'), clearly distinguishing the tool from sibling tools by explicitly naming getWorkItemAttachment for metadata and getWorkItemAttachments for discovering IDs. The purpose is unambiguous and tightly scoped.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool ('only when you need the file's bytes') and names alternatives with their conditions: getWorkItemAttachment for metadata and getWorkItemAttachments for discovering attachment IDs. This routes the agent correctly without requiring it to infer usage from the schema.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemAttachmentsARead-only
Returns a list of Work Item Attachments. Cardinality: targets the full collection or a batch. For a single item by ID, use getWorkItemAttachment instead.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare `readOnlyHint: true`, so the read-only nature is covered. The description adds minimal behavioral context beyond that—only a vague 'full collection or a batch' hint about cardinality. It does not describe pagination, response size limits, or any side effects, but with annotations covering safety, this is acceptable though not enriched.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, direct sentence that immediately states the purpose and includes the key differentiation from a sibling. Every word earns its place, with no redundancy or fluff, and the alternative is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a list operation with a full output schema and 100% parameter coverage, the description covers the essential purpose and routing. It does not explain the exact composition of the returned list (e.g., whether it includes metadata or only attachment IDs), but that is presumably covered by the output schema. The only minor gap is the vague 'batch' wording, which could be more precise, but overall it is sufficient for an agent to call correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, meaning all 7 parameters are documented in the input schema itself. The description does not add any parameter-specific meaning beyond what the schema already provides, so the baseline of 3 applies. The 'batch' hint loosely relates to pagination but is not explicit about parameter usage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('a list of Work Item Attachments'), clearly indicating the operation's scope. It also distinguishes from the singular sibling by explicitly naming `getWorkItemAttachment` for single-item retrieval, leaving no ambiguity about which tool to choose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly names the alternative (`getWorkItemAttachment`) and specifies the condition for selecting it ('For a single item by ID'), which is the core usage guideline. The phrase 'targets the full collection or a batch' further clarifies when to use this tool, providing direct routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`). | |
| query | No | Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried. | |
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the description doesn't need to restate safety. It adds useful behavioral context about cardinality ('full collection or a batch') and the requirement of a project ID. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with zero waste: purpose and scope first, then two clear alternative-routing statements. The description is front-loaded and every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given an output schema exists, return values are covered. The description covers scope, cardinality, and sibling differentiation. All parameters are documented in the schema. An agent has everything needed to call this tool correctly without extra research.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all 8 parameters in detail. The description does not add parameter-level semantics beyond what the schema provides, which matches the baseline for high coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Returns a list of Work Items') and clearly scopes it to one project. It explicitly names the sibling tools it is not (getAllWorkItems for cross-project, getWorkItem for single item), so an agent can disambiguate without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit when-to-use guidance: it distinguishes this tool from getAllWorkItems (cross-project) and getWorkItem (single item by ID). It also states the required project scope, so an agent knows when to select this over alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemsRelationshipsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
Output Schema
| Name | Required | Description |
|---|---|---|
No output parameters | ||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond readOnlyHint/openWorldHint, it discloses that the response contains only linkage identifiers and omits related-resource attributes, and that relationshipId is the relationship's name rather than an entry ID. This tells the agent what to expect and prevents misinterpreting the payload.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each with a distinct job: define the return payload, state the cheap-use case and the embed alternative, name the mutation endpoints, and point to richer link tools. No filler or repetition of schema content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description supplies the output format, the intended use case, and differentiated alternatives, and the output schema covers return values while the input schema covers all eight parameters. Nothing an agent needs to decide whether to call this tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the schema already documents each parameter, including the distinction that relationshipId is the relationship's name. The description restates the relationshipId nuance and adds the cheap-inspection context, but it does not materially extend the parameter-level meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Returns'), a precise resource ('resource identifiers linked from one Work Item through a single named relationship'), and the exact return shape ('JSON:API linkage ... without attributes'). It also names sibling alternatives so it is distinguishable from similarly named relationship tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says when to use this tool ('inspect one relationship cheaply') and when not to: use the Work Item get tool with include for embedded related resources, use post/patch/delete relationship tools to mutate, and use getLinkedWorkItems/getBacklinkedWorkItems for role-bearing Work Item-to-Work Item links. This is textbook when/when-not/alternative guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemTestParameterDefinitionARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| testParamId | Yes | The Test Parameter. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds cardinality context and names the plural alternative, but it does not add deeper behavioral details such as not-found behavior, revision semantics for the helper parameters, or response characteristics. This is modest supplemental context rather than rich behavioral disclosure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences front-load the purpose, state cardinality, and route to the sibling tool. There is no filler and every sentence carries useful selection or invocation context.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a fully described input schema, an output schema, read-only annotations, and an explicit sibling routing instruction, the description is sufficient for an agent to select and invoke this tool correctly. The remaining invocation details are carried by the schema, so nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are already documented in the schema. The description does not add parameter-level meaning beyond what the schema provides, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Returns'), the resource ('Test Parameter Definition'), and the scope ('for the specified Work Item'). It also distinguishes itself from the plural sibling by explicitly stating cardinality: 'targets a single item by ID.'
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly tells the agent when to use this tool vs the alternative: 'For the full collection or a batch, use getWorkItemTestParameterDefinitions instead.' It also implies use for single-item retrieval, making the routing decision unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkItemTestParameterDefinitionsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds minimal extra behavioral context beyond 'returns a list' and cardinality; it does not contradict annotations but also doesn't disclose additional behavior such as pagination semantics or empty-result behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. It front-loads the core function, then adds the cardinality nuance and sibling routing. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich schema with 100% parameter coverage, annotations, and an output schema, the description is sufficient for an agent to select and invoke the tool correctly. The only slight gap is that 'full collection or a batch' is a bit vague, but it does not block correct usage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all seven parameters are documented in the schema itself. The description adds no significant parameter-level meaning beyond what the schema already provides, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns a list of Test Parameter Definitions for a specified Work Item, using a specific verb and resource. It also explicitly differentiates from the singular sibling tool getWorkItemTestParameterDefinition, so an agent can distinguish them immediately.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit guidance on when to use this collection/batch tool versus the singular alternative. It states the cardinality ('full collection or a batch') and names the exact sibling to use for a single item by ID, leaving no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkRecordARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| workRecordId | Yes | The Work Record ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and openWorldHint=true, and the description's 'Returns' is consistent with that. Beyond the annotations, it adds behavioral detail by enumerating the exact fields returned (date, time spent, type, comment, user), which is useful context for selecting this tool. It doesn't contradict annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three terse, front-loaded sentences: first states purpose and return content, second gives the removal alternative, third clarifies cardinality and the batch alternative. No filler, every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return format is covered structurally. The description covers the essential usage ambiguity (singular vs. plural), names the deletion sibling, and scopes the tool precisely. With annotations and schema covering the rest, nothing is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% – all six parameters (fields, include, revision, projectId, workItemId, workRecordId) have descriptive text. The description itself adds no additional parameter-specific semantics beyond implying the ID parameters are key for the lookup, so it's at the baseline for a fully documented schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns'), a specific resource ('one work record'), and a clear scope ('on a Work Item by its ID'). It explicitly lists the returned fields (date, time spent, type, comment, user) and distinguishes itself from `getWorkRecords` (plural) by noting cardinality, so an agent cannot confuse it with the batch counterpart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit guidance: 'To remove it use `deleteWorkRecord`' and 'For the full collection or a batch, use `getWorkRecords` instead.' This clearly tells an agent when to choose this tool versus alternatives, leaving nothing to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
getWorkRecordsARead-only
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.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set. | |
| include | No | Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| page_size_ | No | Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| page_number_ | No | 1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No | |
| meta | No | |
| links | No | |
| included | No | Related entities might be returned, see <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true and openWorldHint=true, lowering the burden on the description. The description adds useful behavioral context beyond those hints: it targets the full collection or a batch, scopes results to one Work Item, and describes the shape of each returned record. It does not mention paging behavior or rate limits, but the schema and output schema cover most mechanics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three concise sentences with no wasted words. It front-loads the core behavior, then gives the use case, then disambiguates against sibling tools with cardinality guidance. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input-schema descriptions, the presence of an output schema, and read-only annotations, the description covers what an agent needs to decide when and how to call it. It addresses purpose, scope, cardinality, and sibling routing; the remaining details are already structured in the schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all seven parameters are already documented in detail. The description itself adds little parameter-level meaning, though the statement that this targets the full collection or a batch helps contextualize pagination-related parameters. Baseline 3 is appropriate because the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Returns') and resource ('work records... logged on one Work Item') and enumerates the fields returned. It explicitly distinguishes itself from both postWorkRecords (write operation) and getWorkRecord (single record), so an agent can immediately identify its purpose among siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives an explicit use case ('Use it to report effort spent on an item'), a direct alternative for logging time ('to log time use postWorkRecords'), and a direct alternative for single-item retrieval ('use getWorkRecord instead'). This is clear routing guidance with no ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
importExcelTestResultsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | Excel import meta data and file data. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, it explains that this is a server-side action whose repeat behavior depends on the action, reinforcing idempotentHint=false. It also discloses an important quirk: dry-run previews come back as error-flagged output and the text content should still be read. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with the purpose first, then the important behavioral caveat, then the actionable tip and output-flag warning. No filler or repeated schema text.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex import tool with an output schema and fully documented parameters, it covers the non-obvious parts: idempotency uncertainty, dry-run validation, and how to interpret the error-flagged preview. The requestBody remains opaque, but the dry-run instruction gives the agent a safe way to learn the exact payload shape.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters, including dry_run's redaction and binary summary behavior. The description's dry_run tip adds usage context but no new parameter semantics beyond what the input schema provides; baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The first sentence states a specific action and resource: 'Imports Excel test results.' The Excel qualifier distinguishes it from the sibling importXUnitTestResults and from the many get/patch test-run tools, so an agent can tell what this tool is for without needing the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives concrete operational guidance: run with dry_run true first to preview the request, and treat the action as not guaranteed idempotent. It does not explicitly name a when-not alternative such as importXUnitTestResults for other result formats, but the safety and preview guidance is clear enough to invoke responsibly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
importWordDocumentA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Multipart form data with 'file' (binary .docx) and 'parameters' (JSON object with documentName, title, documentType, and optional configurationId). |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds substantial behavioral detail beyond annotations: it explains that the tool triggers a server-side action, that repeated execution may be unsafe, a no-op, or rejected, and that dry-run previews come back as error-flagged results. This is all valuable context that the annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is organized with a clear purpose statement, an effect warning, and a practical tip. Every sentence earns its place; the dry-run and error-flag notes are dense but relevant, with no unnecessary filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a server-side import tool with an output schema, the description covers the key operational caveats: non-idempotency, dry-run behavior, and how to interpret error-flagged previews. It does not need to describe return values because an output schema exists, and the available context is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so parameters are already well documented. The description adds extra meaning specifically for `dry_run`, explaining that it previews the exact request without changing anything, which improves the agent's understanding of that parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action: 'Imports a Word document to create a new Polarion Document.' It further distinguishes the tool from a 'plain resource creation' by explaining that it triggers a server-side action, which helps an agent understand this is a specialized import operation rather than a generic create.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear operational guidance, including a concrete suggestion to set `dry_run: true` first and a warning that idempotency is not guaranteed. It does not explicitly name alternatives like postDocuments or state when not to use this tool, so it misses the full 5, but the context is clear and actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
importXUnitTestResultsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | XUnit File. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=false and readOnlyHint=false. The description adds valuable nuance: it explains the action is server-side, safety of repetition depends on the action, and that the dry-run preview is returned as an error-flagged result. This goes beyond annotations and helps the agent interpret responses correctly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately long but every sentence adds value: purpose, behavioral caveat, and a practical tip. It is front-loaded with the core action and then details. No wasted words, though it could be slightly tightened.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (4 params, output schema present), the description covers essential behavior: idempotency, dry-run preview, and error-flag handling. It doesn't detail the return format, but that's covered by the output schema. No critical gaps for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema fully documents all four parameters including dry_run, projectId, testRunId, and requestBody. The description reinforces the dry_run tip but adds no new semantic meaning beyond the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Imports XUnit test results' with a specific verb and resource. It further clarifies it's a server-side action, distinguishing it from plain resource creation, and the tool name itself differentiates from importExcelTestResults. No ambiguity about what it does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides a strong usage tip: set dry_run: true to preview without side effects, which guides safe invocation. However, it does not explicitly contrast with alternative tools like importExcelTestResults or postTestRecords, though the XUnit/Excel distinction is implicit in the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
markProjectA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Create project parameters. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Description discloses async job execution, return of jobs resource, need to poll getJob, and non-idempotent behavior, which go beyond the annotations. Also explains dry_run's error-flagged result.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is somewhat long but each sentence adds distinct value: purpose, async execution, usage distinction, idempotency caveat, and dry_run tip. It is front-loaded with the core purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers operation semantics, async nature, idempotency uncertainty, dry_run workflow, and directs to sibling tools. Output exists as schema. For a complex non-idempotent operation, this is thorough.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema already covers all parameters with descriptions (100% coverage). The description paraphrases the requestBody fields but adds context that location is a repository folder and projectId is new, though this is marginal. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Registers an existing repository folder as a Polarion project', and explicitly contrasts with unmarkProject and createProject. This distinguishes it from sibling tools clearly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says 'Use it to re-attach project data that already exists in the repository; to create a brand-new project use createProject' and notes it's the inverse of unmarkProject. Also gives async polling guidance and dry_run tip.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
mergeDocumentFromMasterA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | No | Merge Document parameters. | |
| documentName | Yes | The Branch Document Name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the annotations by explaining this is a server-side action, not a plain resource creation, and that it is not guaranteed idempotent. It also discloses how dry_run results are returned as error-flagged output, which is important behavioral context an agent could not infer from annotations alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact, with the core action stated first, followed by essential behavioral caveats and a practical tip. Every sentence contributes useful information without fluff or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the action, side-effect profile, idempotency concern, dry_run workflow, and how to interpret preview results. With an output schema present, return-value details are already covered. It would be more complete with explicit guidance about when to use this versus the sibling mergeDocumentToMaster, but it is otherwise sufficient for safe invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters. The description reinforces the dry_run behavior but does not add substantial new meaning to individual parameters; the baseline of 3 is appropriate since the schema carries the parameter-semantics burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action ('Merges Master Work Item changes to the specified Branched Document') with a clear verb and resource. It also makes the direction explicit ('from Master' to branched document), which distinguishes it from the sibling mergeDocumentToMaster without requiring schema inspection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description includes a clear tip to use dry_run first and warns about idempotency, but it does not explicitly state when to choose this tool over alternatives such as mergeDocumentToMaster or branchDocuments. Usage context is implied by the action and direction, but no explicit exclusions or alternative-conditions are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
mergeDocumentToMasterA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | No | Merge Document parameters. | |
| documentName | Yes | The Branch Document Name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond annotations by explaining that the tool 'triggers a server-side action rather than a plain resource creation,' that idempotency is not guaranteed, and that dry_run can preview the request without changing anything. This adds meaningful behavioral context consistent with idempotentHint=false and openWorldHint=true.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately sized and front-loaded with the core purpose. Every sentence contributes useful information—purpose, side-effect/idempotency caveat, and dry_run guidance—though the idempotency explanation could be slightly tightened.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's server-side action nature and the existence of an output schema, the description adequately covers side effects, idempotency, and dry_run usage. It does not explicitly route to the opposite-direction sibling, but the schema and directionality provide enough context for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds value by clarifying the dry_run behavior, especially the note that the preview is returned as an error-flagged result even though it is not real tool output. This enriches the schema's dry_run description without repeating all parameter details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb and resource: 'Merges Work Item changes from specified Branched Document to Master.' The directionality clearly distinguishes it from the sibling mergeDocumentFromMaster, so an agent can understand what this tool does without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description states the operation and its direction, which implies the tool is for moving changes from a branched document to the master. However, it does not explicitly mention when to prefer this tool over mergeDocumentFromMaster or other merge-related alternatives, leaving the selection partly to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
moveDocumentPartsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| partId | Yes | The Document Part ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | References for repositioning Work Item Document Part in the Document. | |
| documentName | Yes | The Document name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well beyond the annotations: it elaborates on idempotentHint=false by explaining that a repeat may be safe, a no-op, or rejected, adds the server-side-action nature of the call, and discloses the dry_run preview behavior including that previews come back as error-flagged results. This is consistent with annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=true), so there is no contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose and effect are front-loaded, but the first sentence is a long multi-clause construction, and the closing clause about 'tools with a typed output schema' is conditionally scoped generic boilerplate for a tool that has no output schema, adding confusion rather than value. Compact overall, but not every clause earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation with no output schema and a nested requestBody, the description covers the non-obvious parts an agent needs: idempotency uncertainty, the preview mechanism, and how to interpret error-flagged preview results. It does not describe the success response shape, which would have helped given the absence of an output schema, but the fully documented parameters soften that gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline of 3 applies since the schema already documents all six parameters. The description's mention of `dry_run: true` reinforces the dry_run parameter's purpose but adds no meaning beyond the schema's own field description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening phrase 'Moves a Work Item Document Part' states a specific verb and resource, immediately distinguishable from the many get/post/delete Part tools. The 'Effect: triggers a server-side action rather than a plain resource creation' clarifies it is not a simple POST like postDocumentParts. However, it never explicitly contrasts with moveToDocument/moveFromDocument/moveWorkItemsToDocument, leaving sibling differentiation largely implicit.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a strong practical invocation tip ('set `dry_run: true` first') and warns about the consequences of repetition, which an agent can act on. But it never names an alternative tool or states when to prefer this one, so the when-to-use guidance is implied rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
moveFromDocumentA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond annotations by clarifying that the Work Item itself is kept with all fields and links, only the Document placement is removed. It also discloses that this triggers a server-side action, is not guaranteed idempotent, and explains dry-run behavior, all of which are non-obvious and not available from annotations alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and every sentence adds meaningful guidance: the reverse tool, idempotency caveat, dry-run tip, and how to interpret the preview result. It is appropriately detailed without being bloated.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 3-parameter, no-output-schema mutation tool, the description is complete: it explains the effect, what is preserved, the idempotency risk, the safe dry-run path, and the inverse sibling. An agent has enough context to decide when to call it and how to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents projectId, workItemId, and dry_run. The description reinforces dry_run's purpose, but it does not need to add parameter meaning because the schema covers it thoroughly.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: it removes a Work Item's placement from a Document and returns it to the project's plain Work Item tracker. It also distinguishes itself from its direct reverse sibling by naming moveToDocument, so an agent can disambiguate without opening other schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says 'Use moveToDocument for the reverse,' giving clear when-to-use vs. alternative guidance. It also adds a concrete usage tip to set dry_run: true first for a safe preview, which helps the agent decide how to invoke the tool safely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
moveProjectActionA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Move project parameters. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds meaningful behavioral context beyond the annotations: it explicitly states the action is not guaranteed idempotent, explains that repetition may be safe, a no-op, or rejected depending on the action, and describes the dry-run preview behavior including the error-flag quirk. This is valuable transparency that annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured: purpose first, then behavioral caveats, then an actionable dry-run tip. Every sentence contributes useful information, and the most critical guidance is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is complete for a tool of this complexity: it covers the action's semantics, idempotency caveat, safe preview path, and output-schema-related behavior. Since an output schema exists, return value documentation is not the description's responsibility, and nothing essential for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameter semantics are already fully documented in the input schema. The description adds little new parameter meaning beyond reinforcing the dry_run behavior, so the baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: "Moves project to a different location," which clearly states the operation. It further distinguishes itself by explaining this is a server-side action rather than a plain resource creation, separating it from related project tools like createProject or patchProject.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear practical guidance: set `dry_run: true` first to preview the request without changing anything, and explains how the preview result is flagged when an output schema exists. It does not explicitly name alternative tools or state when-not-to-use it, but the context and dry-run tip provide sufficient usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
moveToDocumentA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | Moving Work Item to Document parameters. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already include idempotentHint=false tolerant, but the description goes further: it explains the server-side action nature, cautions that repeats may be safe, no-ops, or rejected, and advises using dry_run. It also discloses the error-flagged preview behavior, which is exactly the kind of context that helps an agent handle this tool correctly. No contradiction exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose. Each sentence serves a purpose. The final sentence about typed output schemas is conditional and not directly applicable to this tool (which has no output schema), making it slightly tangential, but it is still relevant for understanding dry_run behavior across tools.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a nested requestBody (nextPart, previousPart, targetDocument) and no output schema, the description does not fully explain what 'the Document' refers to or how the nested fields affect the move. The dry_run tip provides a safety net, but the overall operation remains somewhat opaque. The description is a minimum-viable definition rather than a fully self-contained one.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so a baseline of 3 is warranted. The description adds value beyond the schema by explaining the significance of dry_run: previewing the exact request without side effects, and how to interpret the error-flagged result. It does not add anything about projectId or workItemId, but the schema descriptions for those are already strong.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb and resource: 'Moves the specified Work Item to the Document.' It is unambiguous about the primary action, but it does not explicitly differentiate itself from the sibling tool moveWorkItemsToDocument (which handles plural work items) or moveDocumentParts. The lack of sibling differentiation keeps it from a perfect score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no explicit guidance on when to use this tool versus alternatives. The description mentions the dry_run tip and non-idempotency, but does not state conditions like 'for multiple work items use moveWorkItemsToDocument' or note any prerequisites. An agent must infer usage from the name and schema, leaving clear gaps.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
moveWorkItemsToDocumentA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Moving Work Items to Document parameters. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds meaningful behavior beyond annotations: it warns that the operation triggers a server-side action, is not guaranteed idempotent, and may be no-op or rejected on repetition. It also explains the dry_run preview mechanics and the error-flagged result, adding valuable context not present in the idempotentHint/readOnlyHint annotations alone.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the main action, then adds the essential non-idempotence caveat, then the dry_run tip. Each sentence serves a distinct purpose with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutating tool with a nested request body, the description covers the key invocation concerns: action, non-idempotence, and a safe dry-run path. It does not explain success/failure return behavior or fully distinguish siblings, but the input schema describes the remaining parameter structure.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents dry_run, projectId, requestBody, and the workItemIds path format. The description reinforces dry_run behavior but adds little parameter meaning beyond what the schema provides, warranting the baseline score.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description states a specific action and resource: 'Moves multiple Work Items to the Document.' The verb and object are clear, though it does not explicitly differentiate from sibling tools like moveToDocument or moveFromDocument.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance about when to prefer this tool over the related moveToDocument/moveFromDocument or other move operations. The only usage hint is the dry_run tip, which advises a validation strategy rather than selecting among alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
overwriteDocumentPartsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Parameters for overwriting multiple Work Item Document Parts. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=false, but the description adds meaningful context: it explains that the operation triggers a server-side action rather than a plain resource creation, that effects vary by action, and that dry_run returns an error-flagged result for preview. This goes beyond the annotations and helps the agent understand expected behavior without contradicting any hint.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is four sentences and stays focused. It front-loads the core purpose, then explains the effect, then offers a tip, and finally clarifies the error flag. Every sentence contributes value, though it could be tightened by removing the slightly repetitive 'whether repeating it is safe...' phrasing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested requestBody, 5 parameters, output schema), the description covers key aspects: idempotency, dry_run behavior, and how to interpret the preview result. It does not explain what a successful overwrite returns, but the output schema likely covers that. It is sufficiently complete for an agent to invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are already documented in the schema. The description mentions dry_run and its purpose, but that is also in the schema. It does not add semantic meaning beyond what the schema provides, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description starts with 'Overwrites multiple Work Item Document Parts,' which is a specific verb-resource pair. It clearly distinguishes this as an overwrite operation, contrasting with sibling tools like postDocumentParts (creation) and deleteDocumentParts (deletion). The purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not explicitly state when to use this tool versus alternatives like postDocumentParts or patchDocumentPart. It mentions behavioral traits (server-side action, non-idempotent) but provides no guidance on selecting this tool over siblings. It lacks explicit when-to-use or when-not-to-use instructions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchAllWorkItemsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The Work Item(s) body. | |
| workflowAction | No | The Workflow Action. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly states 'not guaranteed idempotent' and warns of additional side effects, but the annotations declare idempotentHint=true. This is a direct contradiction. The description does provide useful transparency about side effects and dry_run behavior, but the contradiction with the annotation is a serious inconsistency that undermines trust, so it scores 1.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with purpose and scope, then provides an alternative, side effects, and a dry_run tip. It is a bit lengthy but each sentence serves a clear purpose and adds value. It earns a 4 for being well-structured and informative without unnecessary fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers scope, side effects, and dry_run behavior, which is substantial. However, the contradiction regarding idempotency makes it misleading about a critical aspect, and it does not fully explain the workflow action side effects in detail. Given the complexity of the tool and the absence of an output schema, it is not fully complete, so a 3 is justified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema description coverage is 100% for the three parameters (dry_run, requestBody, workflowAction), so the schema already documents them. The description adds a tip about dry_run behavior and error-flagged results, which adds context but not parameter-specific semantics beyond what the schema provides. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Updates' and the resource 'a list of Work Items', and explicitly scopes it to the Global context with no project filter. It distinguishes itself from the sibling patchWorkItems by noting the single-project alternative, making its purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit guidance on when to use this tool (global, multi-project updates) and directs the user to patchWorkItems for single-project actions. It also provides a concrete recommendation to use dry_run for preview, which is a clear usage guideline.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchCollectionsBIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Collection(s) body. | |
| collectionId | Yes | The Collection ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses idempotent behavior and the meaningful detail that calling again with the same input causes no additional side effects. It also goes beyond annotations by explaining the dry_run preview and warning that preview results may be returned with an error flag while still containing valid text content.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded with the core action. The dry_run tip earns its place because it prevents a likely misinterpretation, though the idempotence statement partially repeats the idempotentHint annotation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complex nested requestBody and the absence of an output schema, the description covers idempotence and dry_run but does not explain what the tool returns, how partial attribute updates merge, or how relationship fields are handled. This leaves some ambiguity for an agent calling a complex mutation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents projectId, collectionId, requestBody, and dry_run. The description adds no parameter semantics beyond confirming and promoting the dry_run workflow, which matches the baseline of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it 'Updates the specified Collection,' identifying a specific verb, resource, and scope. It is distinguishable from create/delete/relationship-oriented siblings like postCollections or patchCollectionsRelationships, though it does not explicitly name an alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance explains when to prefer patchCollections over related tools such as postCollections, deleteCollection, closeCollection, or patchCollectionsRelationships. The dry_run tip is operational advice within this tool, not guidance about tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchCollectionsRelationshipsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Relationship body. | |
| collectionId | Yes | The Collection ID. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly discloses idempotent behavior ('calling it again with the same input leaves the resource in the same end state, with no additional side effects') and provides a detailed dry_run tip, including how the preview is returned as an error-flagged result. This adds value beyond the annotations, which already mark idempotentHint=true. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact (3 sentences) and front-loaded with the core purpose. The idempotence and dry_run details are relevant and efficiently stated. Slightly longer than minimal but every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers behavior (idempotence, dry_run) but does not describe the response format or what the tool returns on success/failure. With no output schema, this is a gap. The complex requestBody with oneOf is not elaborated in the description, though the schema provides structure. Overall, it covers behavior but lacks return-value context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters (projectId, collectionId, relationshipId, requestBody, dry_run). The description itself adds no parameter-specific meaning beyond what the schema provides. Per calibration, baseline 3 is appropriate when schema covers parameters fully.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Updates a list of Collection Relationships.' It clearly distinguishes from sibling get/post/delete relationship tools by the patch verb and resource scope. The purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not provide explicit guidance on when to use this tool versus alternatives like postCollectionsRelationships (create) or deleteCollectionsRelationship (delete). It implies updating existing relationships but never states when to choose this over other relationship tools. No exclusions or context about prerequisites are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchCommentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Comment body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explains idempotency in prose ('calling it again with the same input leaves the resource in the same end state'), going beyond the idempotentHint annotation. It also discloses the dry_run preview behavior and warns that the preview may surface as an error-flagged result. This is valuable behavioral context for a mutation tool with no output schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: purpose first, then idempotency, then the dry-run tip. The final sentence about typed output schemas is slightly generic and adds a small amount of complexity, but the overall structure is efficient and readable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Required parameters, the nested requestBody shape, idempotency, and dry-run behavior are all covered by the schema plus prose. The main gap is that the actual success response or return value is not described, which is more significant because no output schema is present.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already carries the parameter documentation. The description adds the `dry_run: true` tip but does not explain projectId, workItemId, commentId, or requestBody beyond what the schema provides. The baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a precise verb and resource: 'Updates the specified Work Item Comment.' The 'Work Item Comment' qualifier distinguishes it from sibling tools like patchDocumentComment, patchPageComment, and patchTestRunComment. Despite the generic tool name, the scope is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied: this is the tool for updating a Work Item Comment, and the dry_run tip gives practical how-to guidance. However, it never explicitly states when to choose this tool over sibling comment-patch tools or when not to use it. No alternatives are named.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchCustomFieldAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| requestBody | Yes | Custom Fields Body | |
| resourceType | Yes | The Resource Type. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description explicitly explains idempotency in plain language and details the dry_run preview behavior, including the error-flagged result quirk. This materially helps an agent predict side effects and interpret outputs, with no contradiction to annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the purpose and is generally concise. The final sentence about typed output schema is somewhat long and could be trimmed, but the overall structure is clear and each sentence adds information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers idempotency and dry_run, and the schema handles parameter meanings. However, it fails to distinguish this tool from the identically-purposed sibling patchProjectCustomFields, which is a notable completeness gap for a tool-selection scenario. Given the large sibling list and lack of output schema, more context would be expected.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so per rubric the baseline is 3. The description's dry_run tip adds usage advice but no new semantic meaning; all parameter semantics are already in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action ('Updates') and resource ('Custom Fields in the Project context'), which clearly conveys what the tool does. It does not explicitly differentiate from the closely named sibling patchProjectCustomFields, but the purpose is still understandable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as patchProjectCustomFields or patchGlobalCustomFields. The dry_run tip is a how-to-use hint, but not a when-to-use instruction, so the agent receives no decision support between similar patch tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchDocumentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Document body. | |
| documentName | Yes | The Document name. | |
| workflowAction | No | The Workflow Action. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly states 'Effect: not guaranteed idempotent' and details side effects of re-running workflow actions. However, the annotations declare 'idempotentHint': true, which directly contradicts this. This is a serious inconsistency that could mislead an agent about the tool's behavior. The description contradicts the annotation, so this dimension fails.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately long but each sentence serves a purpose: the purpose, the non-idempotency warning, the dry-run tip, and the error-flag explanation. It is front-loaded with the core purpose and effectively structured. No fluff, though it could be slightly tighter.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with no output schema, the description covers the essential context: it explains side effects, suggests a safe preview, and clarifies an error-flag quirk. It doesn't detail the exact response on success, but that is not required. Given the complexity and the absence of an output schema, this is reasonably complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all parameters. The description adds marginal value by explaining the dry_run behavior (returns error-flagged preview), but this is more about output than parameter semantics. The baseline of 3 is appropriate given the high schema coverage; the description doesn't compensate for any gaps because there are none.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Updates the specified Document.' This clearly states the action and target, and the mention of triggering workflow actions adds specific behavioral detail that distinguishes it from generic update tools. While it doesn't name sibling alternatives, the purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a concrete usage tip: 'set dry_run: true first to preview the exact request Polarion would receive, without changing anything.' This gives a safe-practice guideline and implies when to use this tool carefully. It doesn't explicitly exclude alternatives, but the dry-run advice is actionable and contextually relevant.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchDocumentAttachmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | No | Attachment metadata and file data. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| documentName | Yes | The Document name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations (readOnlyHint=false, idempotentHint=true), the description elaborates the idempotent effect: 'calling it again with the same input leaves the resource in the same end state, with no additional side effects'. It also discloses the dry_run preview behavior, including the error-flagged result caveat, and notes that the attachment keeps its ID. This meaningfully extends what annotations alone would tell an agent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and resource, then alternatives, then effect, then dry_run tip. All sentences contribute unique information, but the dry_run paragraph is slightly verbose and includes a generic note about typed output schemas that does not apply to this tool (since output schema is false). It remains focused and efficient overall.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a PATCH operation with no output schema, the description covers purpose, alternatives, effects, and parameter semantics comprehensively. It lacks explicit mention of return values on success and does not state that requestBody is optional per schema (required fields exclude it), but given the tool's complexity and available annotations, an agent can invoke it correctly. The dry_run note partially substitutes for output expectations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, giving baseline 3, but the description adds crucial semantics for requestBody: it clarifies the internal structure (requestBody.resource for metadata, requestBody.content for base64 bytes). It also defines dry_run's behavior. However, requestBody remains typed as a string in the schema, and the description implies an object structure, which could confuse but is a schema issue rather than a description deficiency.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Updates' and the resource 'one existing Document attachment', specifying what changes (metadata via requestBody.resource and optional file replacement via requestBody.content). It explicitly differentiates from siblings by naming postDocumentItemAttachments for adding new files and getDocumentAttachmentContent for reading, so an agent can select the correct tool unequivocally.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit when-to-use guidance: 'Use this to rename or re-upload a file that already exists'. It also names the exact alternatives for add (postDocumentItemAttachments) and read (getDocumentAttachmentContent), leaving no ambiguity. The dry_run tip adds practical invocation guidance without confusing the decision context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchDocumentCommentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Comment body. | |
| documentName | Yes | The Document name. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description elaborates the idempotentHint annotation with a concrete explanation of idempotency ('leaves the resource in the same end state, with no additional side effects'), which adds meaning beyond the annotation flag. It also discloses a non-obvious behavioral quirk: the dry_run preview is 'returned as an error-flagged result' and agents should 'read the text content regardless of that flag.' This is genuinely useful context not captured in annotations or schema.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences with the core purpose front-loaded and no redundant phrasing. However, the third sentence contains a conditional caveat ('On tools with a typed output schema') that does not apply to this tool, which has no output schema, making part of the guidance tangentially irrelevant for this specific tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with 6 parameters including a nested requestBody and no output schema, the description is adequate but sparse: it covers idempotency and the dry_run workflow, and the schema carries full parameter documentation. It does not describe success responses, error behavior, or what the update actually changes on the resource (e.g., resolved field), which an agent might need when predicting outcomes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description's dry_run tip complements the dry_run parameter documentation by explaining the preview workflow, but it does not add meaning for projectId, spaceId, commentId, documentName, or requestBody beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Updates the specified Document Comment.' This clearly identifies the operation and its target. However, it does not explicitly name sibling alternatives like patchPageComment or patchComment, so differentiation relies on the resource qualifier rather than the description itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The dry_run tip provides actionable usage guidance: 'set dry_run: true first to preview the exact request Polarion would receive, without changing anything.' This implies a safe validation-first workflow but does not state when to use this tool versus alternatives, nor does it give explicit exclusions or prerequisites beyond what the schema already documents.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchGlobalCustomFieldsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| requestBody | Yes | Custom Fields Body | |
| resourceType | Yes | The Resource Type. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explains idempotence in plain language beyond the idempotentHint annotation, and details the dry_run preview behavior, including the error-flagged result quirk. This adds meaningful behavioral context that annotations alone don't provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences plus a tip, front-loading the core action and then adding idempotence and preview guidance. Every sentence earns its place; it's efficient and well-organized.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with nested requestBody, the description covers idempotence and preview, and the schema covers parameters. It doesn't describe return values, but no output schema exists, and the key operational concerns (side effects, preview) are addressed. The global vs project distinction is implicit but sufficient given the sibling set.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All parameters have descriptions in the schema, and the tool description adds no extra meaning beyond what the schema already provides. The dry_run tip references the parameter but doesn't expand on its semantics beyond the schema's own description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Updates'), a specific resource ('Custom Fields'), and a scope ('Global context'), which clearly distinguishes it from project-specific siblings like patchProjectCustomFields. The name and description together leave no ambiguity about the target.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage in the global context and provides a concrete tip (dry_run) for safe previewing. It doesn't explicitly contrast with alternatives like patchCustomField or postGlobalCustomFields, but the context is clear enough for an agent to infer the appropriate scenario.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchGlobalEnumerationAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| enumName | Yes | The Enumeration Name. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| enumContext | Yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) | |
| requestBody | Yes | The Enumeration(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true and destructiveHint=false; the description reinforces idempotency and adds the dry_run preview behavior, including the caveat that previews are returned as error-flagged results. This extra context helps the agent interpret unexpected errors. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is moderately sized and front-loaded with the most critical scope information. Each sentence serves a purpose: scope, alternative, idempotency, and dry_run tip. Slightly verbose at the end with the error-flag note, but not wasteful.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the annotations cover idempotency and non-destructiveness, and the dry_run tip addresses the main invocation concern, the description is complete for navigation. The absence of an output schema is offset by the clear scope and behavior; an agent can infer a typical patch response. Minor gap: no explicit indication of what a successful response contains.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all parameters. The description adds value by explaining the dry_run parameter's behavior (preview request, redacted authorization, summarized binaries), but does not deepen understanding of enumContext, enumName, or targetType beyond their schema definitions. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Updates'), resource ('Enumeration'), and scope ('Global context'), and immediately differentiates from the sibling `patchProjectEnumeration`. An agent can confidently distinguish this tool from its project-scoped alternative.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool (global scope, no project filter) and names the alternative `patchProjectEnumeration` for single-project operations. It also gives a practical tip about using `dry_run: true` for previewing, which is actionable guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchLicenseAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The License body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide idempotentHint, readOnlyHint=false, and destructiveHint=false, and the description goes beyond them by spelling out the idempotency end-state guarantee. It also explains the dry_run behavior: previewing the exact request, redacting auth, summarizing binaries, and returning the preview as an error-flagged result. No annotation contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The tool purpose and caveats are front-loaded in a compact first paragraph. However, the final sentence about tools with a typed output schema is not relevant here because this tool has no output schema, adding noise rather than value. The rest is efficient, but that misplaced conditional keeps it from scoring higher.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation with a fully documented nested requestBody and strong annotations, the description covers the platform limitation, idempotency semantics, and dry-run preview workflow. It does not document permissions or response shape, but with no output schema those omissions are acceptable. The only notable gap is the irrelevant output-schema warning, which is minor.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with both dry_run and requestBody already documented in the input schema. The description reinforces the dry_run parameter but adds no semantic meaning beyond the schema, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Opens with 'Updates the product License,' a specific verb and resource. 'Product License' distinguishes it from sibling tools like patchLicenseAssignments and setLicense, which operate on different license resources. The intended target is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives a clear exclusion: not supported by cloud-based Polarion, telling the agent when the tool cannot be used. It also prescribes a dry_run-first workflow to preview the request safely. It does not name alternative tools for other license operations, but the main usage context is explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchLicenseAssignmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The User License Assignment body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Although annotations already declare idempotentHint=true and readOnlyHint=false, the description adds concrete behavioral detail: repeated calls leave the same end state with no additional side effects, and dry_run previews the exact request without changing anything. It also explains the error-flagged preview convention. The description does not contradict any annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with purpose, sibling differentiation, idempotency, and the dry-run tip, each earning its place. The final sentence about tools with a typed output schema is conditional boilerplate and not directly relevant here since this tool has no output schema, which prevents a perfect score.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers purpose, cardinality, the batch alternative, idempotency, dry-run behavior, and the cloud limitation, which is strong for a single-item update tool. It does not describe the success response shape, and there is no output schema to fill that gap, but the dry-run note covers the most unusual output behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already describes all three parameters (userId, dry_run, requestBody), so schema coverage is 100%. The description adds useful cardinality and dry-run context but does not explain the nested requestBody structure beyond what the schema provides. Baseline 3 applies because the schema carries the parameter documentation burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Updates a user's License Assignment.' It immediately distinguishes this tool from the plural sibling patchLicenseAssignments by stating cardinality ('targets a single item by ID'), so an agent can select it correctly without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly names the alternative tool and the condition that selects it: 'For the full collection or a batch, use patchLicenseAssignments instead.' It also warns that cloud-based Polarion X is not supported and advises using dry_run first, giving clear when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchLicenseAssignmentsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The User(s) License Assignment body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry idempotentHint=trueasia, so the idempotency statement is somewhat redundant. However, the description adds important behavioral context beyond annotations: the dry_run preview semantics, including that the preview is returned as an error-flagged result on tools with typed output schemas. It also discloses the environment limitation. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than the simplest examples, but each sentence earns its place: purpose, unsupported environments, cardinality, alternative, idempotency, dry-run tip, and preview caveat. It is well-segmented with labels like 'Cardinality', 'Effect', and 'Tip', making it scannable despite its length. Slightly verbose but not wasteful.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested request body, dry_run flag, idempotent behavior, sibling alternatives, no output schema), the description covers all needed context: what it does, when to use it instead of the singular tool, unsupported platforms, idempotent semantics, and dry_run explaination. The schema already documents parameters and body structure, so nothing an agent needs to call this safely is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds a tactical tip about using dry_run first, but it does not materially expand on the parameter meanings already given in the schema (e.g., dry_run's redaction behavior and the requestBody structure are fully covered there). Thus it stays at the baseline without compensating for gaps.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description starts with a specific verb and resource: 'Updates the License Assignments of multiple users.' It clarifies cardinality ('targets the full collection or a batch') and explicitly differentiates from the sibling tool for a single item ('For a single item by ID, use patchLicenseAssignment instead'). This leaves no ambiguity about what this tool does or how it differs from the singular variant.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit usage guidance: it names the alternative for single-item cases ('use patchLicenseAssignment instead'), states a limitation ('Not supported by cloud-based Polarion X'), and recommends a workflow ('set dry_run: true first'). This is exactly what an agent needs to decide when to invoke this tool vs. the singular sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchLinkedWorkItemAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| roleId | Yes | The Role ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Work Item(s) body. | |
| targetProjectId | Yes | The Target Project ID. | |
| linkedWorkItemId | Yes | The Linked Work Item ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true, readOnlyHint=false, and destructiveHint=false. The description adds value by explaining the idempotent effect in plain language ('calling it again with the same input leaves the resource in the same end state') and by detailing the dry_run behavior, including that the preview is returned as an error-flagged result on typed output schemas. This goes beyond the annotations, though it doesn't cover every behavioral aspect (e.g., permission requirements).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, then scope exclusions, then idempotency, then the dry_run tip. Every sentence adds information. It's slightly dense with the parenthetical about error-flagged results, but that's necessary context for the dry_run behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with 7 parameters and no output schema, the description covers the key operational concerns: what is updated, what is not, idempotency, and how to preview safely. It doesn't explain return values, but with no output schema and a clear idempotent update operation, that's a minor gap. The dry_run tip partially compensates for the missing output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all 7 parameters. The description adds some context for workItemId ('not the combined project/id path used in some link payloads') and explains dry_run's behavior, but most parameter meaning is already in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Updates the direct outgoing links to other Work Items.' It also clarifies scope by excluding external links and backlinks, which helps distinguish it from sibling tools like postLinkedWorkItems, deleteLinkedWorkItems, and getWorkItemsRelationships. However, it doesn't explicitly name a sibling alternative, so it falls just short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context: it updates direct outgoing links, not external links or backlinks, and it is idempotent. It also provides a practical tip to use dry_run: true to preview the request. However, it doesn't explicitly state when to prefer this over alternatives like postLinkedWorkItems or patchWorkItemRelationships, so usage guidance is good but not fully explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchPageAttachmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | No | Attachment metadata and file data. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=false, idempotentHint=true, and destructiveHint=false; the description adds that the attachment keeps its ID, elaborates the idempotent effect (same end state, no side effects), and explains that dry_run returns an error-flagged preview. This is beyond the structured annotations and adds useful operational details.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but each clause contributes: purpose, sibling differentiation, idempotency, and a dry_run tip. The final sentence about typed output schemas is a slight distraction given this tool has no output schema, but it is still relevant to dry_run behavior. Overall it is structured and front-loaded with the main action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with no output schema, the description covers purpose, usage, idempotency, and dry_run semantics. It does not explicitly state the success return value, which is a minor gap. However, given the annotations and the level of detail elsewhere, an agent has enough to call the tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 100% schema description coverage, the schema already documents all six parameters. The description adds meaning by explaining that requestBody contains resource metadata and optional content bytes (base64), and clarifies that dry_run produces a preview without sending. This guides correct construction of requestBody beyond the generic schema text.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses the verb 'Updates' with a specific resource ('one existing Rich Page attachment') and details what is updated (metadata via requestBody.resource, optionally file content via requestBody.content). It explicitly distinguishes from siblings postPageAttachments and getPageAttachmentContent, so an agent can select it correctly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use this tool ('to rename or re-upload a file that already exists') and names the alternatives for adding a new file (postPageAttachments) and reading the current file (getPageAttachmentContent). Also notes the idempotent behavior, which influences repeated calls.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchPageCommentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Comment body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal idempotency, non-read-only, and non-destructive behavior; the description reinforces idempotency and adds specific caveats about the dry_run preview and error-flagged results. No contradiction with annotations exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and front-loaded, with the core purpose first, followed by idempotency and the dry-run tip. The third sentence is somewhat general and long, but it still conveys useful behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Rich annotations plus complete schema coverage cover most operational details, and the description adds the important dry-run preview behavior. The main missing element is usage guidance relative to sibling comment tools, but this is not critical given the clear purpose.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents every parameter including dry_run, projectId, spaceId, pageName, commentId, and requestBody. The description adds a dry-run workflow tip but does not add new parameter-level meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Updates the specified Page Comment,' which names a specific verb and resource. The 'Page Comment' noun phrase distinguishes this tool from siblings like patchComment and patchDocumentComment.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives such as postPageComments for creating comments or getPageComment for reading them. The dry-run tip describes how to call it, not when to choose it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchPageRelationshipsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false), the description explicitly states the idempotent effect and adds crucial dry_run behavior, including the nuance that the preview is returned as an error-flagged result. This provides valuable context that the annotations alone do not convey, and it does not contradict any annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, each earning its place: the first states purpose and idempotence, the second gives the dry_run tip, and the third clarifies the error-flag nuance. It is front-loaded with the core action and well-structured, with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Since there is no output schema, the description need not detail return values. It covers the key behavioral aspects (idempotence, dry_run) and the parameters are fully documented in the schema. It does not mention permissions or prerequisites, but for a patch operation with this level of schema documentation, it is reasonably complete. A 5 would require explicit guidance on when to use versus siblings, which is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already fully documents all six parameters, including the dry_run flag's behavior. The description's dry_run tip adds a small practical note (previewing without changes) but does not add meaning beyond what the schema already provides. The baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Updates') and a specific resource ('a list of Page Relationships'), which clearly distinguishes it from sibling tools like getPageRelationships, postPageRelationships, and deletePageRelationships. The action is unambiguous, and the parameter list reinforces the resource type (pageName, relationshipId).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for updating page relationships (as opposed to other relationship types like plan or work item relationships) through the resource-specific parameters, and the idempotence and dry_run tips provide practical guidance. However, it does not explicitly state when not to use this tool or compare it to alternative patch tools, so it falls short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchPlanAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The Plan ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Plan body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description elaborates on the idempotent behavior already hinted at in annotations, explicitly stating that calling it again with the same input leaves the resource in the same end state with no additional side effects. It also discloses the dry_run functionality and the behavior that preview results appear as error-flagged output. These details add value beyond the annotations (which only provide idempotentHint, destructiveHint, readOnlyHint). There is no contradiction with annotations; the description aligns with the non-read-only, non-destructive, idempotent flags.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured. It leads with the core purpose in a single sentence, then immediately provides the idempotency clarification and the dry_run tip. There is no unnecessary verbosity, and every sentence serves a distinct function. The front-loading of the primary action makes it easy for an agent to grasp the tool's purpose at a glance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has no output schema, so the description should ideally explain what the tool returns or what happens on success/failure. It does not mention the return value or error behavior beyond the dry_run preview. It also does not provide guidance on prerequisites or permissions, which might be relevant for a mutation tool. However, the schema is very detailed, covering the request body structure, and the annotations cover safety aspects. The description adequately covers the idempotency and dry_run behavior but leaves out return-value expectations and usage context, making it moderately complete but not fully sufficient for an agent to anticipate outcomes.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema provides 100% description coverage for all parameters, including detailed descriptions for dry_run, projectId, planId, and requestBody. The description adds no new parameter-specific semantics beyond what the schema already states. It mentions dry_run as a tip, but that information is already present in the schema's description. Since the schema handles the parameter documentation thoroughly, the description adds minimal value in this dimension.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Updates the specified Plan.' This is a specific verb and resource, and it is easy to understand that this tool modifies a Plan object. However, it does not explicitly differentiate itself from sibling tools like patchPlanRelationships, which also target Plans but for relationships specifically. The name and description together make it clear enough that it's about updating the Plan's core properties, but the lack of sibling differentiation prevents a perfect score.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides a tip about using dry_run but does not offer any guidance on when to use this tool versus alternatives such as patchPlanRelationships or patchProject. There is no mention of scenarios where this tool is appropriate or not, nor any exclusions. The only implied usage is 'when you need to update a Plan,' but there is no explicit comparison to other patch tools or conditions that would select one over another.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchPlanRelationshipsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The Plan ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Work Item(s) body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint: true and destructiveHint: false, but the description adds behavioral nuance by explicitly stating the idempotent effect and describing the dry_run preview behavior, including how the preview is returned as an error-flagged result. This goes beyond the annotations and provides essential operational context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is highly concise, conveying the main action and two crucial behavioral notes in two sentences. It front-loads the purpose and immediately clarifies idempotency, then provides the dry_run tip. No superfluous information is present, and the structure is easy to scan.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has no output schema, the description does not explain the normal return value (likely the updated resource). It does cover the dry_run preview case, but an agent calling this in a non-dry-run mode would not know what to expect back. The complex requestBody structure is documented in the schema, so that gap is acceptable. Overall, the description is adequate but lacks clarity on the standard response format.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters. The description does not add extra meaning beyond the schema for parameters like projectId, planId, relationshipId, or requestBody. It only reinforces the dry_run parameter already documented, offering no additional semantic enrichment. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a precise action ('Updates a list of Plan Relationships') with a clear resource target. It also distinguishes from sibling operations like postPlanRelationships (create) and deletePlanRelationship (delete) by specifying the update/patch semantics, so an agent can confidently select it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not explicitly state when to use this tool versus alternatives (e.g., 'use for existing plan relationships, not for creation'). However, it provides a valuable usage tip about dry_run and how to interpret the preview result, which helps the agent use the tool correctly. The 'updates' verbiage implies replacing create/delete, but no explicit alternative routing is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchProjectAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Project body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantive behavior beyond the annotations: it spells out that idempotent means the same end state with no additional side effects, explains dry_run preview semantics, and discloses that the preview may appear as an error-flagged result that should still be read. This does not contradict the annotations' readOnlyHint=false, idempotentHint=true, or destructiveHint=false.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the purpose, then behavior, then dry-run guidance. The final sentence about typed output schemas is slightly abstract for a tool without one, but it earns its place by explaining the error-flag behavior of previews.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description and schema together adequately cover idempotence, dry_run, and the nested request body. However, there is no output schema and the description never describes what a successful non-dry-run call returns, leaving an agent guessing about the normal success response.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already documents dry_run, projectId, and requestBody in detail, including the redaction behavior and the getProjects hint. The description only restates dry_run as a tip, adding no new parameter-level meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Updates the specified Project.' This clearly distinguishes it from the many sibling patch* tools by naming Project as the target resource, so an agent can identify what entity this tool affects without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies use for updating an existing project and offers a dry_run tip, but it does not explicitly name alternatives or state when not to use this tool versus getProject, createProject, or deleteProject. The operational guidance is helpful but does not fully address tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchProjectEnumerationAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| enumName | Yes | The Enumeration Name. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| targetType | Yes | Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type. | |
| enumContext | Yes | The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.) | |
| requestBody | Yes | The Enumeration(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint and destructiveHint, but the description adds valuable context by spelling out the idempotent effect ('same end state, no additional side effects') and the dry_run preview behavior, including the nuance that previews are returned as error-flagged results. It does not duplicate the safety profile entirely; it goes beyond the annotations with the dry_run explanation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose and scope, then adds the sibling alternative, idempotency, and the dry_run tip. Each sentence adds some value, though the idempotency statement partially duplicates the idempotentHint annotation, and the error-flag explanation could be trimmed. Still, it is well-organized and appropriately sized for a complex tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is thorough for usage and safety, but since the tool has no output schema, it would benefit from mentioning what the successful response contains (e.g., the updated enumeration). The dry_run tip partially addresses preview, but a patch operation normally returns a representation of the updated resource, and that is not disclosed. Given the nested request body complexity, this is a notable gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description does not add material parameter-level meaning beyond what the schema describes; it only reiterates the need for a project ID, which the schema already states. The dry_run tip is behavioral rather than parameter semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Updates'), resource ('Enumeration'), and scope ('in the Project context'). It also differentiates from the global variant by naming patchGlobalEnumeration and clarifying the project-ID requirement. An agent can distinguish it from siblings like postProjectEnumeration or deleteProjectEnumeration without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells when to use this tool (project-scoped updates) and when to use the alternative: 'To act across all projects, use patchGlobalEnumeration instead.' It also provides a practical tip about using dry_run to preview the request, which helps the agent choose the safe path first.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchRichPageAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Page body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate idempotent and non-destructive behavior; the description reinforces this by stating the effect is idempotent with no additional side effects. It adds the dry_run behavior detail (returns preview as error-flagged result), which is valuable beyond annotations. However, it doesn't disclose potential permission requirements or side effects like notification triggers, so slightly short of 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences that are information-dense. It front-loads the core function, then specifies alternatives, and then covers idempotency and dry_run. No wasted words; every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested objects, 5 params) and no output schema, the description adequately covers key aspects: what can be updated, when to use alternatives, idempotency, and dry_run guidance. However, it doesn't describe the response structure beyond the dry_run note, but that's a minor gap given the tool's nature.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so each parameter is already described in the schema. The description adds little beyond naming the attributes (title, homePageContent) and mentioning the dry_run parameter's purpose, but does not clarify the exact format of requestBody.data.attributes beyond what the schema already has. Baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool updates a Rich Page's title and/or homePageContent, and distinguishes it from creation (postPages) and LiveDoc editing (patchDocument). The purpose is specific and clearly separates it from siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides direct usage guidance: use for editing page text/metadata, use postPages for creation, patchDocument for LiveDoc Documents. It also explains idempotency and suggests dry_run for previewing, making the when-to-use explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRecordAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Record(s) body. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint: true and destructiveHint: false, so the idempotency statement partly duplicates structured data. However, the description adds the dry_run preview behavior (returning an error-flagged result for non-real output) which is beyond annotations and valuable. It also clarifies that idempotency means 'no additional side effects', reinforcing the non-destructive nature. This goes beyond the annotation flags.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three concise sentences: purpose and cardinality, the alternative tool, and effect plus dry_run tip. It is front-loaded with the most critical information and contains zero filler words. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with 7 parameters and no output schema, the description covers the key operational aspects: single-item cardinality, batch alternative, idempotency, and dry_run preview. It does not mention the response format or success/failure behavior, but given the schema's thoroughness and annotations, the gaps are minor. It could be more explicit about what the tool returns, but it is largely complete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% coverage—every parameter has a description. The tool description does not add any parameter-specific semantics beyond what the schema already provides; it only mentions dry_run in a usage tip, but the schema already describes dry_run's behavior. Thus it meets the baseline of 3 but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Updates the specified Test Record' with a clear verb and resource, and explicitly notes 'Cardinality: targets a single item by ID' to distinguish it from the plural sibling patchTestRecords. This makes the tool's purpose unambiguous and differentiates it from its batch counterpart.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly directs the agent: 'For the full collection or a batch, use `patchTestRecords` instead.' It also provides a concrete usage tip (dry_run preview) with clear instructions on how to interpret the preview response. This is explicit when-to-use and when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRecordAttachmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | No | Attachment metadata and file data. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide idempotentHint=true and destructiveHint=false. The description reinforces idempotency with a clear effect statement and adds context beyond annotations: the attachment keeps its ID, and the dry_run preview is returned as an error-flagged result. This adds value, though it partially duplicates the annotation. No contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, then states usage alternatives, then effect, then a tip. Every sentence contributes, but it is slightly verbose (e.g., the dry_run preview explanation is lengthy). Still, it is well-structured and scannable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a patch operation with 8 parameters, no output schema, and rich annotations, the description covers the essential context: what changes, when to use it, alternatives, idempotency, and a preview mechanism. No critical information an agent needs to correctly invoke the tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds meaningful semantics by clarifying that requestBody.resource holds metadata and requestBody.content holds base64 file bytes, which the schema's generic 'Attachment metadata and file data' does not convey. The dry_run behavior is also described in both schema and description, reinforcing but not merely repeating.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Updates') and resource ('one existing Test Record attachment'), and precisely defines the two actions (metadata update via requestBody.resource, optional file replacement via requestBody.content). It explicitly names sibling tools postTestRecordAttachments and getTestRecordAttachmentContent to differentiate scope, making purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use guidance: '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.' It also provides a dry_run tip, leaving no doubt about appropriate invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRecordsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Record(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry idempotentHint=true, but the description enriches this by spelling out the end-state semantics and the dry_run preview behavior, including the error-flag quirk. It doesn't mention permissions or failure modes, but for a mutating tool with this annotation coverage it adds meaningful behavioral context beyond the structured fields.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with core purpose, then sibling routing, then effect and tip. The conditional sentence about typed output schemas is slightly awkward and possibly inapplicable here since this tool has no output schema, but it is still informative.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex write tool with a nested requestBody and no output schema, the description covers what an agent needs to choose and invoke it: cardinality, idempotence, dry-run validation, and singular alternative. It does not describe the normal success response, but no output schema exists and the schema documents the body fully.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3; the description adds value by clarifying cardinality ('full collection or a batch') and recommending dry_run as a preview mechanism. It doesn't explain each nested field, but the schema already does, so the added guidance justifies one point above baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a concrete verb+resource ('Updates a list of Test Records') and immediately clarifies cardinality: full collection or batch. It explicitly names the singular sibling patchTestRecord, so an agent can distinguish batch vs single-item operations without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly says when not to use this tool: for a single item by ID, use patchTestRecord instead. The cardinality statement frames batch/collection usage, which is sufficient routing guidance among siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRunAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Run(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Explains idempotent behavior ('same end state, no additional side effects') and the dry_run preview behavior with the error-flagged result caveat. While idempotentHint already exists in annotations, the description adds the no-side-effects clarification and dry-run semantics.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, front-loaded with purpose and cardinality, then alternative and safety tip. Every sentence earns its place; no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers purpose, cardinality, sibling routing, idempotency, and a dry-run workflow. With no output schema, a brief note on return behavior might help, but the rich input schema and detailed annotations make this sufficient for a trained agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds value by tying testRunId to the single-item cardinality and by recommending dry_run: true as a preview mechanism, though most parameter detail already lives in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Updates the specified Test Run.' Adds cardinality ('targets a single item by ID') and distinguishes itself from patchTestRuns for batch operations, so an agent can tell them apart without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the alternative: 'For the full collection or a batch, use patchTestRuns instead.' The dry_run tip also gives concrete guidance on safe invocation, leaving little to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRunAttachmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | No | Attachment metadata and file data. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description discloses the concrete effect of the operation: the attachment keeps its ID, and the call is idempotent with no additional side effects when repeated with the same input. It also reveals the dry_run preview behavior and the trait that on typed output schemas the preview is returned as an error-flagged result, which is not visible in the schema or annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, uses labeled sections such as 'Effect:' and 'Tip:' to organize secondary details, and every sentence contributes operational value. The dry_run sentence is slightly extended, but it earns its place by warning about the error-flagged preview.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a PATCH tool with no output schema, the description covers everything needed to invoke it correctly: capability, sibling differentiation, idempotence, requestBody structure, and dry_run behavior. Required parameters are already documented in the schema, and no return-value contract is necessary for a modify operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds meaningful value by explaining the opaque `requestBody` parameter: metadata lives under `requestBody.resource` (e.g., `title`), and the optional replacement file is passed as base64-encoded bytes under `requestBody.content`. However, it does not explicitly state how `requestBody` should be serialized (e.g., JSON-encoded string) despite the schema type being `string`, leaving a small ambiguity.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource, 'Updates one existing Test Run attachment,' and details what can be updated: metadata via `requestBody.resource` and the stored file via `requestBody.content`. It also notes the attachment keeps its ID and explicitly names sibling tools (`postTestRunAttachments`, `getTestRunAttachmentContent`), so an agent can easily distinguish this operation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states when to use this tool: 'Use this to rename or re-upload a file that already exists.' It then contrasts that with alternatives: use `postTestRunAttachments` to add a new file, and `getTestRunAttachmentContent` to read the current file. This provides both positive and negative usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRunCommentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| commentId | Yes | The Comment ID. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Comment body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true and destructiveHint=false, so the description's idempotency note adds little beyond structured data. However, it adds valuable context about the `dry_run` behavior, including that the preview is returned as an error-flagged result, which is not present in annotations. This meaningfully improves the agent's understanding of side effects and output handling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-structured, starting with the core purpose, then cardinality, alternative, idempotency, and a practical tip. It is somewhat verbose but every sentence contributes useful information. It is not overly terse, and the logical flow aids comprehension.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with nested requestBody and no output schema, the description omits what the tool returns (e.g., the updated comment) and whether it performs a partial or full update. It also does not mention any prerequisites like required permissions. These gaps are noticeable for an agent deciding whether to call it and how to interpret the response.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description's dry_run tip largely reiterates the schema's parameter description. It adds a note about error-flagged output that is not in the schema, but this is more about output behavior than parameter semantics. Overall, the description does not significantly enhance parameter meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it 'Updates the specified Test Run Comment' and explicitly clarifies cardinality (single item by ID), distinguishing it from the batch sibling `patchTestRunComments`. This gives an agent an unambiguous understanding of the tool's function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly directs agents to `patchTestRunComments` for batch operations, providing a clear when-not and alternative. It also offers a usage tip (set `dry_run: true` to preview) that guides safe invocation, making the usage context very clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRunCommentsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Comment body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses idempotent behavior (consistent with annotations) and adds valuable context about the dry_run preview and its error-flagged result, which is beyond what annotations provide. Does not contradict any annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each adding distinct value (purpose, cardinality, idempotence, dry_run tip). Front-loaded with the core purpose, though the final sentence about error-flagged output is somewhat tangential but still informative.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Does not describe the success return value, and since there is no output schema, this is a notable gap. However, the tool's operation is simple and parameters are fully specified, so the gap is moderate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so all parameters are already documented in the schema. The description does not add additional parameter meaning, thus baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states it updates a list of Test Run Comments and explicitly distinguishes from the singular sibling patchTestRunComment, making its batch scope unambiguous. The purpose is specific and actionable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit guidance: use this for the full collection or a batch, and switch to patchTestRunComment for a single item by ID. Also includes a dry_run tip for safe preview, covering both when and how to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestRunsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Test Run(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explains the idempotent effect in detail ('calling it again with the same input leaves the resource in the same end state, with no additional side effects'), which goes beyond the idempotentHint annotation by clarifying what that means. It also discloses the `dry_run` behavior, including the error-flagged preview result, which is not covered by annotations. This adds valuable transparency without contradicting the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences long, front-loaded with the core purpose, then cardinality, then behavior and usage tips. Every sentence earns its place, with no redundancy or fluff. The structure is efficient and highly scannable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested requestBody, no output schema), the description covers the essential aspects: what it does, scope (batch vs single), idempotency, and the dry_run preview feature. It doesn't detail the response format, but with no output schema that is not expected. The missing piece is perhaps a more explicit note about the required parameters, but the schema already marks them as required. Overall, it is sufficiently complete for an agent to use correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides descriptions for all three parameters (projectId, requestBody, dry_run), so schema coverage is 100%. The description adds a small amount of context about cardinality ('targets the full collection or a batch') and a tip about dry_run, but does not significantly enhance the semantic understanding of the parameters beyond what the schema already states. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Updates a list of Test Runs') with a specific verb and resource, and immediately distinguishes this from the singular `patchTestRun` by noting cardinality and directing to the alternative. This makes the tool's purpose unambiguous and sets it apart from its siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says 'For a single item by ID, use `patchTestRun` instead', giving clear when-not-to-use guidance and naming the alternative. It also provides a practical tip about using `dry_run: true` to preview the request, which is actionable context for when to use this feature.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestStepAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Test Step(s) body. | |
| testStepIndex | Yes | The Test Step index. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description adds idempotency semantics ('same end state, with no additional side effects') and explains the dry-run preview behavior, including the non-obvious error-flagged result. This gives agents an accurate model of what happens before and after the call.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence earns its place: purpose, cardinality, sibling alternative, idempotency, and dry-run guidance are all packed in without redundancy. The most important scoping information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is highly complete for a single-item patch tool: it covers scope, alternatives, idempotency, and preview behavior, while the schema covers parameters. The only minor gap is that the expected return value is not described, and the typed-output-schema sentence may be slightly less relevant given this tool has no output schema.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema coverage is 100%, so the schema already documents all parameters thoroughly. The description references dry_run but does not add much parameter-specific meaning beyond what the schema provides, which meets the baseline but does not exceed it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Updates the specified Test Step') and explicitly narrows the scope to a single item by ID. It also distinguishes itself from the batch sibling patchTestSteps, leaving no ambiguity about what this tool targets.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly tells the agent when to use a different tool ('For the full collection or a batch, use patchTestSteps instead') and gives a concrete invocation strategy via the dry_run tip. This is exactly the kind of when-to-use guidance agents need.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestStepResultAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Step(s) body. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already include readOnlyHint=false, destructiveHint=false, and idempotentHint=true, so the description's job is lighter, but it still adds valuable context: it spells out what idempotent means in effect ('leaves the resource in the same end state, with no additional side effects') and explains in detail how `dry_run` behaves, including the quirk about error-flagged preview results. This goes beyond the annotation hints without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tightly packed sentences: the first states the core action, the second defines cardinality and the alternative, and the third covers effects and a dry-run tip. Every sentence carries distinct information, and the key differentiator (single vs. batch) appears immediately after the verb. No redundancy or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers everything an agent needs to invoke this tool correctly: what it does, that it targets one item, when to use the batch sibling, that it is idempotent, and how to preview the request safely. There is no output schema, but the description still manages to explain the dry-run error-flag behavior, and no other critical context (such as identifying the item via testStepIndex/iteration) is omitted.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%: every parameter (including `dry_run`, `iteration`, `requestBody`, etc.) already has a detailed description. The main description adds no new parameter-level semantics beyond a rephrasing of `dry_run`'s behavior in the tip, so the baseline of 3 applies — the schema does the heavy lifting and the description doesn't detract from it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific action and resource: 'Updates the specified Test Step Result.' It then clarifies cardinality ('targets a single item by ID') and explicitly names the sibling tool (`patchTestStepResults`) for batch operations, making the distinction from its collection-level counterpart immediate and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives an explicit routing rule: use `patchTestStepResults` for the full collection or a batch, and this tool for a single item. It also provides a practical tip (set `dry_run: true` first to preview the request), which is direct guidance on how to safely invoke the tool. No ambiguity remains about when to choose this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestStepResultAttachmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | No | Attachment metadata and file data. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses idempotent behavior, aligning with the idempotentHint annotation, and adds the dry_run behavior including the note about error-flagged preview results. It explains that the attachment keeps its ID and the effect of repeated calls, adding value beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than average but well-structured, front-loading the main purpose and then providing usage guidance, idempotency, and dry_run behavior. Each sentence adds value without unnecessary fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the 9 parameters and no output schema, the description covers all necessary aspects: what it does, when to use it, the effect of dry_run, idempotency, and the differentiation from siblings. An agent has enough information to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds meaning by explaining that requestBody.resource holds metadata and requestBody.content holds base64 bytes, which the schema merely labels as 'Attachment metadata and file data'. The dry_run parameter's behavior is also detailed in the description, beyond the schema's description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool updates an existing Test Step Result attachment, specifying it can rename metadata via requestBody.resource and re-upload content via requestBody.content. It explicitly distinguishes itself from siblings by naming postTestStepResultAttachments for adding and getTestStepResultAttachmentContent for reading.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says 'Use this to rename or re-upload a file that already exists' and names the alternatives for adding and reading. The dry_run tip also provides a concrete usage pattern for previewing requests, making it clear when to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestStepResultsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Step(s) body. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry readOnlyHint=false, idempotentHint=true, and destructiveHint=false. The description builds on them by explaining the idempotency consequence ('same end state, with no additional side effects'), the collection/batch cardinality, and a genuinely non-obvious quirk: the dry_run preview surfaces as an error-flagged result and must be read from the text content. It could also state what 'full collection' precisely covers, but it does not contradict the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four front-loaded sentences: purpose and cardinality first, sibling routing second, then behavioral detail. Every sentence earns its place; the final sentence on the error-flagged preview is dense but valuable, and the idempotency sentence slightly duplicates the idempotentHint annotation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 7-parameter batch mutation with no output schema, the description covers routing, cardinality, idempotency, and a safe dry_run path. Its main gap is silence about the normal response format or partial-failure behavior for batch payloads, which is more important precisely because no output schema exists to document the return value.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3; the schema already documents dry_run (including Authorization header redaction and byte-length summarization) as well as the four ID parameters and the requestBody structure. The description's dry_run mention reinforces a usage tip but does not add new parameter meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Updates a list of Test Step Results', naming a specific verb, resource, and cardinality ('targets the full collection or a batch'). It explicitly differentiates from the singular sibling: 'For a single item by ID, use patchTestStepResult instead', so an agent can distinguish them without inspecting either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It provides an explicit routing rule with its condition — single item by ID → patchTestStepResult — which fully disambiguates the plural/singular pair. It also adds a concrete workflow recommendation: set dry_run: true to preview the exact request Polarion would receive before changing anything.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchTestStepsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Test Step(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide idempotentHint=true, and the schema already describes dry_run behavior. The description restates idempotency and dry-run without adding substantially new traits; the error-flag caveat only applies to tools with a typed output schema, which this tool lacks. No contradiction, but limited incremental value.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with purpose and uses clear label prefixes (Cardinality, Effect, Tip) for scannability. It is somewhat verbose, especially the output-schema caveat, but each sentence contributes guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Together with the comprehensive schema and annotations, the description covers operation, batch vs single scope, idempotency, and dry-run usage. It does not specify response or error behavior, but since there is no output schema, this is a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters. The description adds a cardinality hint for requestBody ('full collection or a batch') but does not otherwise enrich parameter-level meaning, warranting the baseline score of 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Updates a list of Test Steps' – a specific verb and resource. It clearly distinguishes this tool from the singular patchTestStep by mentioning cardinality and explicitly naming the sibling for single-item updates.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool ('full collection or a batch') and directs to the alternative: 'For a single item by ID, use `patchTestStep` instead.' This gives the agent a clear decision rule.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchUserAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The User body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds meaningful behavioral detail beyond the annotations: it explains idempotency consequences, the dry-run preview behavior, and the error-flagged result quirk. No contradiction with annotations exists; readOnlyHint=false and destructiveHint=false align with an idempotent update.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and uses the remaining sentences for high-value behavioral notes. The error-flag explanation is slightly tangential but earns its place because it prevents confusion when using dry_run.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with nested request schemas and no output schema, the description covers the important behavioral traps: idempotency, dry-run validation, and how to interpret the preview result. It doesn't explain return values, but no output schema exists and the annotations cover safety.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all parameters thoroughly. The description adds some dry_run-specific context (preview, error-flagged output) but does not substantially clarify userId or requestBody semantics beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening sentence 'Updates the specified User' is a specific verb+resource pairing that clearly identifies the operation and target. It distinguishes itself from the many other patch* siblings by naming the User resource explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives practical usage guidance via the dry_run tip, and implies the tool is for updating Users, but it does not state when to choose this over alternatives or when not to use it. No sibling differentiation is provided despite a large sibling list.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchWorkItemAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Work Item body. | |
| changeTypeTo | No | The Type the Workitem to change to. | |
| workflowAction | No | The Workflow Action. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=false, idempotentHint=true, destructiveHint=false, and openWorldHint=true. The description adds valuable context beyond annotations: it warns that the call is not guaranteed idempotent despite the idempotentHint annotation, explains that it can trigger workflow actions with real side effects (status change, signatures, notifications), and explains the dry_run preview behavior including the error-flagged result quirk. This is rich behavioral disclosure that goes beyond the structured annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: it states the core action first, then the cardinality distinction, then the side-effect warning, then the dry_run tip. Every sentence earns its place and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with no output schema, the description covers the key behavioral risks (workflow side effects, non-idempotence), the single-vs-batch routing, and the dry_run safety mechanism. It doesn't describe the success response format, but the absence of an output schema and the presence of the dry_run guidance make this acceptable. The only minor gap is not detailing what a successful response contains, but the tool's complexity is well covered.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters. The description adds value by explaining the dry_run preview behavior in detail, clarifying that workItemId is the project-scoped ID (e.g. WI-123) not the combined project/id path, and noting that projectId is case-sensitive and can be listed via getProjects. This goes beyond the schema's own descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it updates a specified Work Item, targets a single item by ID, and explicitly contrasts with patchWorkItems for batch operations. This distinguishes it from siblings like patchWorkItems, postWorkItems, and getWorkItem without needing to inspect schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says when to use this tool (single item by ID) versus when to use patchWorkItems instead (full collection or batch). It also provides a concrete tip to use dry_run: true first to preview the request, which is actionable usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchWorkItemApprovalAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Test Run(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the idempotentHint annotation, the description explicitly explains what idempotency means in this context (same end state, no extra side effects) and details the dry_run behavior, including how preview results are returned with an error flag and how to interpret them. This adds meaningful behavioral context beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact, with only two sentences covering purpose, differentiation, idempotency, and dry_run guidance. It is front-loaded with the primary action and efficiently packs high-value information without redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the essential operational aspects: single-target scope, batch alternative, idempotency, and dry_run preview. Since there is no output schema, the description doesn't need to detail return values, but it doesn't explicitly mention expected success/failure responses beyond the preview. However, given the simplicity of the operation and the strong schema annotations, this is mostly complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides detailed descriptions for all parameters, including examples and clarification on `workItemId` versus combined path. The description adds a useful tip about `dry_run` and clarifies the preview mechanism, supplementing the schema with practical usage intent.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool updates a single specified instance, identifies the exact resource it targets, and calls out the sibling tool `patchWorkItemApprovals` for batch operations, making its purpose and distinction unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly advises using `patchWorkItemApprovals` for collections or batches, provides a concrete tip to use `dry_run` for previewing requests, and explains the preview behavior, which gives clear guidance on when and how to use this tool versus alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchWorkItemApprovalsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Test Run(s) body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already include idempotentHint=truecars, but the description explains the idempotent effect in concrete terms ('leaves the resource in the same end state, with no additional side effects'). It also discloses the dry_run preview behavior and the error-flagged result quirk for typed output schemas. This adds real behavioral context beyond the structured hints, though it does not mention authentication or reversibility.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a bit wordy but well-structured into sections (what, cardinality, alternative, effect, tip). Each sentence contributes unique information; the error-flagged preview note is detailed but useful. It could be tightened, but it is not padded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a non-read-only tool with no output schema)Skip, it covers the essential aspects: scope (batch/full collection), idempotency, the dry_run preview, and routing to the single-item sibling. It does not explain return values or error conditions, but the absence of an output schema plus the tipping behavior lessens that need. The guidance to read the text content on error-flagged results partially compensates for missing output documentation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for all four parameters, so the schema already documents projectId, workItemId, requestBody, and dry_run. The description adds value only by referencing dry_run in the tip, which reinforces but does not extend the schema. Since the schema carries the full semantic burden, a baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Updates') and a resource ('a list of instances'), but 'instances' is vague and never explicitly identifies them as work item approvals. It does differentiate from the sibling tool `patchWorkItemApproval` by cardinality (list vs. single item), which helps an agent distinguish them. The name itself carries the missing specificity, but the description should have mentioned 'approvals' explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the alternative (`patchWorkItemApproval`) and the exact condition for choosing it: 'For a single item by ID'. Also states the cardinality options ('full collection or a batch'), which clarifies when to use this tool. The dry_run tip adds practical guidance for safe previewing, giving an agent actionable context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchWorkItemAttachmentAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | No | Attachment metadata and file data. | |
| attachmentId | Yes | The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description explains the idempotent effect in plain terms ('leaves the resource in the same end state, with no additional side effects') and documents the dry_run preview behavior, including the unusual error-flagged result. This gives the agent actionable behavioral knowledge not present in the structured annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: core operation, usage guidance, side-effect note, and dry-run tip each earn their place. There is no redundant repetition of schema or annotation data.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite having no output schema, the description covers what the tool does, when to use it, its side-effect profile, and the dry-run workflow. Combined with the fully-covered parameter schema and annotations, an agent has everything needed to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, setting a baseline of 3. The description adds real value by revealing the internal structure of requestBody (resource vs. content) and confirming that base64-encoded bytes are expected for file replacement, which the generic schema description does not convey.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Updates one existing Work Item attachment'. It also clarifies the exact scope (metadata via requestBody.resource, optional file replacement via requestBody.content) and differentiates from siblings by explicitly naming postWorkItemAttachments for adding and getWorkItemAttachmentContent for reading.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool ('rename or re-upload a file that already exists') and directs the agent to specific alternatives for adding a new file and reading the current file. No ambiguity remains about the selection criteria.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchWorkItemRelationshipsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds valuable behavioral context beyond annotations: it reiterates idempotency (also in annotations), explains the dry_run preview behavior, and warns that previews appear as error-flagged results. This goes beyond the idempotentHint annotation and provides a practical gotcha.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the purpose and then adds useful behavioral details. It is slightly verbose with the idempotency statement (redundant with annotation) but remains efficient overall. The dry_run tip and error-flag caveat are valuable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of 5 parameters including a nested oneOf requestBody, the description covers the key operational aspects: idempotency, dry_run preview, and the error-flag behavior. It doesn't explain return values (no output schema) or explicit alternatives, but the core usage context is sufficient for a capable agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description does not add parameter semantics beyond the schema; the dry_run tip is already present in the schema description. No additional meaning is provided for projectId, workItemId, relationshipId, or requestBody.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action ('Updates a list of Work Item Relationships') with a specific resource. It distinguishes from read (get) and create (post) by the verb 'Updates', though it doesn't explicitly name sibling alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus the sibling tools like postWorkItemRelationships (create) or deleteWorkItemsRelationship (delete). The description implies updating existing relationships but never explicitly contrasts with alternatives or states prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
patchWorkItemsAIdempotent
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Work Item(s) body. | |
| changeTypeTo | No | The Type the Workitem to change to. | |
| workflowAction | No | The Workflow Action. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description states 'not guaranteed idempotent' and warns of side effects from re-running workflow actions, which is valuable. However, the annotation declares idempotentHint: true, directly contradicting this. Per rules, a contradiction forces a score of 1 and flags annotation_contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is well-organized and front-loaded: purpose first, then scope, cardinality, effect, and tip. It is somewhat verbose but each section earns its place given the tool's complexity. No fluff, but could be trimmed slightly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers scope, alternatives, side effects, and the dry_run preview. It lacks a mention of return format, but no output schema exists and the dry_run explanation compensates. The idempotency contradiction aside, the description is complete for agent guidance.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers 100% of parameters with detailed descriptions, including dry_run behavior and projectId guidance. The tool description adds no additional parameter-level semantics beyond the schema, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Clearly states 'Updates a list of Work Items' and differentiates from siblings by scope (one project) and cardinality (collection vs single item). Explicitly names patchAllWorkItems and patchWorkItem as alternatives, so an agent can distinguish them without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit routing: 'To act across all projects, use patchAllWorkItems instead' and 'For a single item by ID, use patchWorkItem instead.' Also notes the project ID requirement. No ambiguity about when to pick this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postBacklinkedWorkItemsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Work Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Explicitly discloses non-idempotency beyond the idempotentHint=false annotation: 'calling it again with the same input creates a duplicate; it is not idempotent.' It also explains the dry_run preview behavior, including the unusual fact that the preview is returned as an error-flagged result. This adds substantial context that annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the core purpose in the first sentence, then addresses effect and dry_run tip. Slightly verbose in the effect sentence ('creates a duplicate; it is not idempotent' is redundant), but every sentence serves a purpose and the structure is logical.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and annotations covering read-only/destructive/idempotent hints, the description covers the key behavioral nuance (duplicate creation) and the dry_run error-flag quirk. It does not mention required permissions or response format, but given the schema and annotations, it is reasonably complete for a creation tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All four parameters are already described in the input schema (100% coverage), so the baseline is 3. The description adds value by recommending dry_run: true and explaining its preview behavior, which is not in the schema. It does not add further meaning for projectId or workItemId, but the schema covers them.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Creates incoming links from other Work Items (backlinks).' It also draws a clear boundary with 'Does not pertain to External links,' differentiating it from sibling tools like postExternallyLinkedWorkItems. The purpose is immediately clear and unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides only a negative filter ('Does not pertain to External links') and a dry_run tip. It implies use for backlink creation but never explicitly names alternatives like postLinkedWorkItems or states when this tool should be preferred over them. Usage context is present but not fully spelled out.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postCollectionsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Collection(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description clearly discloses the most important behavioral trait: calling it again with the same input creates a duplicate and is not idempotent, consistent with the annotations. It also explains the dry_run preview behavior, including that the preview is returned as an error-flagged result when an output schema exists. This is valuable context beyond what annotations already provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and well-ordered: purpose first, then the critical non-idempotency effect, then the dry_run tip. Every sentence adds distinct value, and there is no redundant or filler content.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a POST tool with a rich output schema and detailed parameter schema, the description covers the essential behavioral context: creation semantics, non-idempotency, and a safe preview option. It is complete enough for correct invocation, though it could be slightly stronger by explicitly naming patchCollections as the update alternative.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already fully documents all parameters with 100% coverage, so the baseline is 3. The description adds a useful nuance by explaining that dry_run returns an error-flagged preview and that the text content should be read regardless of that flag. This goes slightly beyond the schema's dry_run description, justifying a 4 rather than a 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a clear verb and resource: 'Creates a list of Collections.' It distinguishes this as a creation operation from the many get/patch/delete collection siblings. However, it does not explicitly differentiate itself from postCollectionsRelationships, another creation-style sibling, leaving the 'list of Collections' phrasing slightly open to interpretation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage: you call this when you want to create Collections. It also provides a strong within-tool guideline by recommending dry_run to preview the request first. It does not, however, explicitly state when to prefer this over patchCollections or other collection-related tools, leaving alternative selection to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postCollectionsRelationshipsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Document(s) body. | |
| collectionId | Yes | The Collection ID. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already include idempotentHint=false and readOnlyHint=false, but the description goes further by explaining the consequence: calling again creates a duplicate and is not idempotent. It also introduces the dry_run behavior, describing how the preview works and that it returns an error-flagged result, adding significant behavioral context beyond the minimal hints. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose. It efficiently conveys the non-idempotent behavior and the dry_run tip without repetition or filler. Every sentence earns its place, making it easy for an agent to parse quickly.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with 5 parameters, nested objects, and no output schema, the description covers essential aspects: it explains the create semantics, non-idempotency, and provides a safe preview mechanism. However, it does not describe what a successful response looks like or how to interpret the result. Since no output schema exists, some return-format guidance might be expected, but the description is still adequate for safe invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema provides 100% coverage with descriptions for all parameters, including detailed explanations for dry_run, projectId, and relationshipId. The description's only parameter-related addition is the tip to set dry_run, which is more of a usage suggestion than semantic clarification. Since the schema already handles parameter meanings well, a baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb ('Creates') and the resource ('specific Relationships for the Collections'), making the tool's purpose unambiguous. It differentiates from siblings like patchCollectionsRelationships and deleteCollectionsRelationship by explicitly indicating creation. The effect of non-idempotency also reinforces the create semantics.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implicitly indicates this is for creating new relationships, but it does not explicitly state when to use this tool versus alternatives (e.g., patch or delete). It provides a dry_run tip as a usage suggestion but no when/when-not conditions. Sibling tools like postPageRelationships, postPlanRelationships, postWorkItemRelationships exist, but no comparison is made.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postCommentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Comment(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond the annotations by spelling out the concrete consequence of non-idempotency: calling it again with the same input creates a duplicate. It also discloses the dry_run preview behavior and warns that the preview is returned as an error-flagged result, which is exactly the kind of behavioral nuance an agent needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, then adds the most decision-relevant behaviors: non-idempotency and the dry_run preview caveat. Every sentence carries information an agent needs, and there is no filler or repetition of schema fields.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the nested requestBody and the presence of an output schema, the description is nearly complete: it explains the create effect, duplicate risk, and how to safely preview. The only missing piece is explicit routing guidance among sibling comment tools, but that is already partially addressed by naming the work-item scope in the first sentence.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the parameters are already well-documented in the input schema. The description adds only a usage tip about dry_run and does not materially enrich the meaning of projectId, workItemId, or requestBody beyond what the schema already states.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a precise verb and resource: 'Creates a list of Work Item Comments.' This clearly differentiates it from sibling comment tools like postDocumentComments or postPageComments, and the resource is named explicitly rather than inferred from the tool name.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage is for creating comments on work items, and it gives a practical tip to use dry_run first. However, it never explicitly states when to choose this tool over alternatives like postDocumentComments or postTestRunComments, and it provides no when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postDocumentCommentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Comment(s) body. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate idempotentHint=false, but the description adds concrete detail: 'calling it again with the same input creates a duplicate'. It also explains dry_run behavior and the error-flagged preview result, which is valuable context beyond structured annotations. No contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured: purpose first, then effect, then a practical tip. Every sentence adds value with no redundant filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is complex with nested objects and an output schema, but the description covers purpose, non-idempotency, and dry_run usage. It does not explain return values, but the output schema exists, so that is not required. It lacks explicit authentication or error details, but these are not critical for a post operation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all parameters including dry_run. The description does not add parameter-level meaning beyond the schema (e.g., format, constraints, relationships). Baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Creates a list of Document Comments' with a specific verb and resource, and the non-idempotency note clarifies its effect. It is clearly distinct from siblings like getDocumentComments (read), patchDocumentComment (update), and postPageComments (page-specific).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage by stating 'Creates' and the dry_run tip for previewing, but it does not explicitly state when to use this tool versus alternatives (e.g., 'use for adding new comments; use patchDocumentComment for edits'). No explicit exclusions or alternative routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postDocumentItemAttachmentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Attachment metadata and file data. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond annotations by explaining the non-idempotent behavior ('calling it again with the same input creates a duplicate') and the dry_run preview behavior, including the error-flagged result nuance. This adds significant context beyond what annotations (idempotentHint=false) provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact yet information-dense, with each sentence serving a purpose: purpose, structure, usage guidance, effect, and tip. It is front-loaded with the primary action and avoids redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (multipart request, non-idempotency, dry_run), the description covers all necessary aspects: what it does, how to structure the request, alternatives, side effects, and a safety tip. The output schema handles return values, so nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Even though schema coverage is 100%, the description adds critical meaning to the requestBody parameter by explaining its internal structure (resource.data vs files, ordering, and lid matching). This is essential for correct invocation and is not derivable from the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Uploads') and resource ('attachments of a Document'), and explicitly distinguishes itself from sibling tools by naming patchDocumentAttachment and getDocumentAttachments. This makes the tool's purpose unambiguous even without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly states when to use this tool ('Use this to add files') and when not to, pointing to alternatives for modification and listing. The dry_run tip also gives practical usage guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postDocumentPartsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Document Part(s) body. | |
| documentName | Yes | The Document name. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly discloses that each call creates a new resource and is not idempotent – reinforcing and extending the idempotentHint=false annotation. It also reveals a subtle behavioral trait: the dry_run preview returns an error-flagged result on typed output schema, and instructs to read text content regardless. These details are not present in annotations and materially help the agent handle outcomes correctly.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the core purpose, then a crucial behavioral warning, then a practical tip. Every clause earns its place – no fluff. The dry_run tip is concise and actionable. This is a model of efficient, well-ordered tool documentation.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is complex (nested objects, 5 parameters, output schema), but the description covers the non-obvious aspects: non-idempotency, duplicate creation, and the dry_run preview behavior. The schema and output schema handle parameter and return details, and annotations cover safety flags. The description fills the gaps that structured data cannot, making it complete for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with detailed descriptions for every parameter including nested ones like requestBody attributes and relationships. The description adds only a tip about dry_run, but the schema already fully explains dry_run's behavior. Thus the description provides little beyond what the schema offers; the baseline of 3 is appropriate since the schema carries the semantic load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'Creates a list of Document Parts' – a specific verb and resource. It distinguishes from sibling tools like getDocumentParts (retrieve), deleteDocumentParts (delete), and patchDocumentParts (modify) by focusing on creation. The added note about non-idempotency further clarifies the operation's side effect, making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no explicit guidance on when to choose this tool over alternatives such as postDocuments, postPages, or postDocumentComments. It mentions the dry_run tip but that is about invocation practice, not tool selection. While the name 'postDocumentParts' implies creation, an agent could benefit from a note like 'use this to add new parts to an existing document' or a pointer to getDocumentParts for reading existing parts. The absence of any comparison to siblings leaves usage context under-specified.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postDocumentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Document body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Explicitly discloses non-idempotent behavior ('calling it again with the same input creates a duplicate') and explains the dry_run preview's unusual error-flagged result, going beyond the annotations (idempotentHint=false) by adding concrete consequences and interpretation guidance. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three concise sentences with no fluff. It front-loads the core purpose, adds a critical behavioral warning, and then a practical tip — all in an efficient, scannable format.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a CREATE operation with deeply nested schema and an output schema present, the description covers the essential context: non-idempotency, safe preview via dry_run, and how to interpret preview results that arrive as error-flagged. Nothing an agent needs to invoke it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% — every parameter has a thorough description including dry_run, spaceId, projectId, and the nested requestBody. The tool description adds no new parameter meaning beyond what the schema already provides, so the baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb ('Creates') and resource ('a list of Documents'), making the tool's purpose immediately clear. It also differentiates it from sibling creation tools like postWorkItems by naming the resource type, and the effect note about non-idempotency reinforces the distinct write behavior.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides a concrete safe-usage guideline via the dry_run tip, which helps the agent preview requests without side effects. However, it does not explicitly contrast this tool with alternatives (e.g., when to use postDocuments vs. postPages), leaving some implicit inference to the agent, though the resource type makes the distinction fairly obvious.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postExternallyLinkedWorkItemsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Externally Linked Work Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations (idempotentHint=false, readOnlyHint=false), the description concretely explains the effect: each call creates a new resource and identical input yields a duplicate. It also discloses the non-obvious trait that dry_run previews arrive as error-flagged results, so the agent must read the text content regardless — genuinely useful context the annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three labeled segments (purpose, Effect, Tip) with no wasted words; the action is front-loaded, followed by the non-idempotency warning and the dry_run tip. The note about error-flagged preview output is slightly wordy but earns its place by preventing misinterpretation of tool results.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a non-idempotent mutation with nested requestBody and a typed output schema, the description covers purpose, duplication behavior, and the safe preview workflow. An output schema exists so return values need no explanation, and the schema documents all parameters. Only explicit alternative routing among siblings is missing, a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters are already documented in the input schema. The description mentions dry_run but adds no parameter-level semantics beyond the schema's own detailed description. Baseline 3 is appropriate since the structured schema carries the semantic weight.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Creates a list of Externally Linked Work Items,' which clearly identifies the operation and target. It does not explicitly differentiate from siblings like postLinkedWorkItems or postBacklinkedWorkItems, but the 'externally linked' qualifier makes the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives a clear safety tip to use dry_run: true first to preview the request without side effects, and warns that repeated calls with identical input produce duplicates. However, it never states when to choose this over the many sibling link-creation tools, so selection guidance is implied rather than explicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postGlobalCustomFieldsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Custom Fields Body |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations, the description reveals non-idempotency with concrete consequences: calling again with the same input creates a duplicate. It also explains the dry_run preview behavior and the important nuance that preview results appear as error-flagged output despite being valid previews.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence earns its place: purpose, scope, alternative tool, idempotency warning, and dry_run tip are each covered without redundancy. The most important scoping information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a create operation with a typed output schema, the description covers scope, non-idempotency, the correct sibling alternative, and the dry_run caveat. Nothing essential is missing for an agent to select and invoke this tool correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the schema already documents requestBody and dry_run in detail. The description adds value by reinforcing the dry_run workflow and clarifying how to interpret its error-flagged preview result, which is not obvious from the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a list of Custom Fields in the Global context.' It clearly distinguishes itself from postProjectCustomFields by stating scope spans every project with no project filter, making its purpose unmistakable.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly names the alternative postProjectCustomFields for single-project actions and explains when to use this global variant instead. It also advises using dry_run: true to preview the request, giving clear operational guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postGlobalEnumerationA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The Enumeration(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already state readOnlyHint=false and idempotentHint=false, but the description adds concrete behavior: calling again with the same input creates a duplicate, and dry-run previews are returned as error-flagged results. This goes well beyond the structured metadata and gives the agent actionable expectations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, then uses labeled sections for scope, effect, and tip. It is somewhat long, but each sentence adds meaningful context, especially the non-idempotency warning and the dry-run caveat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a creation tool with complex nested input and an output schema, the description covers purpose, scope, sibling differentiation, idempotency, and safe preview behavior. It is complete enough for an agent to decide when to call it and how to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the schema documents both parameters, so baseline is 3. The description adds value by explaining the practical use of `dry_run` and the error-flagged preview behavior, which is not fully apparent from the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('Creates a list of Enumerations in the Global context') and immediately clarifies scope ('spans every project'). It also names the sibling alternative `postProjectEnumeration`, so an agent can distinguish the global vs. single-project use case without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly says when this tool applies ('Global context', 'no project filter') and when to prefer a sibling ('To act on a single project, use postProjectEnumeration instead'). It also warns about repeated calls creating duplicates and recommends `dry_run: true` as a safe first step.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postGlobalIconsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | Icon meta data and file data |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already signal non-idempotency informing the agent of expected side effects, and the description adds concrete details: duplicate creation per call, global scope, dry_run behavior, and the error-flagged preview nuance. This exceeds the annotation baseline.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is informative and each sentence serves a purpose (scope, alternative, effect, tip), but the opening 'Icons are identified by order' is slightly unclear and could be integrated elsewhere. Otherwise, it's well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and annotations covering safety, the description covers scope, non-idempotency, alternatives, and a practical dry_run mechanism. Nothing essential for correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% including dry_run and requestBody descriptions. The description adds practical guidance for dry_run usage and notes the requestBody contains icon data, enriching the bare schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly indicates a global scope, differentiates from postProjectIcons, and states the effect is creating a new resource. However, it never explicitly states 'creates global icons'—the purpose is inferred from the name and the effect line.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the alternative tool (postProjectIcons) for single-project actions frosted with 'instead', and provides a concrete usage tip (dry_run) for safe preview. This gives clear decision guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postLicenseSlotsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| typeId | Yes | ||
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | License Slots body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate non-idempotency (idempotentHint: false), but the description explicitly explains the consequence of calling again with the same input (creates a duplicate). It also discloses the dry_run preview behavior and the error-flagged result for previews, which is valuable beyond annotations. No contradictions found.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is reasonably concise, with the core purpose front-loaded. The dry_run explanation is somewhat lengthy but contains important operational detail. Overall structure is clear and efficient, with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers key behavioral aspects like non-idempotency and dry_run, and the output schema covers return values. However, it does not explain the purpose of the required typeId parameter, nor any prerequisites or authentication context. Given the tool's moderate complexity, this is a noticeable gap, but not severe.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 67% with dry_run and requestBody described in the schema. The description does not add meaning for typeId, which remains undocumented. While the dry_run tip references the parameter, it does not elaborate on its semantics beyond the schema. Thus the description adds marginal value over the schema and does not fully compensate for the missing typeId coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates a list of group License Slots, a specific verb and resource. It also distinguishes itself from siblings like getLicenseSlots and deleteLicenseSlots by focusing on creation, and even notes a cloud limitation, making its purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use the tool (when creating license slots) and provides a practical tip to use dry_run first for preview. It does not explicitly contrast with alternative tools like patchLicenseAssignments, but the purpose and the dry_run workflow give sufficient usage guidance. The cloud-based limitation is also a clear exclusion.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postLinkedWorkItemsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Work Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses important non-idempotent behavior: calling it again with the same input creates a duplicate. It also explains the dry_run preview behavior, including the nuance that the preview is error-flagged because it is not real tool output. This goes well beyond the annotations, which only declare idempotentHint=false.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: purpose first, exclusions second, behavioral effect third, and a practical dry_run tip last. Every sentence contributes necessary operational information, and the wording is direct without excessive detail.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with a nested body and an output schema, the description covers the essential context: the link type scope, duplicate-creation behavior, non-idempotency warning, and dry_run workflow. Since an output schema exists, the description does not need to explain return values, and nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all parameters thoroughly. The description adds useful context about the requestBody's meaning (direct outgoing work item links) and the dry_run tip, but it does not add substantially new per-parameter semantics beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: "Creates the direct outgoing links to other Work Items." It explicitly distinguishes itself from external and backlink operations, which clearly separates it from sibling tools like getBacklinkedWorkItems, postBacklinkedWorkItems, and postExternallyLinkedWorkItems.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context by specifying this tool handles direct outgoing links and "does not pertain to external links or backlinks." It does not name alternative tools explicitly, but the exclusion is unambiguous enough to steer an agent toward the right sibling for other link types.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postOslcResourcesA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Oslc Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses the key behavioral consequence beyond annotations: the call creates a new resource and is not idempotent, so repeating input produces duplicates. It also explains the dry_run preview behavior, including the unusual error-flagged result on typed output schemas.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Every sentence earns its place: function, field semantics, alternative routing, non-idempotence warning, and dry_run tip. The most actionable information is front-loaded before the dry_run caveat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with nested requestBody, output schema, and multiple related siblings, the description covers function, usage vs alternatives, side effects, and preview semantics. Nothing needed to decide when and how to call it is left out.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema descriptions already cover projectId, workItemId, and requestBody, so baseline is 3. The description adds value by explaining the meaning of the nested uri, role, and label fields and gives a concrete role URI example, which the schema leaves bare.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action ('Adds one or more OSLC links from a Work Item to artifacts in other OSLC-capable tools') and enumerates the requestBody fields. It also differentiates from siblings by explicitly naming postLinkedWorkItems for internal links and getOslcResources for listing.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit selection criteria: use for cross-tool traceability, use postLinkedWorkItems for internal Work Item links, and use getOslcResources to list existing links. It also recommends dry_run for preview before committing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postPageAttachmentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Attachment metadata and file data. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=false, and the description elaborates with a concrete consequence: 'calling it again with the same input creates a duplicate; it is not idempotent.' It also discloses the subtle dry_run behavior where the preview is returned as an error-flagged result on typed-output-schema tools. These add meaningful behavioral context beyond what annotations provide, and nothing contradicts the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but well-ordered: purpose first, then request structure, then routing, then behavioral warnings, then the dry_run tip. Every sentence carries unique information. It runs slightly long, particularly the dry_run error-flag explanation, but that nuance earns its place for a complex multipart tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex multipart upload with an opaque requestBody string, the description covers invocation structure, file-metadata matching, return values (created attachment IDs), non-idempotence, the dry_run workflow, and sibling routing. The output schema covers return structure. The only residual gap is that the exact serialization format of the requestBody string is left implicit rather than explicitly specified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds genuine semantic value by explaining the relationship between requestBody.resource.data (metadata entries) and requestBody.files (base64 bytes), including the ordering rule and the lid-based matching alternative. This meaningfully compensates for the schema's terse 'Attachment metadata and file data' description of requestBody.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening sentence 'Uploads one or more new files as attachments of a Rich Page in a single multipart request' states a specific verb, resource, and transport format. It further distinguishes itself from sibling tools by naming patchPageAttachment for changing attachments and getPageAttachments for listing them, making selection unambiguous among the many attachment-related tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit routing guidance: 'Use this to add files; to change an existing attachment use patchPageAttachment, and to list what is already attached use getPageAttachments.' It also adds a concrete usage tip to run dry_run first for validation. This leaves no ambiguity about when to invoke this tool versus its alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postPageCommentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Comment(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond the annotations by explicitly warning that calling it again with the same input creates a duplicate and that the operation is not idempotent. It also discloses the dry_run preview behavior, including the important quirk that the preview is returned as an error-flagged result, which is valuable context for agents interpreting output.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise and well-structured: purpose first, then behavioral effect, then a practical tip with a necessary caveat. Every sentence adds value and no redundant content is present.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, output schema, and annotations, the description covers the essential behavioral context an agent needs: creation semantics, non-idempotency, and dry_run usage. It does not need to restate parameter or return details already present in structured data.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema has 100% parameter description coverage, so the description does not need to re-explain parameters. It adds some emphasis on dry_run, but this is already documented in the schema. Baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a list of Page Comments.' This clearly identifies the tool's action and target, and distinguishes it from sibling tools like getPageComments or patchPageComment. The additional effect statement reinforces that it creates new resources.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly implies use when creating page comments, and the dry_run tip is practical guidance for safe invocation. However, it does not explicitly state when to prefer this tool over alternatives such as postDocumentComments or patchPageComment, so usage context is implied rather than fully specified.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postPageRelationshipsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| pageName | Yes | The Rich Page's ID/name within its space — its stable identifier, not its display title. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly states the tool is not idempotent, reinforcing the idempotentHint=false annotation, and adds the dry_run preview behavior including the error-flagged result nuance. This goes beyond the annotations by explaining how to test without side effects, which is valuable for a create operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is fairly concise with three sentences: purpose, effect, and tip. The tip is somewhat verbose but contains essential information about dry_run and the error-flagged preview. It is front-loaded with the purpose, and the structure is logical. Could be slightly tightened but overall efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, and the description does not explain the success response or typical errors. It does mention the dry_run preview behavior, which is a form of context, but it lacks details on what a successful call returns or any prerequisites beyond the schema. Given the complexity (nested requestBody, oneOf), more context could be added, but it is not critically incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all parameters are documented in the schema. The tool description adds no extra parameter semantics beyond the schema. The requestBody description is minimal ('The Relationship body.'), but the schema's oneOf structure provides some detail. Baseline 3 is appropriate since the schema carries the parameter meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool creates a list of Rich Page Relationships, using a specific verb and resource. It distinguishes from sibling tools like getPageRelationships, patchPageRelationships, and deletePageRelationships by focusing on the create action, and it's unambiguous which resource type it targets.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The purpose and resource are clear, so an agent can infer when to use it (for creating page relationships). However, it doesn't explicitly contrast with postPlanRelationships or postWorkItemRelationships, though the resource name makes it obvious. The dry_run tip provides guidance on safe usage but not on selecting this over alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postPagesA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| spaceId | Yes | The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Page(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond the idempotentHint=false annotation by explicitly explaining the duplicate-on-recall behavior and stating that it is not idempotent. It also discloses the dry-run no-side-effect behavior and the subtle error-flagged preview result, which an agent could otherwise misinterpret as a real failure.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: purpose, non-idempotence, dry-run tip, and the error-flag caveat each appear in short, distinct sentences. Every sentence carries operational value, and there is no filler or redundant schema repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With a detailed input schema, an output schema, and annotations already covering safety and idempotence, the description supplies the remaining key operational context: duplicate behavior, no-side-effect dry run, and the error-flag preview quirk. It could be more explicit about choosing this tool over sibling creation tools like postDocuments, but the core invocation context is complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already documents projectId, spaceId, requestBody, and dry_run in detail. The description's dry-run tip largely restates schema information instead of adding new parameter-level meaning, so the baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a list of Pages.' It clearly identifies this as a create operation and distinguishes it from read operations like getPages or getSpacePages and from update operations like patchRichPage. The added effect statement further clarifies what the tool actually does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context for use: create Pages. It also provides a concrete pre-invocation instruction to set dry_run: true first, which is strong practical usage guidance. It does not explicitly compare against alternatives like postDocuments or state when not to use this tool, so it falls short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postPlanRelationshipsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| planId | Yes | The Plan ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Work Item(s) body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the annotations (idempotentHint=false, readOnlyHint=false) by disclosing the concrete behavioral consequence: 'creates a new resource on each call — calling it again with the same input creates a duplicate.' It also fully explains the dry_run semantics (previews without changing anything) and the counter-intuitive error-flagged preview result. No contradiction with annotations; this is exactly the kind of side-effect transparency the rubric rewards.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the purpose, and each subsequent sentence adds a distinct behavioral fact: non-idempotency, dry_run workflow, and the error-flag caveat. It is slightly verbose — the final sentence about 'tools with a typed output schema' is a generic caveat that does not apply to this tool since it has no output schema, and the em-dash phrasing slows scanning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 5-parameter tool with nested oneOf structures and no output schema, the description covers the critical behavioral risks well (duplication, dry_run). However, it omits expected return value or success indication, and it never routes the agent away from closely related siblings like postWorkItemRelationships when deciding which resource should own the relationship. Adequate but with notable gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all five parameters thoroughly, including the nested requestBody oneOf structure and dry_run behavior. The description adds only marginal value — mainly the recommendation to set dry_run first, which mostly restates the schema. Baseline 3 is appropriate since schema carries the burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource — 'Creates the specific Relationships for the Plan' — which clearly identifies the operation and target resource. It implicitly differentiates from siblings like postPageRelationships and postCollectionsRelationships by naming the Plan, though it does not explicitly name any alternative. The phrase 'specific Relationships' is slightly vague on its own, but the schema's relationshipId description (e.g. assignee, linkedWorkItems) resolves it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied — an agent can infer this tool is for creating relationships on a Plan — but there is no explicit when-to-use vs. alternatives guidance. The description never distinguishes it from patchPlanRelationships or postWorkItemRelationships, which is a real ambiguity since both can touch plan-related relationships. The dry_run tip is valuable operational guidance, but it addresses safe invocation rather than tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postPlansA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Plan(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly warns that calls are not idempotent and that identical input creates duplicates, which is more concrete than the idempotentHint annotation. It also discloses that dry_run output will be error-flagged because it is not real tool output, adding useful behavioral context beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loads the purpose and core effect before the dry-run tip. The third sentence is slightly dense but earns its place by explaining the error-flag nuance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a state-changing collection creation tool with a rich nested schema and output schema, the description adequately covers the most important runtime behaviors: duplication, non-idempotency, and safe preview. It could add explicit guidance about required fields, but the schema already provides those details.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All parameters are already fully documented in the schema (100% coverage), so the description does not need to restate them. It adds only the dry_run preview tip, which reinforces but does not significantly extend the schema's parameter explanation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description begins with 'Creates a list of Plans', a specific verb and resource that clearly distinguishes it from read/delete/update siblings like getPlans, deletePlans, and patchPlan. It further clarifies the effect by noting each call creates a new resource.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The create intent is clear, and the dry_run tip offers a safe preview workflow, but the description does not explicitly state when to choose this tool over alternatives or mention any exclusion conditions. Usage is implied rather than spelled out.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postProjectCustomFieldsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Custom Fields Body |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds concrete behavioral detail beyond the annotations: each call creates a duplicate and the operation is not idempotent. It also discloses the dry_run preview is returned as an error-flagged result when an output schema is present, which is non-obvious behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each carrying distinct, decision-relevant information: what it creates, where it operates, what it is not, and how to preview safely. The most important scoping fact is front-loaded, and there is no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the rich input schema, the presence of a typed output schema, and annotations covering read-only/idempotency/destructiveness, the description covers the remaining contextual essentials: scope, sibling routing, non-idempotency, and dry_run behavior. Nothing needed to select or call the tool correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds extra meaning by recommending dry_run and explaining the error-flagged preview caveat, which goes beyond the schema's dry_run parameter text. This is meaningful additional context for invoking the parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a list of Custom Fields in the Project context.' It then distinguishes itself from the global sibling by name ('postGlobalCustomFields') and by scope, so an agent can choose correctly without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states the condition for use ('Scope: one project (requires a project ID)') and the alternative for the opposite case ('To act across all projects, use postGlobalCustomFields instead'). It also gives a concrete pre-call strategy: use dry_run to preview the request.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postProjectEnumerationA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Enumeration(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, idempotentHint=false, and destructiveHint=false, covering the safety profile. The description adds value by elaborating the non-idempotent behavior ('calling it again with the same input creates a duplicate') and explaining the dry_run preview semantics (returns an error-flagged result). This goes beyond the annotations, though it doesn't cover every possible side effect.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded: purpose, scope, alternative, effect, and a practical tip are packed into three sentences with zero fluff. Every sentence earns its place, and the key information (non-idempotency, dry_run behavior) appears early enough to guide the agent.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a creation tool with a typed output schema, the description covers all essential aspects: scope, alternative, side effects, and the dry_run preview behavior. The output schema explains return values, and the input schema documents parameters, so nothing critical is missing. The description is complete enough for an agent to call this tool correctly and safely.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% — all three parameters (projectId, requestBody, dry_run) have detailed descriptions in the schema. The tool description does not add any parameter meaning beyond what the schema already provides; it only restates the projectId requirement and the dry_run tip, which the schema already explains. Baseline 3 is appropriate since the schema carries the parameter documentation burden.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb-resource pairing ('Creates a list of Enumerations') and immediately scopes it to the Project context, requiring a project ID. It also distinguishes itself from the sibling postGlobalEnumeration by stating the scope difference, so an agent can select the correct tool without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly names the alternative tool (postGlobalEnumeration) and the condition that selects it ('To act across all projects'). It also states the requirement of a project ID and offers a dry_run tip, giving clear, actionable guidance on when and how to use this tool versus its sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postProjectIconsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Icon meta data and file data |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate non-idempotence, but the description goes further by explaining that repeated calls with the same input create duplicates. It also discloses the dry_run preview behavior and the fact that preview results appear as error-flagged output, which is genuinely useful context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, every one earns its place: scope, sibling alternative, non-idempotence, and dry-run guidance. The most important facts are front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the annotations, full schema coverage for parameters, and an output schema, the description covers what an agent needs: scope, effect, non-idempotence, and safe preview behavior. Nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds modest value by emphasizing the project ID scoping requirement and explaining how dry_run previews the request, including the error-flagged result quirk, which goes slightly beyond the schema text.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb (post), resource (project icons), and scope (one project, requires a project ID). It also explicitly distinguishes itself from postGlobalIcons, so an agent can tell them apart without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit routing guidance: use this tool for a single project, and use postGlobalIcons instead when acting across all projects. Also gives a practical dry-run tip for safe invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postProjectTestParameterDefinitionsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Test Parameter Definition(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond the annotations by explicitly stating non-idempotency: calling it again with the same input creates a duplicate. It also thoroughly explains the dry_run behavior, including redacted authorization headers, binary summarization, no changes, and the error-flagged preview result, which is valuable for an agent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, followed immediately by the critical side-effect warning and the dry_run tip. Every sentence adds value, and the error-flagged preview caveat is placed where it will be seen.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity, the description covers the essential invocation concerns: what it creates, that it is non-idempotent, safe preview via dry_run, and how the preview result should be interpreted. The output schema exists, so return-value documentation is not the description's burden.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already fully documents projectId, requestBody, and dry_run. The description adds the dry_run workflow context but does not need to restate parameter meanings; baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action ('Creates a list of Test Parameter Definitions' for a specified Project), with a concrete resource and scope. It does not explicitly differentiate from siblings like postTestRunParameterDefinitions or getProjectTestParameterDefinitions, but the verb and resource are unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear context: use this to create Project-level Test Parameter Definitions, and use dry_run first to preview. It does not explicitly discuss alternatives or when-not-to-use, so it stops short of a 5, but the provided usage direction is actionable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRecordAttachmentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | Attachment metadata and file data. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already flag readOnlyHint=false and idempotentHint=false, so the description's core mutation/non-idempotency traits are not net-new; however, it adds concrete behavioral depth by stating 'calling it again with the same input creates a duplicate.' The dry_run disclosure — that the preview is returned as an error-flagged result on typed-output tools and the agent must 'read the text content regardless of that flag' — is genuinely beyond what annotations can express and is critical for correct handling. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is longer than average at five sentences, but each sentence earns its place: core action, request structure, sibling routing, idempotency warning, and the dry_run error-flag caveat. The most load-bearing information (what it does, the multipart structure) is front-loaded, with the nuanced dry_run behavior saved for last.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a high-complexity tool with 7 parameters, 6 required, and an opaque string-typed requestBody, the description covers the difficult parts: the multipart structure, duplicate-creation behavior, and the dry_run preview quirk. The output schema exists, so return values need not be detailed, though the 'Returns the created attachment IDs' line is a helpful confirmation. Minor gaps remain (base64 encoding specifics, size limits), but nothing that would mislead a correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, establishing a baseline of 3, and the description adds substantial meaning where the schema is thin: requestBody is only described as 'Attachment metadata and file data' in the schema, while the description details its internal structure (requestBody.resource.data entries with fileName/optional title, requestBody.files holding base64 bytes in matching order or via lid). This is exactly the kind of semantic enrichment an agent needs to construct the request correctly.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Uploads one or more new files as attachments of a Test Record in a single multipart request.' This immediately distinguishes it from sibling attachment tools like postTestRunAttachments and postDocumentItemAttachments by naming the exact target resource (Test Record). It also names the siblings it is not — patchTestRecordAttachment and getTestRecordAttachments — so an agent can disambiguate without inspecting schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit routing is provided: 'Use this to add files; to change an existing attachment use patchTestRecordAttachment, and to list what is already attached use getTestRecordAttachments.' This tells the agent both when to invoke the tool and which alternatives to select instead, with nothing left to inference. The dry_run tip also gives a concrete recommended usage pattern.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRecordsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Record(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal non-idempotence via idempotentHint=false, but the description adds the practical consequence: identical input creates a duplicate on every call. It also discloses the dry_run behavior, including the important nuance that the preview may come back error-flagged but should still be read. No contradiction with readOnlyHint=false or destructiveHint=false.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences with the core purpose and non-idempotency front-loaded. The final sentence about the error-flagged dry_run output is relevant but slightly verbose and could be tightened.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has a rich nested input schema and an output schema, so the description only needs to add what is not otherwise visible: side-effect semantics and dry-run behavior. Combined with complete parameter descriptions in the schema, an agent has enough information to select and invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All four parameters have their own descriptions in the input schema, so the tool description does not need to reconstruct their meaning. It adds a helpful usage tip about dry_run, but that does not clarify any parameter beyond what the schema already provides. Baseline 3 is appropriate given full schema coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action ('Creates a list of Test Records') with a clear target resource, and the non-idempotency sentence makes its effect unambiguous. The verb and resource distinguish it from siblings such as getTestRecords, patchTestRecords, and deleteTestRecord without needing to inspect their schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly implies when to use it: to create new Test Records, reinforced by the warning that repeated calls with the same input create duplicates. It provides useful context about the dry_run preview, but it never names alternatives or explicitly states when not to use it, such as routing updates to patchTestRecords.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRecordTestParametersA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Parameter(s) body. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly states the non-idempotent behavior: calling again with the same input creates a duplicate. It also explains the dry-run preview behavior and the important nuance that the preview appears as an error-flagged result in typed-output tools, adding significant value beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tight sentences, each earning its place: the action, the non-idempotent consequence, and the dry-run tip. The most behaviorally important warning is front-loaded, and there is no filler or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the annotations, the fully described input schema, and the presence of an output schema, the description covers the critical behavioral and practical details an agent needs: duplicate creation risk and effective dry-run usage. Nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Input schema coverage is 100%, so the baseline is 3, but the description adds meaningful context for `dry_run`, explaining how its preview is represented in the output. It also ties the core noun phrase 'list of Test Parameters' to the expected requestBody structure.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Creates a list of Test Parameters for the specified Test Record.' This clearly distinguishes the operation from sibling tools that read or modify test parameters, even without an explicit comparison.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly frames when to use the tool (to create Test Parameters for a Test Record) and provides actionable guidance to use `dry_run: true` first. It does not explicitly enumerate alternatives or when-not-to-use conditions, but the context is clear and practical.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRunAttachmentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | Attachment metadata and file data. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes beyond annotations by spelling out the exact non-idempotency consequence: 'calling it again with the same input creates a duplicate.' It also discloses the dry_run preview behavior and warns that the preview is returned as an error-flagged result, which is critical context an agent would not otherwise know.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The first sentence delivers the core purpose, and each following sentence adds a distinct piece of value: request structure, return value, sibling routing, idempotency warning, and dry_run tip. The length is justified by the multipart complexity, and nothing is redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema and annotations are present, the description covers all behavior an agent needs to invoke correctly: what it creates, how to structure the payload, how to preview safely, what the duplicate risk is, and which sibling tools to use for other operations.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3, but the description adds substantial meaning: it explains how requestBody maps to metadata entries and file bytes, how lid is used to match entries, and what dry_run does. It also tells the agent how to obtain a valid projectId via getProjects.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: 'Uploads one or more new files as attachments of a Test Run in a single multipart request.' It also names the return value ('Returns the created attachment IDs') and distinguishes itself from siblings by explicitly naming patchTestRunAttachment and getTestRunAttachments.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives explicit routing guidance: 'Use this to add files; to change an existing attachment use patchTestRunAttachment, and to list what is already attached use getTestRunAttachments.' It also recommends dry_run for safe preview, which helps agents decide how to invoke it safely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRunCommentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Comment(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal non-idempotency and non-read-only, but the description adds meaningful context: repeated calls create duplicates, and dry_run returns an error-flagged preview that must still be read as text. This goes beyond what the annotations alone communicate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and well-structured: purpose, behavioral effect, and usage tip each in their own sentence. The dry_run explanation is slightly verbose but earns its place because it addresses a non-obvious behavior.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a create tool with a rich input schema and an output schema, the description covers the essential non-obvious aspects: non-idempotency and the dry_run preview behavior. It could be more complete by referencing sibling patch/get tools, but nothing critical is missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by explaining how dry_run behaves with typed output schemas and that the preview is returned as an error-flagged result, which is not obvious from the schema alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a list of Test Run Comments.' It clearly distinguishes this from sibling tools like getTestRunComments and patchTestRunComments by emphasizing creation, and the added 'Effect' clause reinforces what the operation does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description conveys clear context for the create action and provides a concrete workflow tip (use dry_run first), but it does not explicitly state when NOT to use this tool or mention alternatives such as patchTestRunComments for updates. Usage is implied rather than directly contrasted with siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRunParameterDefinitionsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Parameter Definition(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly discloses non-idempotency ('calling it again with the same input creates a duplicate; it is not idempotent'), which aligns with and adds value beyond the idempotentHint=false annotation. It also explains the dry_run preview behavior and the error-flagged result quirk, which is valuable behavioral context not present in annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, followed by the non-idempotency warning and the dry_run tip. The dry_run explanation is slightly verbose but earns its place given the unusual error-flagged preview behavior. No wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema exists and annotations cover idempotency, the description covers the key behavioral aspects: non-idempotency, dry_run preview, and the error-flag quirk. It doesn't mention response format, but the output schema handles that. It's complete enough for an agent to call correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema already documents all parameters. The description adds value by explaining the dry_run behavior in detail (redacted Authorization header, binary payload summarized) and by noting the non-idempotent effect. It doesn't add much beyond the schema for projectId/testRunId/requestBody, but the dry_run clarification is meaningful.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action ('Creates a list of Test Parameter Definitions for the specified Test Run') with a specific verb and resource. It distinguishes itself from sibling tools like getTestRunTestParameterDefinitions and postProjectTestParameterDefinitions by scoping to a Test Run and specifying the creation behavior.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear context for when to use the tool (creating test parameter definitions for a test run) and includes a strong tip to use dry_run first for preview. It doesn't explicitly name alternatives or exclusions, but the scoping to Test Run and the dry_run guidance give adequate usage direction.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRunsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Test Run(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate idempotentHint=false, but the description adds the concrete consequence of duplicate creation on repeated calls. It also explains the dry_run preview behavior and the error-flagged result, which is beyond what annotations provide. This adds useful context about side effects and output interpretation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise at three sentences, front-loads the core purpose, and then adds the effect and a practical tip. No redundant information; each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (nested objects, multiple parameters, output schema present), the description is reasonably complete. It covers the non-idempotent effect, the dry_run preview, and the output flag behavior. Prerequisites like projectId are covered in the schema. It does not mention alternatives, but that is handled under usage guidelines.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds a tip about dry_run, but this is already documented in the schema's parameter description. It does not add further meaning for projectId or requestBody beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'creates' and the resource 'list of Test Runs', which is distinct from sibling operations like getTestRuns, patchTestRuns, and deleteTestRuns. It also explicitly notes the non-idempotent behavior, making the purpose unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description includes a valuable tip about using dry_run to preview, which guides safe usage. However, it does not explicitly state when to use this tool versus alternatives (e.g., patching or deleting test runs). The purpose is implied by the name, but no explicit exclusions or alternative references are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestRunTestParametersA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| requestBody | Yes | The Test Parameter(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate non-read-only and non-idempotent; description reinforces with explicit 'not idempotent' and 'creates a new resource on each call'. Also explains dry_run error-flagged preview behavior, adding useful context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences plus a tip, no redundancy. Purpose and caveats are front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given output schema exists and schema covers parameters, description adequately covers behavior, side effects, and safe usage. No missing critical info.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema descriptions cover all parameters at 100%, so the description doesn't need to add much. The dry_run tip in description reiterates schema, but adds the 'without changing anything' context, though that's also in schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific action: creates Test Parameters for a specified Test Run. Clearly distinguishes from read-only siblings like getTestRunTestParameters and from postTestRunParameterDefinitions by resource type.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides clear context: use to create test parameters, and recommends dry_run for safe preview. Does not explicitly name alternatives or exclusions, but the operation is unambiguous.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestStepResultAttachmentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | Attachment metadata and file data. | |
| testStepIndex | Yes | The Test Step index. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already include idempotentHint=false and destructiveHint=false, but the description adds significant context: it explains that repeated calls with the same input create duplicates, describes the dry_run preview behavior (including the error-flagged result nuance for typed output schemas), and clarifies that new resources are created. This goes well beyond the annotations and fully discloses behavioral traits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is somewhat long but each sentence serves a purpose: it front-loads the core action, then provides usage guidance, then behavioral details and a tip. The structure is logical, but the multipart explanation and dry_run tip are packed densely, making it slightly heavy while still efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a complex tool with 8 parameters, the description covers all necessary aspects: how to structure the multipart request, how to match files to metadata, the non-idempotent behavior, the dry_run preview, and the alternative tools. The output schema exists, so return values needn't be detailed, but it even mentions returning created attachment IDs. Nothing essential is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% per the context, so the baseline is 3. The description adds meaningful semantics by explaining the structure of requestBody (metadata in requestBody.resource.data, files in requestBody.files, ordering, and lid matching) and the purpose of dry_run. This adds value beyond the raw schema definitions, though it could have elaborated more on the exact format of the metadata entry.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool uploads new files as attachments of a Test Step Result in a single multipart request, and explicitly distinguishes it from the sibling patch and get tools. The verb 'uploads' and specific resource (Test Step Result attachments) leave no ambiguity about what the tool does.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly states when to use this tool ('Use this to add files') and names the alternatives for changing (patchTestStepResultAttachment) and listing (getTestStepResultAttachments) attachments. Also provides guidance on dry_run usage and non-idempotency, giving clear direction for appropriate invocation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestStepResultsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| iteration | Yes | The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter). | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| testRunId | Yes | The Test Run's ID within its project. | |
| testCaseId | Yes | The Test Case's ID being referenced. | |
| requestBody | Yes | The Test Step Result(s) body. | |
| testCaseProjectId | Yes | The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate idempotentHint=false, but the description reinforces this and adds valuable context: the dry_run behavior, the error-flagged preview, and the instruction to read text content regardless of the flag. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each with a distinct purpose: purpose, non-idempotency, and dry_run tip. Front-loaded with the core action, no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 7-parameter tool with nested objects and an output schema, the description covers key behavioral aspects (non-idempotency, dry_run). It doesn't need to explain return values since output schema exists. Minor gap: no explicit mention of prerequisites beyond schema, but that's acceptable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description does not add meaning beyond the schema; it only references dry_run which is already documented in the schema. No need to compensate for gaps.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it creates a list of Test Step Results, a specific verb-resource pair. It explicitly notes non-idempotency, which distinguishes it from getTestStepResults (read) and patchTestStepResults (update) among siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states this is a create operation and warns about duplication, but does not explicitly contrast with sibling update tools (e.g., patchTestStepResults) or state when NOT to use it. The dry_run tip implies a safe preview workflow but lacks explicit alternative routing.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postTestStepsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Test Step(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses non-idempotence in concrete terms: each call creates a new resource and duplicate inputs produce duplicates. It also explains the dry_run preview's error-flagged output and instructs to read text content regardless, going well beyond the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, front-loaded with the core action, then the side effect, then the preview tip. Every sentence contributes distinct information with no filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description plus schema covers required arguments, non-idempotent side effects, and the unusual preview error-flag behavior. Since an output schema exists, not describing return values is acceptable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
All parameters are already fully described in the schema, so the description need not repeat them. The dry_run tip adds usage context but no new semantic meaning beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb ('Creates') and resource ('a list of Test Steps'), so an agent knows exactly what the operation does. It is clearly distinguishable from sibling get/patch/delete test-step tools by action and resource.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives an explicit safe-invocation rule: set dry_run: true first to preview the request before actually creating anything. It stops short of naming alternative tools or exclusion conditions, but the usage context is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postUsersA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The User(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds valuable behavioral context beyond annotations. It explains that each call creates a new resource and that repeated calls with the same input produce duplicates, elaborating on the idempotentHint=false annotation. It also details the dry_run preview behavior, including the error-flagged result quirk, which is not covered by annotations. No contradiction exists.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences, front-loaded with the core purpose and effect, followed by a concise, actionable tip. Every sentence contributes meaning without redundancy or filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description is adequate for a creation tool with a typed output schema. It covers the essential non-idempotency caveat and the dry_run mechanism. It does not explain return values, but the presence of an output schema covers that. It could mention authentication requirements or required fields (e.g., 'id' is required), but these are in the schema, so the description is sufficiently complete for safe invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already provides thorough descriptions for both parameters, including the dry_run parameter's validation and preview behavior. The tool description's tip about dry_run adds a practical use case but does not introduce new meaning beyond the schema. Since schema coverage is 100%, the description adds minimal incremental value for parameters.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's function: 'Creates a list of Users.' It distinguishes this from read/update siblings like getUsers, getUser, and patchUser by explicitly framing it as a creation action. It also highlights the non-idempotent effect, reinforcing the purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use this tool: when you need to create users. It does not explicitly name alternatives or exclusions, but the verb 'creates' and the contrast with sibling get/patch tools make the usage context clear. The dry_run tip provides practical guidance on how to safely use it, which adds to usage clarity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postWorkItemApprovalsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Work Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Discloses non-idempotency and duplicate creation, and details the dry_run preview behavior including the error-flagged output nuance. This goes well beyond the annotations, which only state idempotentHint=false, and gives the agent concrete expectations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three concise sentences cover purpose, side effect, and usage tip with no redundancy. The key creation semantics are front-loaded, and each sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Handles the write-operation caveats (duplicates), dry_run workflow, and preview behavior. With an output schema present, return-value explanation is unnecessary. Minor absence: no mention of authentication or prerequisite user existence, but the schema covers required fields sufficiently.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with detailed parameter descriptions, so the baseline is 3. The description adds practical value by recommending dry_run and explaining how its preview is returned (error-flagged text content), which is meaningful beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description begins with 'Creates a list of WorkItem Approvals', naming a specific verb and resource. It also explicitly states the side effect of duplicate creation, which distinguishes it from related tools like getWorkItemApprovals and patchWorkItemApprovals without requiring schema inspection.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The creation semantics are self-evident)Skip and the dry_run tip gives a clear safe-preview workflow. However, it does not explicitly contrast with patch/delete approval siblings, leaving the 'when not to use' slightly implicit.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postWorkItemAttachmentsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | Attachment metadata and file data. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark non-idempotent, but the description adds explicit detail: calling again creates a duplicate, and the dry_run preview behavior with error-flagged results is disclosed. No contradiction with annotations; it enhances them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is somewhat long but every sentence carries essential information: purpose, structure, return, usage guidance, idempotency, and dry_run tip. It's front-loaded with the main action and well organized, though slightly dense.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of a multipart upload with dry_run and output schema, the description covers all necessary aspects: what it does, how to structure the request, return value, idempotency, and alternative tools. Nothing critical is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds critical structural meaning to requestBody: explains resource.data holds metadata and files holds base64 bytes, including the lid matching mechanism. This goes well beyond the schema's generic description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool uploads new files as attachments to a Work Item, using a specific verb and resource. It explicitly differentiates from siblings like patchWorkItemAttachment (for changing) and getWorkItemAttachments (for listing), so an agent can easily distinguish it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says when to use this tool ('Use this to add files') and points to alternatives for other operations, plus a dry_run tip for safe preview. No ambiguity about usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postWorkItemRelationshipsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Relationship body. | |
| relationshipId | Yes | The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already carry idempotentHint=false, but the description adds concrete behavioral detail: repeated calls with identical input create duplicates, and dry_run returns an error-flagged preview that is not real tool output. This goes beyond the structured annotations and helps the agent interpret unexpected results.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core purpose, followed by non-idempotency and the dry-run tip. It is somewhat repetitive around the non-idempotence point, but every sentence contributes actionable information and the length is appropriate.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description could say more about success responses, but the rich parameter schema plus the non-idempotency warning and dry-run error-flag explanation cover the main invocation risks. The tool is complex due to nested requestBody and oneOf options, yet the schema carries that burden effectively.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the schema already documents all five parameters thoroughly. The description's dry_run tip adds usage context but not new parameter semantics beyond what the schema provides, keeping this at baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and resource: 'Creates a list of Work Item Relationships.' The create semantics clearly distinguish it from sibling mutators like patchWorkItemRelationships and deleteWorkItemsRelationship, and the resource scope is unambiguous from the name and body.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear operational context: it creates a new resource each call and recommends using dry_run first to preview without side effects. It does not explicitly name alternatives or state when-not-to-use, but the create-purpose and dry-run tip provide enough contextual guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postWorkItemsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | The Work Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes well beyond the annotations: it explicitly states that repeated calls create duplicates, that dry_run changes nothing, and that the dry_run preview appears as an error-flagged result despite being informational. These details are not present in the readOnly/openWorld/idempotent/destructive hints and give the agent essential safe-calling behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, each earning its place: purpose+non-idempotence, dry_run preview advice, and the error-flag caveat. The most decision-relevant information is front-loaded, and no words are wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a create tool with a large nested request body and an output schema, the description covers the critical operational facts: what it does, non-idempotence, and how to safely preview. It doesn't address auth requirements or rate limits, but those are not needed for basic correct invocation given the schema's completeness.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema already provides full descriptions for all three parameters (100% coverage), so the description adds little new param-level meaning. The dry_run tip reinforces the schema's own description, but doesn't materially extend the semantics of projectId or requestBody.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with 'Creates a list of Work Items,' a specific verb and resource that clearly distinguishes it from sibling tools like patchWorkItems, deleteWorkItems, and getWorkItems. It also provides the key non-idempotence effect, so an agent knows exactly what action this tool performs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives clear operational context: it creates new resources, is non-idempotent, and recommends a dry_run preview first. It does not explicitly name sibling tools or state when not to use it, but the create-vs-modify contrast with nearby tools is implicit in the wording.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
postWorkRecordsA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| workItemId | Yes | The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads. | |
| requestBody | Yes | The Linked Work Item(s) body. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly declares non-idempotency ('calling it again with the same input creates a duplicate'), going beyond what idempotentHint=false alone conveys by spelling out the duplicate result. It also discloses the unusual dry_run semantics — previews surface as error-flagged results whose text content must still be read — which the annotations do not cover at all. There is no contradiction between the description and the readOnly/idempotent/destructive hints.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Four sentences, each earning its place: purpose, side-effect warning, safety tip, and result-interpretation quirk. The most critical facts (creates + duplicates) are front-loaded, and there is no filler or repetition of schema boilerplate.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the output schema, annotations, and 100% parameter coverage already present, the description's remaining job was the behavioral layer, and it is thorough: side effects, the preview path, and result interpretation are all disclosed. Nothing an agent needs to safely call this non-idempotent write tool is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so projectId, workItemId, requestBody, and dry_run basics are already documented in the schema. The description adds genuine interpretation value for dry_run, explaining that its preview is returned as an error-flagged result and should be read regardless of that flag — a nuance absent from the schema's dry_run text. The other parameters need no description-level augmentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource, 'Creates a list of Work Records,' which clearly identifies the operation and its collection nature. The resource type, Work Records, is distinct from nearby siblings such as postWorkItems and getWorkRecords, so an agent can infer the write intent without opening the schema. However, it never explicitly names a sibling or contrast to disambiguate further, so it does not fully earn a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The dry_run tip offers a concrete, safe invocation workflow ('preview the exact request first, without changing anything'), which is practical guidance for a non-idempotent write tool. But the description never states when to prefer this tool over alternatives like postWorkItems or patchWorkItems, and any prerequisites are left to the schema (e.g., 'call getProjects'). Usage context is implied rather than explicitly scoped.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reopenCollectionA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| collectionId | Yes | The Collection ID. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With idempotentHint=false already present, the description adds meaningful context: it warns the operation is a server-side action whose repeated execution may be unsafe, a no-op, or rejected, and it recommends dry_run to preview without side effects. It also explains the error-flagged preview behavior. This is consistent with the annotations and adds value beyond them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with the core action and keeps the caveats to three sentences. The dry_run behavior is slightly redundant with the schema and the 'typed output schema' clause is tangential for this tool, but overall it is well-sized.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a two-required-parameter action with annotations covering idempotency and destructive behavior, the description gives sufficient warning and a safe preview path. It does not describe return values, but no output schema exists, and the missing usage routing is a smaller gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the baseline is 3. The description adds only a dry_run recommendation, which the schema already describes in detail; it does not clarify collectionId beyond what the schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The opening sentence names a concrete verb ('Reopens') and a specific resource ('the specified Collection'), so an agent can tell what the tool acts on. It does not directly differentiate itself from closeCollection or reuseCollection, but 'reopens' is unambiguous enough to convey its core function.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement about when to call this tool instead of closeCollection or reuseCollection, nor conditions such as 'only for already-closed collections.' The only guidance is to use dry_run for previewing, which is about safe invocation rather than tool selection.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
reuseCollectionA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| revision | No | A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. | |
| requestBody | Yes | Reusing parameters. | |
| collectionId | Yes | The Collection ID. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial context beyond the annotations: explains this is a server-side action, elaborates the idempotency hint into concrete outcomes (safe/no-op/rejected), and discloses the non-obvious quirk that dry-run previews arrive as error-flagged results. This is genuinely valuable behavioral disclosure that annotations alone do not provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences each earn their place: the core action, the behavioral caveat, and the dry-run tip. The main verb+resource is front-loaded. The final sentence is slightly long but packs necessary edge-case information about the error flag.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with 5 params, a nested object, and an output schema, the description covers the critical non-obvious behaviors: non-idempotency and the dry-run error-flag quirk. The output schema relieves the need to describe return values, and the requestBody parameters clarify what 'reuse' means. Minor gap: no explicit statement of required permissions or what happens to the source collection.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the schema fully documents all five parameters and the nested requestBody fields. The description adds minimal parameter-level meaning — it only reinforces dry_run's purpose in the tip. Baseline 3 is appropriate since the schema does the heavy lifting.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Reuses the specified Collection') and distinguishes the operation from 'a plain resource creation', which separates it from siblings like postCollections. However, the actual semantics of 'reuse' (copying into a target project) are only inferable from the requestBody parameters, so the purpose is clear but not fully pinned down.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides a concrete, actionable tip ('set dry_run: true first to preview the exact request') and cautions that repetition is 'not guaranteed idempotent'. But it never explicitly names alternatives or states when to prefer them over this tool; the contrast with 'plain resource creation' only implies postCollections would be the alternative.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
setLicenseA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | Yes | The user license body. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explicitly warns that the operation is a server-side action and 'not guaranteed idempotent,' adding nuance beyond the idempotentHint=false annotation. It also explains the dry_run preview behavior, including the error-flagged result, which is genuinely useful behavioral context. Nothing contradicts the annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with the core action, followed by a valuable safety warning and a concrete usage tip. No filler; the generic note about typed output schemas earns its place because it prevents misinterpretation of the dry_run result.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the non-idempotent nature, the dry-run workflow, and the fact that previews are returned as error-flagged results, which is important given there is no output schema. It does not describe the normal success response or error cases for an actual call, but the combination of schema coverage and behavioral warnings is largely sufficient for safe invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With schema description coverage at 100%, the schema already documents userId, dry_run, and requestBody, including the license enum. The description reinforces dry_run usage but does not add semantic detail beyond the schema, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb and object ('Sets the User's license'), making the tool's primary function immediately clear. It does not explicitly contrast itself with sibling license tools such as patchLicenseAssignment or getLicenseAssignmentsForUser, so it misses the top tier for sibling differentiation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The dry-run tip gives a concrete, safe invocation strategy ('set dry_run: true first to preview... without changing anything'), which is clear usage guidance. It does not, however, name alternative tools or state when setLicense should be chosen over patchLicenseAssignments or other license-related siblings, so exclusions are absent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unmarkProjectA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| projectId | Yes | The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs. |
Output Schema
| Name | Required | Description |
|---|---|---|
| data | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare non-idempotent and non-destructive, but the description adds crucial detail: it triggers a server-side action, idempotency is not guaranteed, and it returns a jobs resource requiring polling. Also explains dry_run preview behavior and error-flagging. No contradiction with annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense but every sentence earns its place: main effect, async behavior, usage comparison, idempotency warning, and dry_run tip. Front-loaded with the core action, well-structured, and not redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (async, non-idempotent, reversible), the description is comprehensive. It covers what it does, how to use it, what to expect (jobs resource), how to verify completion, and contrasts with siblings. The output schema exists, so return format is covered elsewhere. Nothing missing for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema descriptions for both parameters are highly detailed (dry_run explains exact request preview, projectId explains case-sensitivity and scoping). The description adds a usage tip for dry_run but does not add meaning beyond schema; baseline for 100% coverage is 3.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (Removes), resource (Polarion project marker), and explains the effect on the project (no longer appears/works as a project) while data stays. Clearly distinguishes from markProject (re-registration) and deleteProject (deletes data).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly provides when to use (retire a project reversibly), when not (use deleteProject to delete data), and mentions the async job with polling via getJob. Also recommends dry_run for preview, giving clear operational guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
updateAvatarA
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.
| Name | Required | Description | Default |
|---|---|---|---|
| userId | Yes | The User ID. | |
| dry_run | No | If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it. | |
| requestBody | No | Avatar file data. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already mark idempotentHint false and readOnlyHint false; the description adds context that this triggers a server-side action and that repetition may be safe, a no-op, or rejected. It also explains the dry_run preview behavior and the error-flag caveat, going beyond the schema. This aligns with annotations and adds practical operational detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is relatively short, leading with the core purpose. The second sentence is dense and the third is a lengthy tip, but each sentence earns its place by conveying non-obvious idempotency and dry_run behavior. It could be tightened, but it is not bloated.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool without output schema, the description explains key behavioral caveats (non-idempotency) and a safe preview mechanism. It does not list return values, but the absence of an output schema makes that less critical. Combined with full parameter schemas and helpful annotations, it gives an agent enough to invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The input schema covers 100% of parameters with descriptions, including dry_run's full semantics. The description simply repeats the dry_run tip without adding new meaning beyond the schema. Since schema coverage is high, baseline 3 applies; no extra parameter insights are provided.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states 'Updates the specified User Avatar' – a specific verb and resource. It clearly distinguishes from siblings like getAvatar (retrieve) and patchUser (generic user update). No ambiguity about what entity is affected.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage (to update a user's avatar) but never explicitly compares to alternatives such as getAvatar or patchUser. It offers a dry_run tip, which is guidance on how to invoke, not when to choose this over siblings. No when-not or exclusion criteria are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
22 tool updates
v1.2.2- Changed
deleteCollectionsRelationship1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
deletePageRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
deletePlanRelationship1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
deleteWorkItemsRelationship1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
getAvailableEnumOptionsForDocument1 field changed- changed
Input schema / properties / fieldId / descriptionPrevious value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
- Changed
getAvailableEnumOptionsForDocumentType1 field changed- changed
Input schema / properties / fieldId / descriptionPrevious value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
- Changed
getAvailableEnumOptionsForWorkItem1 field changed- changed
Input schema / properties / fieldId / descriptionPrevious value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
- Changed
getAvailableEnumOptionsForWorkItemType1 field changed- changed
Input schema / properties / fieldId / descriptionPrevious value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
- Changed
getCollectionsRelationship1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
getCurrentEnumerationOptionsForDocument1 field changed- changed
Input schema / properties / fieldId / descriptionPrevious value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
- Changed
getCurrentEnumOptionsForWorkItem1 field changed- changed
Input schema / properties / fieldId / descriptionPrevious value: -"The Field ID."New value: +"The ID of an enumeration-typed field (e.g. `status`, `severity`, `priority`, or a custom enum field ID), not its display label. Use the matching getFieldsMetadataFor* tool to discover field IDs."
- Changed
getPageRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
getPlanRelationship1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
getWorkItemsRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
patchCollectionsRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
patchPageRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
patchPlanRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
patchWorkItemRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
postCollectionsRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
postPageRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
postPlanRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
- Changed
postWorkItemRelationships1 field changed- changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
283 tool updates
v1.2.0- Changed
branchDocument4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
branchDocuments1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
closeCollection2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
copyDocument4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
createProject1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
deleteAllWorkItems1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
deleteApproval3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteApprovals3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteCollection2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteCollections2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteCollectionsRelationship3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
- Changed
deleteDocumentParts3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
deleteExternallyLinkedWorkItem3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteExternallyLinkedWorkItems3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteGlobalCustomFields2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
deleteGlobalEnumeration2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
deleteLicenseSlots1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
deleteLinkedWorkItem3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteLinkedWorkItems3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteOslcResources3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deletePage4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
deletePageAttachment5 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
deletePageRelationships5 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
deletePlan2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deletePlanRelationship3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
- Changed
deletePlans2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteProject2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteProjectCustomFields3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
deleteProjectEnumeration3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
deleteProjectTestParameterDefinition2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteProjectTestParameterDefinitions2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteTestRecord6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRecordAttachment7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRecordAttachments6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRecordTestParameter6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRun3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRunAttachment4 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRunAttachments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRuns2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteTestRunTestParameter3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRunTestParameterDefinition3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestRunTestParameters3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestStep3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteTestStepResultAttachment7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestStepResultAttachments6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
deleteTestSteps3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteWorkItemAttachment4 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteWorkItems2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
deleteWorkItemsRelationship4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteWorkRecord3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
deleteWorkRecords3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
executeJob1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
generateCompletion1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
getAllDocuments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getAllPages7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getAllWorkItems7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getAvailableEnumOptionsForDocument4 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getAvailableEnumOptionsForDocumentType3 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getAvailableEnumOptionsForWorkItem4 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getAvailableEnumOptionsForWorkItemType3 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getBacklinkedWorkItems7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getCollection4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getCollections8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getCollectionsRelationship7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getComment5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getComments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getCurrentEnumerationOptionsForDocument5 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getCurrentEnumOptionsForWorkItem5 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getCurrentUser3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getDefaultIcon2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / iconId / descriptionPrevious value: -"The Icon ID."New value: +"The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons)."
- Changed
getDefaultIcons3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
- Changed
getDocument5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentAttachment6 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentAttachmentContent4 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentAttachments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentComment5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentComments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentPart5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocumentParts7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getDocuments8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getExportExcelTests3 fields changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getExternallyLinkedWorkItem5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getExternallyLinkedWorkItems7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getFeatureSelection5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getFeatureSelections7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getFieldsMetadataForCollection1 field changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getFieldsMetadataForDocument2 fields changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getFieldsMetadataForPlan1 field changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getFieldsMetadataForTestRecord5 fields changed- changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getFieldsMetadataForTestRun2 fields changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getFieldsMetadataForWorkItem2 fields changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getGlobalCustomFields3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
getGlobalEnumeration3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
getGlobalEnumerations3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
- Changed
getGlobalFieldsMetadata1 field changed- changed
Input schema / properties / targetType / descriptionPrevious value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
getGlobalIcon2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / iconId / descriptionPrevious value: -"The Icon ID."New value: +"The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons)."
- Changed
getGlobalIcons3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
- Changed
getGlobalPages6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getJob3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / jobId / descriptionPrevious value: -"The Job ID."New value: +"The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status."
- Changed
getJobLogContent1 field changed- changed
Input schema / properties / jobId / descriptionPrevious value: -"The Job ID."New value: +"The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status."
- Changed
getJobResultFileContent1 field changed- changed
Input schema / properties / jobId / descriptionPrevious value: -"The Job ID."New value: +"The asynchronous job's ID, returned when the triggering call responds with a `jobs` resource. Poll getJob with this ID to check completion status."
- Changed
getJobs5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getLicense2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."
- Changed
getLicenseAssignments4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
- Changed
getLicenseAssignmentsForUser2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."
- Changed
getLicenseSlot2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."
- Changed
getLicenseSlots5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getLinkedWorkItem5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getLinkedWorkItems7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getLlms2 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
- Changed
getMetadata2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."
- Changed
getOslcResources9 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getPage6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPageAttachment7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPageAttachmentContent5 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPageAttachments8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPageComment6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPageComments8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPageRelationships9 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getPages8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getPlan4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getPlanRelationship7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getPlans9 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)." - changed
Input schema / properties / templates / descriptionPrevious value: -"If set to true, only templates will be returned, otherwise only actual instances will be returned."New value: +"If true, only return template resources; if false or omitted, return only actual (non-template) instances."
- Changed
getProject4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getProjectCustomFields4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
getProjectEnumeration4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
getProjectEnumerations4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getProjectFieldsMetadata2 fields changed- changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Type of the object. Use '~' without quotes to represent no target Type."New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
getProjectIcon3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / iconId / descriptionPrevious value: -"The Icon ID."New value: +"The icon's ID, as returned by the corresponding icon-listing endpoint (getDefaultIcons/getGlobalIcons/getProjectIcons)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getProjectIcons4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getProjects7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getProjectTemplates4 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set."
- Changed
getProjectTestParameterDefinition3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getProjectTestParameterDefinitions5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
getRepositorySpacePages8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getRevision3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getRevisions6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getRole2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource."
- Changed
getSpaceDocuments8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getSpacePages8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
getTestRecord8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRecordAttachment9 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRecordAttachmentContent7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRecordAttachments10 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRecords9 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"testCaseId"New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"testCaseProjectId"New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRecordTestParameter8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRecordTestParameters10 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRun5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunAttachment6 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunAttachmentContent4 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunAttachments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - added
Input schema / properties / testRunId / descriptionAdded value: +"The Test Run's ID within its project."
- Changed
getTestRunComment5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunComments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRuns9 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)." - changed
Input schema / properties / templates / descriptionPrevious value: -"If set to true, only templates will be returned, otherwise only actual instances will be returned."New value: +"If true, only return template resources; if false or omitted, return only actual (non-template) instances."
- Changed
getTestRunTestParameter5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunTestParameterDefinition5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunTestParameterDefinitions7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestRunTestParameters7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestStep5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getTestStepResult8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestStepResultAttachment9 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestStepResultAttachmentContent7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestStepResultAttachments10 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestStepResults10 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getTestSteps7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getUser3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getUserGroup3 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
getUsers7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getWorkflowActionsForTestRun5 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
getWorkflowActionsForWorkItem5 fields changed- changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItem5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemApproval5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemApprovals7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemAttachment6 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemAttachmentContent4 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemAttachments7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - added
Input schema / properties / workItemId / descriptionAdded value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItems8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / query / descriptionPrevious value: -"The query string."New value: +"Polarion Lucene-style query string to filter results: field:value clauses combined with AND/OR, phrases in quotes. Exact supported field names depend on the resource type being queried." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / sort / descriptionPrevious value: -"The sort string."New value: +"Comma-separated list of fields to sort by, in priority order; prefix a field with `-` for descending order (e.g. `-updated,title`)."
- Changed
getWorkItemsRelationships8 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemTestParameterDefinition5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkItemTestParameterDefinitions7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkRecord5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
getWorkRecords7 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Sparse fieldset selector: an object keyed by resource type (e.g. `workitems`) whose value is a comma-separated list of attribute names to return (e.g. `id,title,status`), reducing payload size. Omit to return the default field set." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Comma-separated list of related resource types to embed in the response (e.g. `author,attachments`) so they don't require a separate follow-up call. Omit to return only the primary resource." - changed
Input schema / properties / page_number_ / descriptionPrevious value: -"Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"1-based page number to fetch when the result set is paginated (e.g. `2` for the second page). Combine with `page[size]`; omit to fetch the first page." - changed
Input schema / properties / page_size_ / descriptionPrevious value: -"Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Maximum number of items to return in this page (e.g. `100`). Use together with `page[number]` to paginate through a large result set." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
importExcelTestResults3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
importWordDocument3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
importXUnitTestResults3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
markProject1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
mergeDocumentFromMaster3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
mergeDocumentToMaster3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
moveDocumentParts3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
moveFromDocument3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
moveProjectAction2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
moveToDocument3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
moveWorkItemsToDocument2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
overwriteDocumentParts3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchAllWorkItems1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
patchCollections2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
patchCollectionsRelationships3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
- Changed
patchComment3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchCustomField3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Custom Field target type. (Use '~' when there is no specific type for the Prototype.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
patchDocument3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchDocumentAttachment4 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchDocumentComment3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchGlobalCustomFields2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Custom Field target type. (Use '~' when there is no specific type for the Prototype.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
patchGlobalEnumeration2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
patchLicense1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
patchLicenseAssignment1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
patchLicenseAssignments1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
patchLinkedWorkItem3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchPageAttachment5 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchPageComment4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchPageRelationships5 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchPlan2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
patchPlanRelationships3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
- Changed
patchProject2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
patchProjectEnumeration3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / targetType / descriptionPrevious value: -"The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)"New value: +"Identifies the target resource type this operation applies to (e.g. `workitem`). Use `~` (no quotes) to mean no specific target type."
- Changed
patchRichPage4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
patchTestRecord6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestRecordAttachment7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestRecords3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestRun3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestRunAttachment4 fields changed- added
Input schema / properties / attachmentId / descriptionAdded value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - added
Input schema / properties / testRunId / descriptionAdded value: +"The Test Run's ID within its project."
- Changed
patchTestRunComment3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestRunComments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestRuns2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
patchTestStep3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchTestStepResult6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestStepResultAttachment7 fields changed- changed
Input schema / properties / attachmentId / descriptionPrevious value: -"The Attachment ID."New value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestStepResults6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
patchTestSteps3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchUser1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
patchWorkItem3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchWorkItemApproval3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchWorkItemApprovals3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchWorkItemAttachment4 fields changed- added
Input schema / properties / attachmentId / descriptionAdded value: +"The attachment's ID, as returned by the corresponding list- or get-attachments call for this resource." - changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - added
Input schema / properties / workItemId / descriptionAdded value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchWorkItemRelationships4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
patchWorkItems2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postBacklinkedWorkItems3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postCollections2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postCollectionsRelationships3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
- Changed
postComments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postDocumentComments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postDocumentItemAttachments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postDocumentParts3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postDocuments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postExternallyLinkedWorkItems3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postGlobalCustomFields1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
postGlobalEnumeration1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
postGlobalIcons1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
postLicenseSlots1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
postLinkedWorkItems3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postOslcResources3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postPageAttachments4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - added
Input schema / properties / pageName / descriptionAdded value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - added
Input schema / properties / spaceId / descriptionAdded value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postPageComments4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postPageRelationships5 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / pageName / descriptionPrevious value: -"The Page name."New value: +"The Rich Page's ID/name within its space — its stable identifier, not its display title." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postPages3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / spaceId / descriptionPrevious value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
- Changed
postPlanRelationships3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
- Changed
postPlans2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postProjectCustomFields2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postProjectEnumeration2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postProjectIcons2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postProjectTestParameterDefinitions2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postTestRecordAttachments6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestRecords3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestRecordTestParameters6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestRunAttachments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - added
Input schema / properties / testRunId / descriptionAdded value: +"The Test Run's ID within its project."
- Changed
postTestRunComments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestRunParameterDefinitions3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestRuns2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postTestRunTestParameters3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestStepResultAttachments6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestStepResults6 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / iteration / descriptionPrevious value: -"The Iteration Number."New value: +"The iteration number identifying which repeated occurrence of this item is being addressed (e.g. which run of a test parameter)." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / testCaseId / descriptionPrevious value: -"The Testcase ID."New value: +"The Test Case's ID being referenced." - changed
Input schema / properties / testCaseProjectId / descriptionPrevious value: -"The Testcase Project ID."New value: +"The project ID that owns the referenced Test Case — may differ from the project in the request path when the test case is shared from another project." - changed
Input schema / properties / testRunId / descriptionPrevious value: -"The Test Run ID."New value: +"The Test Run's ID within its project."
- Changed
postTestSteps3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postUsers1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
postWorkItemApprovals3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postWorkItemAttachments3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - added
Input schema / properties / projectId / descriptionAdded value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - added
Input schema / properties / workItemId / descriptionAdded value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postWorkItemRelationships4 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / relationshipId / descriptionPrevious value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
postWorkItems2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
postWorkRecords3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / workItemId / descriptionPrevious value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
- Changed
reopenCollection2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
reuseCollection3 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs." - changed
Input schema / properties / revision / descriptionPrevious value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
- Changed
setLicense1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
- Changed
unmarkProject2 fields changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it." - changed
Input schema / properties / projectId / descriptionPrevious value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
- Changed
updateAvatar1 field changed- changed
Input schema / properties / dry_run / descriptionPrevious value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
176 tool updates
v1.1.0- Changed
branchDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "autoSuspect": { + "type": "boolean" + }, + "branchedWithInitializedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "branchedWithQuery": { + "example": "Branched with Query", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "derivedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "derivedFromLinkRole": { + "example": "relates_to", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "moduleFolder": { + "example": "MySpaceId", + "type": "string" + }, + "outlineNumbering": { + "properties": { + "prefix": { + "example": "ABC", + "type": "string" + } + }, + "type": "object" + }, + "renderingLayouts": { + "items": { + "properties": { + "label": { + "example": "My label", + "type": "string" + }, + "layouter": { + "example": "paragraph", + "type": "string" + }, + "properties": { + "items": { + "properties": { + "key": { + "example": "fieldsAtStart", + "type": "string" + }, + "value": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "example": "draft", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "req_specification", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "usesOutlineNumbering": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "branchedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "derivedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "variant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
branchDocuments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
copyDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "autoSuspect": { + "type": "boolean" + }, + "branchedWithInitializedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "branchedWithQuery": { + "example": "Branched with Query", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "derivedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "derivedFromLinkRole": { + "example": "relates_to", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "moduleFolder": { + "example": "MySpaceId", + "type": "string" + }, + "outlineNumbering": { + "properties": { + "prefix": { + "example": "ABC", + "type": "string" + } + }, + "type": "object" + }, + "renderingLayouts": { + "items": { + "properties": { + "label": { + "example": "My label", + "type": "string" + }, + "layouter": { + "example": "paragraph", + "type": "string" + }, + "properties": { + "items": { + "properties": { + "key": { + "example": "fieldsAtStart", + "type": "string" + }, + "value": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "example": "draft", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "req_specification", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "usesOutlineNumbering": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "branchedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "derivedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "variant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
createProject1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
deleteProject1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
executeJob1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
generateCompletion1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "description": "Response body for LLM completion generation.", + "properties": { + "data": { + "description": "The result of a completion generation request.", + "properties": { + "message": { + "description": "A message in the LLM completion generation request or response.", + "properties": { + "content": { + "description": "Content of the message.", + "type": "string" + }, + "role": { + "description": "Role of the message sender, e.g., 'user' or 'assistant.'", + "example": "user", + "type": "string" + } + }, + "required": [ + "content", + "role" + ], + "type": "object" + } + }, + "required": [ + "message" + ], + "type": "object" + } + }, + "type": "object" +}
- Changed
getAllDocuments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "autoSuspect": { + "type": "boolean" + }, + "branchedWithInitializedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "branchedWithQuery": { + "example": "Branched with Query", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "derivedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "derivedFromLinkRole": { + "example": "relates_to", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "moduleFolder": { + "example": "MySpaceId", + "type": "string" + }, + "moduleName": { + "example": "MyDocumentId", + "type": "string" + }, + "outlineNumbering": { + "properties": { + "prefix": { + "example": "ABC", + "type": "string" + } + }, + "type": "object" + }, + "renderingLayouts": { + "items": { + "properties": { + "label": { + "example": "My label", + "type": "string" + }, + "layouter": { + "example": "paragraph", + "type": "string" + }, + "properties": { + "items": { + "properties": { + "key": { + "example": "fieldsAtStart", + "type": "string" + }, + "value": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "example": "draft", + "type": "string" + }, + "structureLinkRole": { + "example": "relates_to", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "req_specification", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "usesOutlineNumbering": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "branchedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "derivedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "variant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getAllPages1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "pageName": { + "example": "MyRichPageId", + "type": "string" + }, + "spaceId": { + "example": "MySpaceId", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getAllWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "dueDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "hyperlinks": { + "items": { + "properties": { + "role": { + "example": "ref_ext", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "uri": { + "example": "https://polarion.plm.automation.siemens.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "example": "MyWorkItemId", + "type": "string" + }, + "initialEstimate": { + "example": "5 1/2d", + "type": "string" + }, + "outlineNumber": { + "example": "1.11", + "type": "string" + }, + "plannedEnd": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "plannedStart": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "example": "90.0", + "type": "string" + }, + "remainingEstimate": { + "example": "5 1/2d", + "type": "string" + }, + "resolution": { + "example": "done", + "type": "string" + }, + "resolvedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "severity": { + "example": "blocker", + "type": "string" + }, + "status": { + "example": "open", + "type": "string" + }, + "timeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "task", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "approvals": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_approvals" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "assignee": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "backlinkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "categories": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCategoryId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "categories" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "externallyLinkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "externallylinkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedOslcResources": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedoslcresources" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedRevisions": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "default/1234", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "revisions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "module": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "plannedIn": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testSteps": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "votes": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workRecords": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyWorkRecordId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitems", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getAvailableEnumOptionsForDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getAvailableEnumOptionsForDocumentType1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getAvailableEnumOptionsForWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getAvailableEnumOptionsForWorkItemType1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getBacklinkedWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "revision": { + "example": "1234", + "type": "string" + }, + "role": { + "example": "relates_to", + "type": "string" + }, + "suspect": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "sourceWorkItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getCollection1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "closedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "ID", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "downstreamCollections": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "reusedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "richPages": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testRuns": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "upstreamCollections": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getCollections1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "closedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "ID", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "downstreamCollections": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "reusedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "richPages": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testRuns": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "upstreamCollections": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/collections", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getCollectionsRelationship1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "description": "The Relationship's response body. Can return a single or a list of instances", + "example": { + "data": [ + { + "id": "MyProjectId/WI-123", + "type": "workitems" + } + ] + }, + "oneOf": [ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" +}
- Changed
getComment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "example": "Title", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "example": "Title", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getCurrentEnumerationOptionsForDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getCurrentEnumOptionsForWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getCurrentUser1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "avatarUrl": { + "example": "http://server-host-name/application-path/icons/avatar/MyUserId/avatar.png?revision=1234", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "disabledNotifications": { + "type": "boolean" + }, + "email": { + "example": "Email", + "type": "string" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "initials": { + "example": "Initials", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/users/MyUserId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "addOnLicenseSlots": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "baseLicenseSlot": { + "properties": { + "data": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "globalRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "globalroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "projectroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "userGroups": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserGroupId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "usergroups" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/users/MyUserId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDefaultIcon1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "iconUrl": { + "example": "pathexample", + "type": "string" + }, + "id": { + "example": "pathexample", + "type": "string" + }, + "path": { + "example": "pathexample", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDefaultIcons1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "iconUrl": { + "example": "pathexample", + "type": "string" + }, + "id": { + "example": "pathexample", + "type": "string" + }, + "path": { + "example": "pathexample", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "autoSuspect": { + "type": "boolean" + }, + "branchedWithInitializedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "branchedWithQuery": { + "example": "Branched with Query", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "derivedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "derivedFromLinkRole": { + "example": "relates_to", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "moduleFolder": { + "example": "MySpaceId", + "type": "string" + }, + "moduleName": { + "example": "MyDocumentId", + "type": "string" + }, + "outlineNumbering": { + "properties": { + "prefix": { + "example": "ABC", + "type": "string" + } + }, + "type": "object" + }, + "renderingLayouts": { + "items": { + "properties": { + "label": { + "example": "My label", + "type": "string" + }, + "layouter": { + "example": "paragraph", + "type": "string" + }, + "properties": { + "items": { + "properties": { + "key": { + "example": "fieldsAtStart", + "type": "string" + }, + "value": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "example": "draft", + "type": "string" + }, + "structureLinkRole": { + "example": "relates_to", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "req_specification", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "usesOutlineNumbering": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "branchedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "derivedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "variant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocumentAttachment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocumentAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocumentComment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocumentComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocumentPart1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Editable only for normal and table document parts.", + "example": "<div id=\"polarion_wiki macro name=module-workitem;params=id=workitem_MyWorkItemId\"></div>", + "type": "string" + }, + "external": { + "description": "Whether the work item is external to the document. Applicable to: workitem parts.", + "type": "boolean" + }, + "headingText": { + "description": "Applicable to: heading parts.", + "example": "Heading Title", + "type": "string" + }, + "id": { + "example": "workitem_MyWorkItemId", + "type": "string" + }, + "landscape": { + "description": "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts.", + "type": "boolean" + }, + "layout": { + "description": "Rendering layout index for the part. Applicable to: workitem parts.", + "example": 0, + "format": "int32", + "type": "integer" + }, + "level": { + "description": "Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts.", + "example": 0, + "format": "int32", + "type": "integer" + }, + "sequence": { + "description": "Sequence identifier for table of figures entry. Applicable to: tof parts.", + "example": "Table", + "type": "string" + }, + "type": { + "description": "Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation.", + "example": "workitem", + "type": "string" + }, + "wikiText": { + "description": "Wiki markup content for the block. Applicable to: wikiblock parts.", + "example": "#documentPanel(true \"approved\")", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "nextPart": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "previousPart": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocumentParts1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "content": { + "description": "Editable only for normal and table document parts.", + "example": "<div id=\"polarion_wiki macro name=module-workitem;params=id=workitem_MyWorkItemId\"></div>", + "type": "string" + }, + "external": { + "description": "Whether the work item is external to the document. Applicable to: workitem parts.", + "type": "boolean" + }, + "headingText": { + "description": "Applicable to: heading parts.", + "example": "Heading Title", + "type": "string" + }, + "id": { + "example": "workitem_MyWorkItemId", + "type": "string" + }, + "landscape": { + "description": "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts.", + "type": "boolean" + }, + "layout": { + "description": "Rendering layout index for the part. Applicable to: workitem parts.", + "example": 0, + "format": "int32", + "type": "integer" + }, + "level": { + "description": "Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts.", + "example": 0, + "format": "int32", + "type": "integer" + }, + "sequence": { + "description": "Sequence identifier for table of figures entry. Applicable to: tof parts.", + "example": "Table", + "type": "string" + }, + "type": { + "description": "Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation.", + "example": "workitem", + "type": "string" + }, + "wikiText": { + "description": "Wiki markup content for the block. Applicable to: wikiblock parts.", + "example": "#documentPanel(true \"approved\")", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "nextPart": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "previousPart": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getDocuments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "autoSuspect": { + "type": "boolean" + }, + "branchedWithInitializedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "branchedWithQuery": { + "example": "Branched with Query", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "derivedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "derivedFromLinkRole": { + "example": "relates_to", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "moduleFolder": { + "example": "MySpaceId", + "type": "string" + }, + "moduleName": { + "example": "MyDocumentId", + "type": "string" + }, + "outlineNumbering": { + "properties": { + "prefix": { + "example": "ABC", + "type": "string" + } + }, + "type": "object" + }, + "renderingLayouts": { + "items": { + "properties": { + "label": { + "example": "My label", + "type": "string" + }, + "layouter": { + "example": "paragraph", + "type": "string" + }, + "properties": { + "items": { + "properties": { + "key": { + "example": "fieldsAtStart", + "type": "string" + }, + "value": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "example": "draft", + "type": "string" + }, + "structureLinkRole": { + "example": "relates_to", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "req_specification", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "usesOutlineNumbering": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "branchedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "derivedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "variant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getExportExcelTests1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getExternallyLinkedWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "role": { + "example": "relates_to", + "type": "string" + }, + "workItemURI": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "externallylinkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getExternallyLinkedWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "role": { + "example": "relates_to", + "type": "string" + }, + "workItemURI": { + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "externallylinkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFeatureSelection1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "selectionType": { + "enum": [ + "excluded", + "included", + "implicitly-included" + ], + "example": "excluded", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/included/MyProjectId/MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "featureselections" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFeatureSelections1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "selectionType": { + "enum": [ + "excluded", + "included", + "implicitly-included" + ], + "example": "excluded", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/included/MyProjectId/MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "featureselections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFieldsMetadataForCollection1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFieldsMetadataForDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFieldsMetadataForPlan1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFieldsMetadataForTestRecord1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFieldsMetadataForTestRun1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getFieldsMetadataForWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalCustomFields1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "defaultValue": { + "type": "string" + }, + "dependsOn": { + "type": "string" + }, + "description": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parameters": { + "items": { + "properties": { + "key": { + "example": "parameter1", + "type": "string" + }, + "name": { + "example": "parameter1", + "type": "string" + }, + "title": { + "example": "MyParameter", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "required": { + "type": "boolean" + }, + "type": { + "properties": { + "kind": { + "example": "string", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + }, + "resourceType": { + "example": "id", + "type": "string" + }, + "targetType": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/workitems/epic", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalEnumeration1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumContext": { + "example": "id", + "type": "string" + }, + "enumName": { + "example": "id", + "type": "string" + }, + "options": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "targetType": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "~/status/~", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "enumerations" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalEnumerations1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "enumContext": { + "example": "id", + "type": "string" + }, + "enumName": { + "example": "id", + "type": "string" + }, + "options": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "targetType": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "~/status/~", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "enumerations" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalFieldsMetadata1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalIcon1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "iconUrl": { + "example": "pathexample", + "type": "string" + }, + "id": { + "example": "pathexample", + "type": "string" + }, + "path": { + "example": "pathexample", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalIcons1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "iconUrl": { + "example": "pathexample", + "type": "string" + }, + "id": { + "example": "pathexample", + "type": "string" + }, + "path": { + "example": "pathexample", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getGlobalPages1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "pageName": { + "example": "MyRichPageId", + "type": "string" + }, + "spaceId": { + "example": "MySpaceId", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getJob1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getJobs1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLicense1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "limits": { + "properties": { + "documentsAndPages": { + "properties": { + "currentCount": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + }, + "type": "object" + }, + "projects": { + "properties": { + "currentCount": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + }, + "type": "object" + }, + "workitems": { + "properties": { + "currentCount": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "license", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "defaultAddOnLicenseSlots": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "defaultBaseLicenseSlot": { + "properties": { + "data": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "license" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLicenseAssignments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "status": { + "enum": [ + "LOGGED_IN", + "EXPIRING", + "INACTIVE" + ], + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/assignments/MyUserId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "addOnSlots": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "baseSlot": { + "properties": { + "data": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "license_assignments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLicenseAssignmentsForUser1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "status": { + "enum": [ + "LOGGED_IN", + "EXPIRING", + "INACTIVE" + ], + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/assignments/MyUserId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "addOnSlots": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "baseSlot": { + "properties": { + "data": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "license_assignments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/assignments/MyUserId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLicenseSlot1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "configured": { + "format": "int32", + "type": "integer" + }, + "expirationDate": { + "format": "date", + "type": "string" + }, + "free": { + "format": "int32", + "type": "integer" + }, + "group": { + "example": "groupName", + "type": "string" + }, + "model": { + "example": "named", + "type": "string" + }, + "peak": { + "format": "int32", + "type": "integer" + }, + "total": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLicenseSlots1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "configured": { + "format": "int32", + "type": "integer" + }, + "expirationDate": { + "format": "date", + "type": "string" + }, + "free": { + "format": "int32", + "type": "integer" + }, + "group": { + "example": "groupName", + "type": "string" + }, + "model": { + "example": "named", + "type": "string" + }, + "peak": { + "format": "int32", + "type": "integer" + }, + "total": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLinkedWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "revision": { + "example": "1234", + "type": "string" + }, + "role": { + "example": "relates_to", + "type": "string" + }, + "suspect": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "sourceWorkItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLinkedWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "revision": { + "example": "1234", + "type": "string" + }, + "role": { + "example": "relates_to", + "type": "string" + }, + "suspect": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "sourceWorkItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItem": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getLlms1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "myLlm", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "myLlm", + "type": "string" + }, + "links": { + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "llms" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getMetadata1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "apiProperties": { + "properties": { + "bodySizeLimit": { + "example": 2097152, + "type": "integer" + }, + "defaultPageSize": { + "example": 100, + "type": "integer" + }, + "maxIncludedSize": { + "example": 500, + "type": "integer" + }, + "maxPageSize": { + "example": 200, + "type": "integer" + }, + "maxRelationshipSize": { + "example": 100, + "type": "integer" + } + }, + "type": "object" + }, + "build": { + "example": "20250613-1404-master-e594c717", + "type": "string" + }, + "cluster": { + "example": "cluster1", + "type": "string" + }, + "logoUrl": { + "example": "/images/logos/repo_login_logo.png", + "type": "string" + }, + "node": { + "example": "node2", + "type": "string" + }, + "timezone": { + "example": "+05:30", + "type": "string" + }, + "version": { + "example": "3.25.12", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "metadata", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/metadata", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "metadata" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/metadata", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getOslcResources1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "label": { + "example": "Label", + "type": "string" + }, + "role": { + "example": "http://open-services.net/ns/cm#relatedChangeRequest", + "type": "string" + }, + "uri": { + "example": "URI", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId", + "type": "string" + }, + "links": { + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedoslcresources" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPage1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "pageName": { + "example": "MyRichPageId", + "type": "string" + }, + "spaceId": { + "example": "MySpaceId", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPageAttachment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPageAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPageComment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPageComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPageRelationships1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "description": "The Relationship's response body. Can return a single or a list of instances", + "example": { + "data": [ + { + "id": "MyProjectId/WI-123", + "type": "workitems" + } + ] + }, + "oneOf": [ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" +}
- Changed
getPages1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "pageName": { + "example": "MyRichPageId", + "type": "string" + }, + "spaceId": { + "example": "MySpaceId", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPlan1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "allowedTypes": { + "items": { + "example": "optionId", + "type": "string" + }, + "type": "array" + }, + "calculationType": { + "enum": [ + "timeBased", + "customFieldBased" + ], + "example": "timeBased", + "type": "string" + }, + "capacity": { + "type": "number" + }, + "color": { + "example": "Color", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "defaultEstimate": { + "type": "number" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "dueDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "estimationField": { + "example": "Estimation Field", + "type": "string" + }, + "finishedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "ID", + "type": "string" + }, + "isTemplate": { + "type": "boolean" + }, + "name": { + "example": "Name", + "type": "string" + }, + "previousTimeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "prioritizationField": { + "example": "Prioritization Field", + "type": "string" + }, + "sortOrder": { + "example": 0, + "format": "int32", + "type": "integer" + }, + "startDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "startedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "useReportFromTemplate": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/plan?id=MyPlanId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectSpan": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "template": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getPlanRelationship1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "description": "The Relationship's response body. Can return a single or a list of instances", + "example": { + "data": [ + { + "id": "MyProjectId/WI-123", + "type": "workitems" + } + ] + }, + "oneOf": [ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" +}
- Changed
getPlans1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "allowedTypes": { + "items": { + "example": "optionId", + "type": "string" + }, + "type": "array" + }, + "calculationType": { + "enum": [ + "timeBased", + "customFieldBased" + ], + "example": "timeBased", + "type": "string" + }, + "capacity": { + "type": "number" + }, + "color": { + "example": "Color", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "defaultEstimate": { + "type": "number" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "dueDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "estimationField": { + "example": "Estimation Field", + "type": "string" + }, + "finishedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "ID", + "type": "string" + }, + "isTemplate": { + "type": "boolean" + }, + "name": { + "example": "Name", + "type": "string" + }, + "previousTimeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "prioritizationField": { + "example": "Prioritization Field", + "type": "string" + }, + "sortOrder": { + "example": 0, + "format": "int32", + "type": "integer" + }, + "startDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "startedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "useReportFromTemplate": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/plan?id=MyPlanId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectSpan": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "template": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/plans", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProject1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "active": { + "type": "boolean" + }, + "color": { + "example": "Color", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "finish": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "icon": { + "example": "Icon", + "type": "string" + }, + "id": { + "example": "MyProjectId", + "type": "string" + }, + "lockWorkRecordsDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + }, + "start": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "trackerPrefix": { + "example": "Tracker Prefix", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "lead": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectCustomFields1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fields": { + "items": { + "properties": { + "defaultValue": { + "type": "string" + }, + "dependsOn": { + "type": "string" + }, + "description": { + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "parameters": { + "items": { + "properties": { + "key": { + "example": "parameter1", + "type": "string" + }, + "name": { + "example": "parameter1", + "type": "string" + }, + "title": { + "example": "MyParameter", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "required": { + "type": "boolean" + }, + "type": { + "properties": { + "kind": { + "example": "string", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + }, + "resourceType": { + "example": "id", + "type": "string" + }, + "targetType": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/workitems/epic", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectEnumeration1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumContext": { + "example": "id", + "type": "string" + }, + "enumName": { + "example": "id", + "type": "string" + }, + "options": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "targetType": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "~/status/~", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "enumerations" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectEnumerations1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "enumContext": { + "example": "id", + "type": "string" + }, + "enumName": { + "example": "id", + "type": "string" + }, + "options": { + "items": { + "properties": { + "color": { + "example": "#F9FF4D", + "type": "string" + }, + "columnWidth": { + "example": "90%", + "type": "string" + }, + "createDefect": { + "example": true, + "type": "boolean" + }, + "default": { + "example": true, + "type": "boolean" + }, + "description": { + "example": "Description", + "type": "string" + }, + "hidden": { + "example": false, + "type": "boolean" + }, + "iconURL": { + "example": "/polarion/icons/default/enums/status_open.gif", + "type": "string" + }, + "id": { + "example": "open", + "type": "string" + }, + "limited": { + "example": true, + "type": "boolean" + }, + "linkRules": { + "items": { + "properties": { + "fromTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "example": false, + "type": "boolean" + }, + "toTypes": { + "example": [ + "requirement" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" + }, + "minValue": { + "example": 30, + "type": "number" + }, + "name": { + "example": "Open", + "type": "string" + }, + "oppositeName": { + "example": "Opposite Name", + "type": "string" + }, + "parent": { + "example": true, + "type": "boolean" + }, + "requiresSignatureForTestCaseExecution": { + "example": true, + "type": "boolean" + }, + "templateWorkItem": { + "example": "exampleTemplate", + "type": "string" + }, + "terminal": { + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "targetType": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "~/status/~", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "enumerations" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectFieldsMetadata1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "enumField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "enumContext": { + "example": "enum-context", + "type": "string" + }, + "enumName": { + "example": "enum-name", + "type": "string" + }, + "kind": { + "example": "enumeration", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "listField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "itemType": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean", + "structure", + "relationship" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "kind": { + "example": "list", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "primitiveField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "properties": { + "enum": { + "items": { + "enum": [ + "string", + "text", + "text/html", + "integer", + "float", + "currency", + "time", + "date", + "date-time", + "boolean" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "structField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "structure", + "type": "string" + }, + "structureName": { + "example": "structureId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "relationshipField": { + "properties": { + "label": { + "example": "field-label", + "type": "string" + }, + "type": { + "properties": { + "kind": { + "example": "relationship", + "type": "string" + }, + "multi": { + "example": true, + "type": "boolean" + }, + "targetResourceTypes": { + "items": { + "example": "resource-type", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "links": { + "properties": { + "self": { + "example": "https://example.com/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectIcon1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "iconUrl": { + "example": "pathexample", + "type": "string" + }, + "id": { + "example": "pathexample", + "type": "string" + }, + "path": { + "example": "pathexample", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectIcons1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "iconUrl": { + "example": "pathexample", + "type": "string" + }, + "id": { + "example": "pathexample", + "type": "string" + }, + "path": { + "example": "pathexample", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjects1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "active": { + "type": "boolean" + }, + "color": { + "example": "Color", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "finish": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "icon": { + "example": "Icon", + "type": "string" + }, + "id": { + "example": "MyProjectId", + "type": "string" + }, + "lockWorkRecordsDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + }, + "start": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "trackerPrefix": { + "example": "Tracker Prefix", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "lead": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectTemplates1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "customIcon": { + "type": "string" + }, + "description": { + "type": "string" + }, + "distributions": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "MyProjectId", + "type": "string" + }, + "isDefault": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "parameters": { + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projecttemplates/MyProjectId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projecttemplates" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectTestParameterDefinition1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Test Parameter Definition example", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getProjectTestParameterDefinitions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Test Parameter Definition example", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getRepositorySpacePages1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "pageName": { + "example": "MyRichPageId", + "type": "string" + }, + "spaceId": { + "example": "MySpaceId", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getRevision1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "type": "string" + }, + "internalCommit": { + "type": "boolean" + }, + "message": { + "example": "Message", + "type": "string" + }, + "repositoryName": { + "example": "Repository name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/1234", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/revisions/default/1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "revisions" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/revisions/default/1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getRevisions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "type": "string" + }, + "internalCommit": { + "type": "boolean" + }, + "message": { + "example": "Message", + "type": "string" + }, + "repositoryName": { + "example": "Repository name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "default/1234", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/revisions/default/1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "revisions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getRole1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "id": { + "example": "MyRoleId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/roles/MyRoleId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "users": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "globalroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/roles/MyRoleId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getSpaceDocuments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "autoSuspect": { + "type": "boolean" + }, + "branchedWithInitializedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "branchedWithQuery": { + "example": "Branched with Query", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "derivedFields": { + "items": { + "example": "fieldId", + "type": "string" + }, + "type": "array" + }, + "derivedFromLinkRole": { + "example": "relates_to", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "moduleFolder": { + "example": "MySpaceId", + "type": "string" + }, + "moduleName": { + "example": "MyDocumentId", + "type": "string" + }, + "outlineNumbering": { + "properties": { + "prefix": { + "example": "ABC", + "type": "string" + } + }, + "type": "object" + }, + "renderingLayouts": { + "items": { + "properties": { + "label": { + "example": "My label", + "type": "string" + }, + "layouter": { + "example": "paragraph", + "type": "string" + }, + "properties": { + "items": { + "properties": { + "key": { + "example": "fieldsAtStart", + "type": "string" + }, + "value": { + "example": "id", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "example": "draft", + "type": "string" + }, + "structureLinkRole": { + "example": "relates_to", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "req_specification", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "usesOutlineNumbering": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "branchedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "derivedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "variant": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getSpacePages1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "pageName": { + "example": "MyRichPageId", + "type": "string" + }, + "spaceId": { + "example": "MySpaceId", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "updatedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRecord1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "comment": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "duration": { + "type": "number" + }, + "executed": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "iteration": { + "example": 0, + "format": "int32", + "type": "integer" + }, + "result": { + "example": "passed", + "type": "string" + }, + "testCaseRevision": { + "example": "Test Case Revision", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "defect": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "executedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testCase": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRecordAttachment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId/content", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrecord_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRecordAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId/content", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrecord_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRecords1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "comment": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "duration": { + "type": "number" + }, + "executed": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "iteration": { + "example": 0, + "format": "int32", + "type": "integer" + }, + "result": { + "example": "passed", + "type": "string" + }, + "testCaseRevision": { + "example": "Test Case Revision", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "defect": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "executedBy": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testCase": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRecordTestParameter1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Example Test Parameter value", + "type": "string" + }, + "value": { + "example": "Example Test Parameter value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyTestParameter", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "definition": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameters" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRecordTestParameters1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Example Test Parameter value", + "type": "string" + }, + "value": { + "example": "Example Test Parameter value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyTestParameter", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "definition": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameters" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRun1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "finishedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "groupId": { + "example": "Group ID", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "ID", + "type": "string" + }, + "idPrefix": { + "example": "MyTestRunIdPrefix", + "type": "string" + }, + "isTemplate": { + "type": "boolean" + }, + "keepInHistory": { + "type": "boolean" + }, + "query": { + "example": "Query", + "type": "string" + }, + "selectTestCasesBy": { + "enum": [ + "manualSelection", + "staticQueryResult", + "dynamicQueryResult", + "staticLiveDoc", + "dynamicLiveDoc", + "automatedProcess" + ], + "example": "manualSelection", + "type": "string" + }, + "status": { + "example": "open", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "manual", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "useReportFromTemplate": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectSpan": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "summaryDefect": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "template": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunAttachment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunComment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "example": "Title", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "example": "MyCommentId", + "type": "string" + }, + "resolved": { + "type": "boolean" + }, + "text": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "title": { + "example": "Title", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "childComments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parentComment": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRuns1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "finishedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "groupId": { + "example": "Group ID", + "type": "string" + }, + "homePageContent": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "ID", + "type": "string" + }, + "idPrefix": { + "example": "MyTestRunIdPrefix", + "type": "string" + }, + "isTemplate": { + "type": "boolean" + }, + "keepInHistory": { + "type": "boolean" + }, + "query": { + "example": "Query", + "type": "string" + }, + "selectTestCasesBy": { + "enum": [ + "manualSelection", + "staticQueryResult", + "dynamicQueryResult", + "staticLiveDoc", + "dynamicLiveDoc", + "automatedProcess" + ], + "example": "manualSelection", + "type": "string" + }, + "status": { + "example": "open", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "manual", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "useReportFromTemplate": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectSpan": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "summaryDefect": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "template": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/testruns", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunTestParameter1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Example Test Parameter value", + "type": "string" + }, + "value": { + "example": "Example Test Parameter value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyTestParameter", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "definition": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameters" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunTestParameterDefinition1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Test Parameter Definition example", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunTestParameterDefinitions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Test Parameter Definition example", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestRunTestParameters1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Example Test Parameter value", + "type": "string" + }, + "value": { + "example": "Example Test Parameter value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyTestParameter", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "definition": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameters" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestStep1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "index": { + "type": "string" + }, + "keys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "values": { + "items": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestStepResult1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "comment": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "result": { + "example": "passed", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "testStep": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststep_results" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestStepResultAttachment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststepresult_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestStepResultAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststepresult_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestStepResults1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "comment": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "result": { + "example": "passed", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "testStep": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststep_results" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getTestSteps1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "index": { + "type": "string" + }, + "keys": { + "items": { + "type": "string" + }, + "type": "array" + }, + "values": { + "items": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getUser1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "avatarUrl": { + "example": "http://server-host-name/application-path/icons/avatar/MyUserId/avatar.png?revision=1234", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "disabledNotifications": { + "type": "boolean" + }, + "email": { + "example": "Email", + "type": "string" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "initials": { + "example": "Initials", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/users/MyUserId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "addOnLicenseSlots": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "baseLicenseSlot": { + "properties": { + "data": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "globalRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "globalroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "projectroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "userGroups": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserGroupId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "usergroups" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/users/MyUserId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getUserGroup1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserGroupId", + "type": "string" + }, + "ldapSearchFilter": { + "example": "LDAP Search Filter", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + }, + "ssoSynchronizationAllowed": { + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserGroupId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/usergroups/MyUserGroupId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "globalRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "globalroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "projectroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "users": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "usergroups" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/usergroups/MyUserGroupId", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getUsers1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "avatarUrl": { + "example": "http://server-host-name/application-path/icons/avatar/MyUserId/avatar.png?revision=1234", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "disabledNotifications": { + "type": "boolean" + }, + "email": { + "example": "Email", + "type": "string" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "initials": { + "example": "Initials", + "type": "string" + }, + "name": { + "example": "Name", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/users/MyUserId", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "addOnLicenseSlots": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "baseLicenseSlot": { + "properties": { + "data": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "globalRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "globalroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "projectRoles": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyRoleId", + "type": "string" + }, + "type": { + "enum": [ + "projectroles" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "userGroups": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserGroupId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "usergroups" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkflowActionsForTestRun1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "available": { + "type": "boolean" + }, + "clearedFields": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "0", + "type": "string" + }, + "isAddingSignature": { + "type": "boolean" + }, + "isSignatureRequired": { + "type": "boolean" + }, + "name": { + "example": "actionName", + "type": "string" + }, + "nativeActionId": { + "example": "nativeActionId", + "type": "string" + }, + "requiredFields": { + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredRoles": { + "items": { + "type": "string" + }, + "type": "array" + }, + "targetStatus": { + "example": "done", + "type": "string" + }, + "unavailableReason": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkflowActionsForWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "available": { + "type": "boolean" + }, + "clearedFields": { + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "example": "0", + "type": "string" + }, + "isAddingSignature": { + "type": "boolean" + }, + "isSignatureRequired": { + "type": "boolean" + }, + "name": { + "example": "actionName", + "type": "string" + }, + "nativeActionId": { + "example": "nativeActionId", + "type": "string" + }, + "requiredFields": { + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredRoles": { + "items": { + "type": "string" + }, + "type": "array" + }, + "targetStatus": { + "example": "done", + "type": "string" + }, + "unavailableReason": { + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItem1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "dueDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "hyperlinks": { + "items": { + "properties": { + "role": { + "example": "ref_ext", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "uri": { + "example": "https://polarion.plm.automation.siemens.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "example": "MyWorkItemId", + "type": "string" + }, + "initialEstimate": { + "example": "5 1/2d", + "type": "string" + }, + "outlineNumber": { + "example": "1.11", + "type": "string" + }, + "plannedEnd": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "plannedStart": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "example": "90.0", + "type": "string" + }, + "remainingEstimate": { + "example": "5 1/2d", + "type": "string" + }, + "resolution": { + "example": "done", + "type": "string" + }, + "resolvedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "severity": { + "example": "blocker", + "type": "string" + }, + "status": { + "example": "open", + "type": "string" + }, + "timeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "task", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "approvals": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_approvals" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "assignee": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "backlinkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "categories": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCategoryId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "categories" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "externallyLinkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "externallylinkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedOslcResources": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedoslcresources" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedRevisions": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "default/1234", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "revisions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "module": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "plannedIn": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testSteps": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "votes": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workRecords": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyWorkRecordId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItemApproval1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "status": { + "enum": [ + "waiting", + "approved", + "disapproved" + ], + "example": "waiting", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "user": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_approvals" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItemApprovals1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "status": { + "enum": [ + "waiting", + "approved", + "disapproved" + ], + "example": "waiting", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "user": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_approvals" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItemAttachment1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItemAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "fileName": { + "example": "File Name", + "type": "string" + }, + "id": { + "example": "MyAttachmentId", + "type": "string" + }, + "length": { + "format": "int32", + "type": "integer" + }, + "title": { + "example": "Title", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "dueDate": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "hyperlinks": { + "items": { + "properties": { + "role": { + "example": "ref_ext", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "uri": { + "example": "https://polarion.plm.automation.siemens.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "id": { + "example": "MyWorkItemId", + "type": "string" + }, + "initialEstimate": { + "example": "5 1/2d", + "type": "string" + }, + "outlineNumber": { + "example": "1.11", + "type": "string" + }, + "plannedEnd": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "plannedStart": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "priority": { + "example": "90.0", + "type": "string" + }, + "remainingEstimate": { + "example": "5 1/2d", + "type": "string" + }, + "resolution": { + "example": "done", + "type": "string" + }, + "resolvedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "severity": { + "example": "blocker", + "type": "string" + }, + "status": { + "example": "open", + "type": "string" + }, + "timeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "title": { + "example": "Title", + "type": "string" + }, + "type": { + "example": "task", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "approvals": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_approvals" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "assignee": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "attachments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyAttachmentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "backlinkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "categories": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCategoryId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "categories" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "comments": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "externallyLinkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "externallylinkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedOslcResources": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedoslcresources" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedRevisions": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "default/1234", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "revisions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "linkedWorkItems": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "related": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "module": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "plannedIn": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "testSteps": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "votes": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "workRecords": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyWorkRecordId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitems", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItemsRelationships1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "description": "The Relationship's response body. Can return a single or a list of instances", + "example": { + "data": [ + { + "id": "MyProjectId/WI-123", + "type": "workitems" + } + ] + }, + "oneOf": [ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" +}
- Changed
getWorkItemTestParameterDefinition1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Test Parameter Definition example", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkItemTestParameterDefinitions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "name": { + "example": "Test Parameter Definition example", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkRecord1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "comment": { + "example": "Comment", + "type": "string" + }, + "date": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "id": { + "type": "string" + }, + "timeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyWorkRecordId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
getWorkRecords1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "attributes": { + "properties": { + "comment": { + "example": "Comment", + "type": "string" + }, + "date": { + "example": "1970-01-01", + "format": "date", + "type": "string" + }, + "id": { + "type": "string" + }, + "timeSpent": { + "example": "5 1/2d", + "type": "string" + }, + "type": { + "example": "task", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyWorkItemId/MyWorkRecordId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "errors": { + "items": { + "properties": { + "detail": { + "description": "Human-readable explanation specific to this occurrence of the problem.", + "example": "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)", + "type": "string" + }, + "source": { + "properties": { + "parameter": { + "description": "String indicating which URI query parameter caused the error.", + "example": "revision", + "type": "string" + }, + "pointer": { + "description": "JSON Pointer to the associated entity in the request document.", + "example": "$.data", + "type": "string" + }, + "resource": { + "description": "Resource causing the error.", + "properties": { + "id": { + "example": "MyProjectId/id", + "type": "string" + }, + "type": { + "example": "type", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "status": { + "description": "HTTP status code applicable to this problem.", + "example": "400", + "type": "string" + }, + "title": { + "description": "Short, human-readable summary of the problem.", + "example": "Bad Request", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "user": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "workrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "included": { + "description": "Related entities might be returned, see <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a>.", + "items": { + "type": "object" + }, + "type": "array" + }, + "links": { + "properties": { + "first": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=1", + "type": "string" + }, + "last": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=9", + "type": "string" + }, + "next": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=6", + "type": "string" + }, + "prev": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=4", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=5", + "type": "string" + } + }, + "type": "object" + }, + "meta": { + "properties": { + "totalCount": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
importExcelTestResults1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
importWordDocument1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
importXUnitTestResults1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
markProject1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
mergeDocumentFromMaster1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
mergeDocumentToMaster1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
moveProjectAction1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
overwriteDocumentParts1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "overwrittenParts": { + "description": "Array of Part ID mappings showing old and new IDs.", + "items": { + "properties": { + "newPartId": { + "description": "New Part ID after overwrite operation.", + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "oldPartId": { + "description": "Original Part ID before overwrite operation.", + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
postBacklinkedWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postCollections1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "workitem_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postDocumentComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "document_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postDocumentItemAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "document_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postDocumentParts1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "document_parts" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postDocuments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postExternallyLinkedWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "externallylinkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postGlobalCustomFields1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/workitems/epic", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postGlobalEnumeration1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "~/status/~", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "enumerations" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postGlobalIcons1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postLicenseSlots1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "LicenseType/ModelType/GroupId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "license_slots" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postLinkedWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "linkedworkitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postOslcResources1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId", + "type": "string" + }, + "links": { + "type": "object" + }, + "type": { + "enum": [ + "linkedoslcresources" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postPageAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "page_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postPageComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "page_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postPages1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postPlans1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyPlanId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/plan?id=MyPlanId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "plans" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postProjectCustomFields1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/workitems/epic", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postProjectEnumeration1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "~/status/~", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/%7E/status/%7E", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "enumerations" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postProjectIcons1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "default/example.gif", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/enumerations/defaulticons/example.gif", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "icons" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postProjectTestParameterDefinitions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRecordAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId/content", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testrecord_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRecords1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRecordTestParameters1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyTestParameter", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testparameters" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRunAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testrun_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRunComments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyCommentId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testrun_comments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRunParameterDefinitions1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestParamDefinition", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testparameter_definitions" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRuns1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestRunTestParameters1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyTestParameter", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "testparameters" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestStepResultAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "teststepresult_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestStepResults1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "teststep_results" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postTestSteps1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyTestStepIndex", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "teststeps" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postUsers1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/users/MyUserId", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postWorkItemApprovals1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyUserId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "workitem_approvals" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postWorkItemAttachments1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyAttachmentId", + "type": "string" + }, + "links": { + "properties": { + "content": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId/content?revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "workitem_attachments" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postWorkItems1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "workitems" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
postWorkRecords1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyWorkItemId/MyWorkRecordId", + "type": "string" + }, + "links": { + "properties": { + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "workrecords" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" +}
- Changed
reuseCollection1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "closedOn": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "description": { + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "example": "My text value", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "example": "Name", + "type": "string" + }, + "updated": { + "example": "1970-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "links": { + "properties": { + "portal": { + "example": "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "author": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyUserId", + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "downstreamCollections": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "reusedFrom": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "richPages": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyRichPageId", + "type": "string" + }, + "type": { + "enum": [ + "pages" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "testRuns": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyTestRunId", + "type": "string" + }, + "type": { + "enum": [ + "testruns" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "upstreamCollections": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MyCollectionId", + "type": "string" + }, + "revision": { + "example": "1234", + "type": "string" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "collections" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
unmarkProject1 field changed- changed
Output schema / (root)Previous value: -nullNew value: +{ + "properties": { + "data": { + "properties": { + "attributes": { + "properties": { + "jobId": { + "example": "example", + "type": "string" + }, + "name": { + "example": "example", + "type": "string" + }, + "state": { + "example": "example", + "type": "string" + }, + "status": { + "properties": { + "message": { + "example": "message", + "type": "string" + }, + "type": { + "enum": [ + "OK", + "CANCELLED", + "FAILED", + "UNKNOWN" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "id": { + "example": "MyJobId", + "type": "string" + }, + "links": { + "properties": { + "downloads": { + "example": [ + "https://example.com/polarion/download/filename1", + "https://example.com/polarion/download/filename2" + ], + "items": { + "type": "string" + }, + "type": "array" + }, + "log": { + "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId", + "type": "string" + }, + "self": { + "example": "server-host-name/application-path/jobs/MyJobId", + "type": "string" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "document": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "documents": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyProjectId/MySpaceId/MyDocumentId", + "type": "string" + }, + "type": { + "enum": [ + "documents" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "project": { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyProjectId", + "type": "string" + }, + "type": { + "enum": [ + "projects" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": { + "enum": [ + "jobs" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" +}
278 tool updates
- Changed
branchDocument1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
branchDocuments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
closeCollection - Changed
copyDocument1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
createProject2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / properties / params / descriptionPrevious value: -"params of new Project to be created."New value: +"Parameters of new Project to be created."
- Changed
deleteAllWorkItems1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteApproval1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteApprovals1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
deleteCollection - Added
deleteCollections - Added
deleteCollectionsRelationship - Added
deleteDocumentParts - Changed
deleteExternallyLinkedWorkItem1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteExternallyLinkedWorkItems1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
deleteGlobalCustomFields - Changed
deleteGlobalEnumeration1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
deleteLicenseSlots - Changed
deleteLinkedWorkItem1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteLinkedWorkItems1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteOslcResources1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
deletePage - Added
deletePageAttachment - Added
deletePageRelationships - Changed
deletePlan1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deletePlanRelationship2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / properties / data / items / properties / type / enumPrevious value: -[ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" -]New value: +[ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" +]
- Changed
deletePlans1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteProject1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
deleteProjectCustomFields - Changed
deleteProjectEnumeration1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteProjectTestParameterDefinition1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteProjectTestParameterDefinitions1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRecord1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRecordAttachment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRecordAttachments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRecordTestParameter1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRun1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRunAttachment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRunAttachments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRuns1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRunTestParameter1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRunTestParameterDefinition1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestRunTestParameters1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestStep1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestStepResultAttachment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestStepResultAttachments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteTestSteps1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteWorkItemAttachment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteWorkItems1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteWorkItemsRelationship2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / properties / data / items / properties / type / enumPrevious value: -[ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" -]New value: +[ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" +]
- Changed
deleteWorkRecord1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
deleteWorkRecords1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
executeJob - Removed
exportExcelTests - Added
generateCompletion - Removed
get_sdk_documentation - Added
getAllDocuments - Added
getAllPages - Changed
getAllWorkItems6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getAvailableEnumOptionsForDocument4 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getAvailableEnumOptionsForDocumentType5 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - changed
Input schema / properties / type / descriptionPrevious value: -"The Type of the object."New value: +"The Type of the object. Use '~' without quotes to represent no target Type."
- Changed
getAvailableEnumOptionsForWorkItem4 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getAvailableEnumOptionsForWorkItemType5 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - changed
Input schema / properties / type / descriptionPrevious value: -"The Type of the object."New value: +"The Type of the object. Use '~' without quotes to represent no target Type."
- Added
getBacklinkedWorkItems - Added
getCollection - Added
getCollections - Added
getCollectionsRelationship - Changed
getComment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getComments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getCurrentEnumerationOptionsForDocument4 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getCurrentEnumOptionsForWorkItem4 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Added
getCurrentUser - Changed
getDefaultIcon1 field changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getDefaultIcons5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getDocument2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getDocumentAttachment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getDocumentAttachments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getDocumentComment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getDocumentComments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getDocumentPart2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getDocumentParts6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Added
getDocuments - Changed
getExternallyLinkedWorkItem2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getExternallyLinkedWorkItems6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getFeatureSelection2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getFeatureSelections6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Added
getFieldsMetadataForCollection - Added
getFieldsMetadataForDocument - Added
getFieldsMetadataForPlan - Added
getFieldsMetadataForTestRecord - Added
getFieldsMetadataForTestRun - Added
getFieldsMetadataForWorkItem - Added
getGlobalCustomFields - Changed
getGlobalEnumeration2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Added
getGlobalEnumerations - Added
getGlobalFieldsMetadata - Changed
getGlobalIcon1 field changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getGlobalIcons5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Added
getGlobalPages - Changed
getJob2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Added
getJobLogContent - Added
getJobs - Added
getLicense - Added
getLicenseAssignments - Added
getLicenseAssignmentsForUser - Added
getLicenseSlot - Added
getLicenseSlots - Changed
getLinkedWorkItem2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getLinkedWorkItems6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Added
getLlms - Added
getMetadata - Changed
getOslcResources6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getPage2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getPageAttachment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Added
getPageAttachments - Added
getPageComment - Added
getPageComments - Added
getPageRelationships - Added
getPages - Changed
getPlan2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getPlanRelationship6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getPlans6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getProject2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Added
getProjectCustomFields - Changed
getProjectEnumeration2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Added
getProjectEnumerations - Added
getProjectFieldsMetadata - Changed
getProjectIcon1 field changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getProjectIcons5 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getProjects6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getProjectTemplates6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getProjectTestParameterDefinition2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getProjectTestParameterDefinitions6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Added
getRepositorySpacePages - Changed
getRevision2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getRevisions6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getRole2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Added
getSpaceDocuments - Added
getSpacePages - Changed
getTestRecord2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRecordAttachment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRecordAttachments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRecords6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRecordTestParameter2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRecordTestParameters6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRun2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRunAttachment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRunAttachments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRunComment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRunComments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRuns6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRunTestParameter2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRunTestParameterDefinition2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestRunTestParameterDefinitions6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestRunTestParameters6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestStep2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestStepResult2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestStepResultAttachment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getTestStepResultAttachments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestStepResults6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getTestSteps6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getUser2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getUserGroup2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getUsers6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkflowActionsForTestRun4 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkflowActionsForWorkItem4 fields changed- removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkItem2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getWorkItemApproval2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getWorkItemApprovals6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkItemAttachment2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getWorkItemAttachments6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkItems6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkItemsRelationships6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkItemTestParameterDefinition2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getWorkItemTestParameterDefinitions6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
getWorkRecord2 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."
- Changed
getWorkRecords6 fields changed- changed
Input schema / properties / fields / descriptionPrevious value: -"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Filter returned resource fields. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - changed
Input schema / properties / include / descriptionPrevious value: -"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details."New value: +"Include related entities. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details." - removed
Input schema / properties / page_numberRemoved value: -{ - "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_number_Added value: +{ + "description": "Specify the page number to be returned. Counting starts from 1. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +} - removed
Input schema / properties / page_sizeRemoved value: -{ - "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20231017526942799.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", - "format": "int32", - "type": "number" -} - added
Input schema / properties / page_size_Added value: +{ + "description": "Limit the number of entities returned in a single response. See <a href=\"https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871\" target=\"_blank\">REST API User Guide</a> for details.", + "format": "int32", + "type": "number" +}
- Changed
importExcelTestResults1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
importWordDocument - Changed
importXUnitTestResults1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
markProject2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / properties / params / descriptionPrevious value: -"params of new Project to be created."New value: +"Parameters of new Project to be created."
- Changed
mergeDocumentFromMaster1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
mergeDocumentToMaster1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
moveDocumentParts - Changed
moveFromDocument1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
moveProjectAction1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
moveToDocument1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
moveWorkItemsToDocument - Added
overwriteDocumentParts - Changed
patchAllWorkItems2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / hyperlinks / items / properties / titleAdded value: +{ + "type": "string" +}
- Added
patchCollections - Added
patchCollectionsRelationships - Changed
patchComment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
patchCustomField - Changed
patchDocument1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchDocumentAttachment2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
patchDocumentComment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
patchGlobalCustomFields - Changed
patchGlobalEnumeration3 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / properties / attributes / properties / options / items / properties / limitedAdded value: +{ + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / properties / attributes / properties / options / items / properties / linkRulesAdded value: +{ + "items": { + "properties": { + "fromTypes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "type": "boolean" + }, + "toTypes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" +}
- Added
patchLicense - Added
patchLicenseAssignment - Added
patchLicenseAssignments - Changed
patchLinkedWorkItem1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
patchPageAttachment - Added
patchPageComment - Added
patchPageRelationships - Changed
patchPlan1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchPlanRelationships2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / oneOfPrevious value: -[ - { - "properties": { - "data": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - { - "properties": { - "data": { - "items": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
patchProject1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchProjectEnumeration3 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / properties / attributes / properties / options / items / properties / limitedAdded value: +{ + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / properties / attributes / properties / options / items / properties / linkRulesAdded value: +{ + "items": { + "properties": { + "fromTypes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "type": "boolean" + }, + "toTypes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" +}
- Changed
patchRichPage3 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / properties / attributes / properties / homePageContentAdded value: +{ + "properties": { + "type": { + "enum": [ + "text/html", + "text/plain" + ], + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" +} - added
Input schema / properties / requestBody / properties / data / properties / relationshipsAdded value: +{ + "properties": { + "watches": { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "type": "string" + }, + "type": { + "enum": [ + "users" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" +}
- Changed
patchTestRecord1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestRecordAttachment2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
patchTestRecords1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestRun1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestRunAttachment2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
patchTestRunComment1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestRunComments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestRuns1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestStep1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestStepResult1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestStepResultAttachment2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
patchTestStepResults1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchTestSteps1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchUser1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchWorkItem2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / properties / attributes / properties / hyperlinks / items / properties / titleAdded value: +{ + "type": "string" +}
- Changed
patchWorkItemApproval1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchWorkItemApprovals1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
patchWorkItemAttachment2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
patchWorkItemRelationships2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / oneOfPrevious value: -[ - { - "properties": { - "data": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - { - "properties": { - "data": { - "items": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
patchWorkItems2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / hyperlinks / items / properties / titleAdded value: +{ + "type": "string" +}
- Added
postBacklinkedWorkItems - Added
postCollections - Added
postCollectionsRelationships - Changed
postComments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postDocumentComments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postDocumentItemAttachments2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
postDocumentParts9 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / contentAdded value: +{ + "description": "Editable only for normal and table document parts.", + "type": "string" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / headingTextAdded value: +{ + "description": "Applicable to: heading parts.", + "type": "string" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / landscapeAdded value: +{ + "description": "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / layoutAdded value: +{ + "description": "Rendering layout index for the part. Applicable to: workitem parts.", + "format": "int32", + "type": "number" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / level / descriptionAdded value: +"Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts." - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / sequenceAdded value: +{ + "description": "Sequence identifier for table of figures entry. Applicable to: tof parts.", + "type": "string" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / type / descriptionAdded value: +"Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation." - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / wikiTextAdded value: +{ + "description": "Wiki markup content for the block. Applicable to: wikiblock parts.", + "type": "string" +}
- Changed
postDocuments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postExternallyLinkedWorkItems1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
postGlobalCustomFields - Changed
postGlobalEnumeration3 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / options / items / properties / limitedAdded value: +{ + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / options / items / properties / linkRulesAdded value: +{ + "items": { + "properties": { + "fromTypes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "type": "boolean" + }, + "toTypes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" +}
- Changed
postGlobalIcons1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
postLicenseSlots - Changed
postLinkedWorkItems1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postOslcResources1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postPageAttachments2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Added
postPageComments - Added
postPageRelationships - Added
postPages - Changed
postPlanRelationships2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / oneOfPrevious value: -[ - { - "properties": { - "data": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - { - "properties": { - "data": { - "items": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
postPlans1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Added
postProjectCustomFields - Changed
postProjectEnumeration3 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / options / items / properties / limitedAdded value: +{ + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / options / items / properties / linkRulesAdded value: +{ + "items": { + "properties": { + "fromTypes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "sameType": { + "type": "boolean" + }, + "toTypes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "type": "array" +}
- Changed
postProjectIcons1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postProjectTestParameterDefinitions1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestRecordAttachments2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
postTestRecords1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestRecordTestParameters1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestRunAttachments2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
postTestRunComments1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestRunParameterDefinitions1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestRuns1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestRunTestParameters1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestStepResultAttachments2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
postTestStepResults1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postTestSteps1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postUsers1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postWorkItemApprovals1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
postWorkItemAttachments2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / descriptionPrevious value: -"Attachment meta data and file data."New value: +"Attachment metadata and file data."
- Changed
postWorkItemRelationships2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / oneOfPrevious value: -[ - { - "properties": { - "data": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, - { - "properties": { - "data": { - "items": { - "properties": { - "id": { - "example": "MyProjectId/MyResourceId", - "type": "string" - }, - "type": { - "enum": [ - "categories", - "documents", - "document_attachments", - "document_comments", - "document_parts", - "enumerations", - "globalroles", - "icons", - "jobs", - "linkedworkitems", - "externallylinkedworkitems", - "linkedoslcresources", - "pages", - "page_attachments", - "plans", - "projectroles", - "projectgroups", - "projects", - "projecttemplates", - "spaces", - "testparameters", - "testparameter_definitions", - "testrecords", - "teststep_results", - "testruns", - "testrun_attachments", - "teststepresult_attachments", - "testrun_comments", - "usergroups", - "users", - "workitems", - "workitem_attachments", - "workitem_approvals", - "workitem_comments", - "featureselections", - "teststeps", - "workrecords", - "revisions", - "testrecord_attachments" - ], - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - } -]New value: +[ + { + "properties": { + "data": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + { + "properties": { + "data": { + "items": { + "properties": { + "id": { + "example": "MyResourceId", + "type": "string" + }, + "type": { + "enum": [ + "collections", + "categories", + "documents", + "document_attachments", + "document_comments", + "document_parts", + "enumerations", + "globalroles", + "icons", + "jobs", + "linkedworkitems", + "externallylinkedworkitems", + "linkedoslcresources", + "llms", + "pages", + "page_attachments", + "page_comments", + "plans", + "projectroles", + "projectgroups", + "projects", + "projecttemplates", + "spaces", + "testparameters", + "testparameter_definitions", + "testrecords", + "teststep_results", + "testruns", + "testrun_attachments", + "teststepresult_attachments", + "testrun_comments", + "usergroups", + "users", + "workitems", + "workitem_attachments", + "workitem_approvals", + "workitem_comments", + "featureselections", + "teststeps", + "workrecords", + "revisions", + "testrecord_attachments", + "license_slots", + "license_types", + "license", + "metadata", + "license_assignments", + "customfields" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } +]
- Changed
postWorkItems2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - added
Input schema / properties / requestBody / properties / data / items / properties / attributes / properties / hyperlinks / items / properties / titleAdded value: +{ + "type": "string" +}
- Changed
postWorkRecords1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Removed
refresh_polarion_config - Added
reopenCollection - Added
reuseCollection - Changed
setLicense2 fields changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +} - changed
Input schema / properties / requestBody / properties / license / enumPrevious value: -[ - "REVIEWER", - "XBase", - "XPro", - "XEnterprise", - "PRO", - "REQUIREMENTS", - "QA", - "ALM" -]New value: +[ + "REVIEWER", + "XReviewer", + "XBase", + "XEssentials", + "XPro", + "XStandard", + "XEnterprise", + "XAdvanced", + "XExtended", + "XPremium", + "XAutomotive", + "PRO", + "REQUIREMENTS", + "QA", + "ALM" +]
- Changed
unmarkProject1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
- Changed
updateAvatar1 field changed- added
Input schema / properties / dry_runAdded value: +{ + "description": "If true, validate and return the request that would be sent without calling Polarion.", + "type": "boolean" +}
211 tool updates
v1.0.0- First observed
branchDocument - First observed
branchDocuments - First observed
copyDocument - First observed
createProject - First observed
deleteAllWorkItems - First observed
deleteApproval - First observed
deleteApprovals - First observed
deleteExternallyLinkedWorkItem - First observed
deleteExternallyLinkedWorkItems - First observed
deleteGlobalEnumeration - First observed
deleteLinkedWorkItem - First observed
deleteLinkedWorkItems - First observed
deleteOslcResources - First observed
deletePlan - First observed
deletePlanRelationship - First observed
deletePlans - First observed
deleteProject - First observed
deleteProjectEnumeration - First observed
deleteProjectTestParameterDefinition - First observed
deleteProjectTestParameterDefinitions - First observed
deleteTestRecord - First observed
deleteTestRecordAttachment - First observed
deleteTestRecordAttachments - First observed
deleteTestRecordTestParameter - First observed
deleteTestRun - First observed
deleteTestRunAttachment - First observed
deleteTestRunAttachments - First observed
deleteTestRuns - First observed
deleteTestRunTestParameter - First observed
deleteTestRunTestParameterDefinition - First observed
deleteTestRunTestParameters - First observed
deleteTestStep - First observed
deleteTestStepResultAttachment - First observed
deleteTestStepResultAttachments - First observed
deleteTestSteps - First observed
deleteWorkItemAttachment - First observed
deleteWorkItems - First observed
deleteWorkItemsRelationship - First observed
deleteWorkRecord - First observed
deleteWorkRecords - First observed
exportExcelTests - First observed
get_sdk_documentation - First observed
getAllWorkItems - First observed
getAvailableEnumOptionsForDocument - First observed
getAvailableEnumOptionsForDocumentType - First observed
getAvailableEnumOptionsForWorkItem - First observed
getAvailableEnumOptionsForWorkItemType - First observed
getAvatar - First observed
getComment - First observed
getComments - First observed
getCurrentEnumerationOptionsForDocument - First observed
getCurrentEnumOptionsForWorkItem - First observed
getDefaultIcon - First observed
getDefaultIcons - First observed
getDocument - First observed
getDocumentAttachment - First observed
getDocumentAttachmentContent - First observed
getDocumentAttachments - First observed
getDocumentComment - First observed
getDocumentComments - First observed
getDocumentPart - First observed
getDocumentParts - First observed
getExportExcelTests - First observed
getExternallyLinkedWorkItem - First observed
getExternallyLinkedWorkItems - First observed
getFeatureSelection - First observed
getFeatureSelections - First observed
getGlobalEnumeration - First observed
getGlobalIcon - First observed
getGlobalIcons - First observed
getJob - First observed
getJobResultFileContent - First observed
getLinkedWorkItem - First observed
getLinkedWorkItems - First observed
getOslcResources - First observed
getPage - First observed
getPageAttachment - First observed
getPageAttachmentContent - First observed
getPlan - First observed
getPlanRelationship - First observed
getPlans - First observed
getProject - First observed
getProjectEnumeration - First observed
getProjectIcon - First observed
getProjectIcons - First observed
getProjects - First observed
getProjectTemplates - First observed
getProjectTestParameterDefinition - First observed
getProjectTestParameterDefinitions - First observed
getRevision - First observed
getRevisions - First observed
getRole - First observed
getTestRecord - First observed
getTestRecordAttachment - First observed
getTestRecordAttachmentContent - First observed
getTestRecordAttachments - First observed
getTestRecords - First observed
getTestRecordTestParameter - First observed
getTestRecordTestParameters - First observed
getTestRun - First observed
getTestRunAttachment - First observed
getTestRunAttachmentContent - First observed
getTestRunAttachments - First observed
getTestRunComment - First observed
getTestRunComments - First observed
getTestRuns - First observed
getTestRunTestParameter - First observed
getTestRunTestParameterDefinition - First observed
getTestRunTestParameterDefinitions - First observed
getTestRunTestParameters - First observed
getTestStep - First observed
getTestStepResult - First observed
getTestStepResultAttachment - First observed
getTestStepResultAttachmentContent - First observed
getTestStepResultAttachments - First observed
getTestStepResults - First observed
getTestSteps - First observed
getUser - First observed
getUserGroup - First observed
getUsers - First observed
getWorkflowActionsForTestRun - First observed
getWorkflowActionsForWorkItem - First observed
getWorkItem - First observed
getWorkItemApproval - First observed
getWorkItemApprovals - First observed
getWorkItemAttachment - First observed
getWorkItemAttachmentContent - First observed
getWorkItemAttachments - First observed
getWorkItems - First observed
getWorkItemsRelationships - First observed
getWorkItemTestParameterDefinition - First observed
getWorkItemTestParameterDefinitions - First observed
getWorkRecord - First observed
getWorkRecords - First observed
importExcelTestResults - First observed
importXUnitTestResults - First observed
markProject - First observed
mergeDocumentFromMaster - First observed
mergeDocumentToMaster - First observed
moveFromDocument - First observed
moveProjectAction - First observed
moveToDocument - First observed
patchAllWorkItems - First observed
patchComment - First observed
patchDocument - First observed
patchDocumentAttachment - First observed
patchDocumentComment - First observed
patchGlobalEnumeration - First observed
patchLinkedWorkItem - First observed
patchPlan - First observed
patchPlanRelationships - First observed
patchProject - First observed
patchProjectEnumeration - First observed
patchRichPage - First observed
patchTestRecord - First observed
patchTestRecordAttachment - First observed
patchTestRecords - First observed
patchTestRun - First observed
patchTestRunAttachment - First observed
patchTestRunComment - First observed
patchTestRunComments - First observed
patchTestRuns - First observed
patchTestStep - First observed
patchTestStepResult - First observed
patchTestStepResultAttachment - First observed
patchTestStepResults - First observed
patchTestSteps - First observed
patchUser - First observed
patchWorkItem - First observed
patchWorkItemApproval - First observed
patchWorkItemApprovals - First observed
patchWorkItemAttachment - First observed
patchWorkItemRelationships - First observed
patchWorkItems - First observed
postComments - First observed
postDocumentComments - First observed
postDocumentItemAttachments - First observed
postDocumentParts - First observed
postDocuments - First observed
postExternallyLinkedWorkItems - First observed
postGlobalEnumeration - First observed
postGlobalIcons - First observed
postLinkedWorkItems - First observed
postOslcResources - First observed
postPageAttachments - First observed
postPlanRelationships - First observed
postPlans - First observed
postProjectEnumeration - First observed
postProjectIcons - First observed
postProjectTestParameterDefinitions - First observed
postTestRecordAttachments - First observed
postTestRecords - First observed
postTestRecordTestParameters - First observed
postTestRunAttachments - First observed
postTestRunComments - First observed
postTestRunParameterDefinitions - First observed
postTestRuns - First observed
postTestRunTestParameters - First observed
postTestStepResultAttachments - First observed
postTestStepResults - First observed
postTestSteps - First observed
postUsers - First observed
postWorkItemApprovals - First observed
postWorkItemAttachments - First observed
postWorkItemRelationships - First observed
postWorkItems - First observed
postWorkRecords - First observed
refresh_polarion_config - First observed
setLicense - First observed
unmarkProject - First observed
updateAvatar
TDQS
Scored across 284 tools
Every tool has a specific target resource and action, and the descriptions do exceptional work cross-referencing near-neighbors (e.g., getGlobalIcons vs getProjectIcons vs getDefaultIcons, getDocument vs getSpaceDocuments vs getAllDocuments) and clarifying scope and cardinality. However, the highly formulaic repetition across ~284 tools and a few genuinely confusable pairs (getComments vs getDocumentComments, getWorkItemsRelationships vs getWorkItemRelationships, the various getTestRunTestParameter* variants) mean an agent must read descriptions carefully to avoid misselection.
The dominant get/post/patch/delete + ResourceName camelCase convention is clear and widely applied, which provides a strong base pattern. But there are numerous deviations: imperative action verbs (createProject, markProject, closeCollection, branchDocuments, importWordDocument, generateCompletion) and internally inconsistent pairings (deleteApprovals vs postWorkItemApprovals, patchCustomField vs postProjectCustomFields, deleteWorkItemsRelationship vs patchWorkItemRelationships, getCurrentEnumerationOptionsForDocument vs getCurrentEnumOptionsForWorkItem) break the pattern enough to be noticeable.
With 284 tools, this server is far beyond any reasonable MCP surface, exceeding the 50+ extreme threshold by over fivefold. The count reflects the full breadth of the Polarion ALM REST API, but exposing every endpoint as a flat tool list is overwhelming and forces agents to navigate an enormous, repetitive selection space rather than a curated workflow.
Coverage is remarkably thorough: projects, work items, documents, pages, plans, collections, test runs/records/steps, users, licenses, jobs, revisions, and administration each have rich CRUD-plus-lifecycle support including attachments, comments, relationships, workflow actions, and import/export. Notable gaps exist—comment deletion is absent for documents, pages, test runs, and work items; user deletion and some patch operations on test parameter definitions are missing—but these are minor workarounds rather than dead ends.
Maintenance
Related MCP Connectors
An MCP server that provides access to Testiny projects, test cases and test runs
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
A TypeScript MCP server for Home Assistant, enabling programmatic management of entities, automati…
Nifty's MCP server — exposes tasks, projects, messages, and files as tools for AI agents.
Related MCP Servers
- AlicenseDqualityDmaintenanceA TypeScript MCP server demo supporting local Stdio and remote Streamable HTTP, demonstrating tool invocation for AI agents.2MIT
- AlicenseAqualityAmaintenanceA Model Context Protocol (MCP) server for Polarion ALM. Lets AI assistants read documents, work items, and traceability links — and create, update, and reorganize work items — directly from your Polarion instance.4688 PyPI15MIT
- AlicenseNot gradedqualityDmaintenanceA CLI-first Polarion ALM client with MCP server support for AI assistants, enabling natural language interaction with Polarion projects, work items, tests, and plans.4MIT
- AlicenseAqualityDmaintenanceA TypeScript-based MCP server that integrates with Swagger/OpenAPI specifications to expose API endpoints as tools for Large Language Models (LLMs), enabling natural language interaction with any OpenAPI-compliant API.49MIT