Siemens PLM · Schema
Polarion REST API Schemas
JSON Schema definitions for the Polarion ALM REST API (239 schemas)
PLMProduct Lifecycle ManagementTeamcenterNXSolid EdgeSimcenterXceleratorDigital ManufacturingIndustrial IoTCADCAMSustainabilityALM
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://developer.siemens.com/polarion/schemas/polarion-rest-api.json",
"title": "Polarion REST API Schemas",
"description": "JSON Schema definitions for the Polarion ALM REST API (239 schemas)",
"definitions": {
"backlinkedworkitemsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedworkitems"
],
"type": "string"
},
"attributes": {
"properties": {
"revision": {
"example": "1234",
"type": "string"
},
"role": {
"example": "relates_to",
"type": "string"
},
"suspect": {
"type": "boolean"
}
},
"type": "object"
},
"relationships": {
"properties": {
"sourceWorkItem": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"branchDocumentRequestBody": {
"properties": {
"copyWorkflowStatusAndSignatures": {
"description": "Specifies that workflow status and signatures should be copied to the branched document.",
"example": false,
"type": "boolean"
},
"query": {
"description": "Specifies optional filtering query.",
"example": "status:open",
"type": "string"
},
"targetDocumentName": {
"description": "Name for new Document.",
"example": "MyDocumentId",
"type": "string"
},
"targetProjectId": {
"description": "Project where new document will be created.",
"example": "MyProjectId",
"type": "string"
},
"targetSpaceId": {
"description": "Space where new document will be created.",
"example": "MySpaceId",
"type": "string"
}
},
"type": "object"
},
"branchDocumentsRequestBody": {
"properties": {
"documentConfigurations": {
"items": {
"properties": {
"copyWorkflowStatusAndSignatures": {
"description": "Specifies that workflow status and signatures should be copied to the branched document.",
"example": false,
"type": "boolean"
},
"initializedFields": {
"description": "Specifies fields of overwritten Work Items that should be initialized (instead of being copied from source Work Items).",
"items": {
"example": "severity",
"type": "string"
},
"type": "array"
},
"overwriteWorkItems": {
"description": "Specifies that Work Items in the branched Document should be overwritten (instead of being referenced).",
"example": false,
"type": "boolean"
},
"query": {
"description": "Specifies optional filtering query.",
"example": "status:open",
"type": "string"
},
"sourceDocument": {
"description": "Reference path of the source Document.",
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
},
"sourceRevision": {
"description": "Revision of the source Document.",
"example": "1234",
"type": "string"
},
"targetDocumentName": {
"description": "Name for new Document.",
"example": "MyDocumentId",
"type": "string"
},
"targetDocumentTitle": {
"description": "Title for new Document.",
"example": "My Document Title",
"type": "string"
},
"targetProjectId": {
"description": "Project where new document will be created.",
"example": "MyProjectId",
"type": "string"
},
"targetSpaceId": {
"description": "Space where new document will be created.",
"example": "MySpaceId",
"type": "string"
},
"updateTitleHeading": {
"description": "Specifies that title heading of the target Document should be set to the new Document's title.",
"example": false,
"type": "boolean"
}
},
"required": [
"sourceDocument"
],
"type": "object"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"documentConfigurations"
],
"type": "object"
},
"collectionsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyCollectionId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"collectionsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyCollectionId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"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"
},
"collectionsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
}
},
"type": "object"
},
"relationships": {
"properties": {
"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"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"collectionsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"collectionsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyCollectionId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
}
# --- truncated at 32 KB (936 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/siemens-plm/refs/heads/main/json-schema/polarion-rest-api.json