changedOutput 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"
+}