{
"$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 REST API User Guide.",
"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"
}
},
"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"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"collectionsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyCollectionId",
"type": "string"
},
"attributes": {
"properties": {
"description": {
"properties": {
"type": {
"enum": [
"text/html",
"text/plain"
],
"type": "string"
},
"value": {
"example": "My text value",
"type": "string"
}
},
"type": "object"
},
"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": "object"
},
"collectionsSinglePostResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"collections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyCollectionId",
"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"
},
"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"
},
"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"
},
"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": "object"
},
"copyDocumentRequestBody": {
"properties": {
"linkOriginalItemsWithRole": {
"description": "Link a copy of the document to the original.",
"example": "duplicates",
"type": "string"
},
"removeOutgoingLinks": {
"description": "Should outgoing links be removed?",
"example": true,
"type": "boolean"
},
"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"
},
"createProjectRequestBody": {
"properties": {
"location": {
"description": "Location of the new Project to be created.",
"example": "MyLocation",
"nullable": false,
"type": "string"
},
"params": {
"description": "Parameters of new Project to be created.",
"nullable": true,
"type": "object"
},
"projectId": {
"description": "Id of the new Project to be created.",
"example": "MyProjectId",
"nullable": false,
"type": "string"
},
"templateId": {
"description": "Id of the template to create the new Project from.",
"example": "MyProjectTemplateId",
"nullable": true,
"type": "string"
},
"trackerPrefix": {
"description": "Tracker prefix of the new Project to be created.",
"example": "MyTrackerPrefix",
"nullable": false,
"type": "string"
}
},
"type": "object"
},
"customfieldsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"customfields"
],
"type": "string"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"customfieldsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"customfields"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"customfieldsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"customfields"
],
"type": "string"
},
"id": {
"example": "MyProjectId/workitems/epic",
"type": "string"
},
"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"
},
"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": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"customfieldsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"customfields"
],
"type": "string"
},
"id": {
"example": "MyProjectId/workitems/epic",
"type": "string"
},
"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"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"document_attachmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"document_attachmentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_attachments"
],
"type": "string"
},
"attributes": {
"properties": {
"fileName": {
"example": "File Name",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"lid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"document_attachmentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_attachments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"document_attachmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"document_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"document_attachmentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"document_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId",
"type": "string"
},
"attributes": {
"properties": {
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"document_commentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"document_commentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_comments"
],
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
},
"text": {
"properties": {
"type": {
"enum": [
"text/html",
"text/plain"
],
"type": "string"
},
"value": {
"example": "My text value",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"relationships": {
"properties": {
"author": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"parentComment": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId",
"type": "string"
},
"type": {
"enum": [
"document_comments"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"document_commentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_comments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"document_commentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"document_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"document_commentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"document_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId",
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"document_partsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_parts"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"content": {
"example": "",
"type": "string"
},
"external": {
"type": "boolean"
},
"id": {
"example": "workitem_MyWorkItemId",
"type": "string"
},
"layout": {
"example": 0,
"format": "int32",
"type": "integer"
},
"level": {
"example": 0,
"format": "int32",
"type": "integer"
},
"type": {
"example": "workitem",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"document_partsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_parts"
],
"type": "string"
},
"attributes": {
"properties": {
"layout": {
"example": 0,
"format": "int32",
"type": "integer"
},
"level": {
"example": 0,
"format": "int32",
"type": "integer"
},
"type": {
"example": "workitem",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"nextPart": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"document_partsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"document_parts"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"document_partsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"document_parts"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"content": {
"example": "",
"type": "string"
},
"external": {
"type": "boolean"
},
"id": {
"example": "workitem_MyWorkItemId",
"type": "string"
},
"layout": {
"example": 0,
"format": "int32",
"type": "integer"
},
"level": {
"example": 0,
"format": "int32",
"type": "integer"
},
"type": {
"example": "workitem",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"documentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"documents"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"documentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"documents"
],
"type": "string"
},
"attributes": {
"properties": {
"autoSuspect": {
"type": "boolean"
},
"homePageContent": {
"properties": {
"type": {
"enum": [
"text/html",
"text/plain"
],
"type": "string"
},
"value": {
"example": "My text value",
"type": "string"
}
},
"type": "object"
},
"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"
},
"usesOutlineNumbering": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"documentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"documents"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"documentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"documents"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"documentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"documents"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
},
"attributes": {
"properties": {
"autoSuspect": {
"type": "boolean"
},
"homePageContent": {
"properties": {
"type": {
"enum": [
"text/html",
"text/plain"
],
"type": "string"
},
"value": {
"example": "My text value",
"type": "string"
}
},
"type": "object"
},
"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"
},
"usesOutlineNumbering": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"documentsSinglePostResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"documents"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
},
"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"
},
"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"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"enumerationsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"enumerations"
],
"type": "string"
},
"id": {
"example": "~/status/~",
"type": "string"
},
"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"
},
"minValue": {
"example": 30.0,
"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"
},
"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": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"enumerationsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"enumerations"
],
"type": "string"
},
"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"
},
"minValue": {
"example": 30.0,
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"enumerationsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"enumerations"
],
"type": "string"
},
"id": {
"example": "~/status/~",
"type": "string"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/enumerations/%7E/status/%7E",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"enumerationsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"enumerations"
],
"type": "string"
},
"id": {
"example": "~/status/~",
"type": "string"
},
"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"
},
"minValue": {
"example": 30.0,
"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"
},
"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": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/enumerations/%7E/status/%7E",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"enumerationsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"enumerations"
],
"type": "string"
},
"id": {
"example": "~/status/~",
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"minValue": {
"example": 30.0,
"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"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"enumOptionsActionResponseBody": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "open",
"type": "string"
},
"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"
},
"limited": {
"example": true,
"type": "boolean"
},
"minValue": {
"example": 30.0,
"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"
},
"errors": {
"properties": {
"errors": {
"items": {
"properties": {
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"executeJobRequestBody": {
"properties": {
"jobId": {
"description": "Id of job factory, e.g. jobs.cleanup",
"example": "MyJobId",
"nullable": false,
"type": "string"
},
"name": {
"example": "My Job",
"nullable": false,
"type": "string"
},
"nodeId": {
"example": "MyNodeId",
"nullable": true,
"type": "string"
},
"params": {
"description": "Parameters of Job to be executed.",
"nullable": true,
"properties": {
"param1": {
"example": "value1",
"type": "string"
},
"param2": {
"example": "value2",
"type": "string"
}
},
"type": "object"
},
"scope": {
"description": "Scope of the job. Accepted formats: 'system', 'project:{projectId}', or 'path:/{path}'.",
"example": "system",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"externallylinkedworkitemsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"externallylinkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"externallylinkedworkitemsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"externallylinkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"role": {
"example": "relates_to",
"type": "string"
},
"workItemURI": {
"type": "string"
}
},
"type": "object"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"externallylinkedworkitemsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"externallylinkedworkitems"
],
"type": "string"
},
"attributes": {
"properties": {
"role": {
"example": "relates_to",
"type": "string"
},
"workItemURI": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"externallylinkedworkitemsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"externallylinkedworkitems"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"externallylinkedworkitemsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"externallylinkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"role": {
"example": "relates_to",
"type": "string"
},
"workItemURI": {
"type": "string"
}
},
"type": "object"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"featureselectionsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"featureselections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/included/MyProjectId/MyWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"selectionType": {
"enum": [
"excluded",
"included",
"implicitly-included"
],
"example": "excluded",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"featureselectionsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"featureselections"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/included/MyProjectId/MyWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"selectionType": {
"enum": [
"excluded",
"included",
"implicitly-included"
],
"example": "excluded",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"fieldsMetadataActionResponseBody": {
"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"
},
"globalrolesSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"globalroles"
],
"type": "string"
},
"id": {
"example": "MyRoleId",
"type": "string"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/roles/MyRoleId",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"iconsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"icons"
],
"type": "string"
},
"id": {
"example": "default/example.gif",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"iconUrl": {
"example": "pathexample",
"type": "string"
},
"id": {
"example": "pathexample",
"type": "string"
},
"path": {
"example": "pathexample",
"type": "string"
}
},
"type": "object"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"iconsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"icons"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"iconsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"icons"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"iconsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"icons"
],
"type": "string"
},
"id": {
"example": "default/example.gif",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"iconUrl": {
"example": "pathexample",
"type": "string"
},
"id": {
"example": "pathexample",
"type": "string"
},
"path": {
"example": "pathexample",
"type": "string"
}
},
"type": "object"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/enumerations/defaulticons/example.gif",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"importTestResultsRequestBody": {
"properties": {
"defectTemplateId": {
"example": "MyProjectId/MyDefectId",
"type": "string"
},
"retest": {
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"jobsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"jobs"
],
"type": "string"
},
"id": {
"example": "MyJobId",
"type": "string"
},
"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"
},
"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"
},
"links": {
"properties": {
"downloads": {
"example": [
"https://example.com/polarion/download/filename1",
"https://example.com/polarion/download/filename2"
],
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"jobsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"jobs"
],
"type": "string"
},
"id": {
"example": "MyJobId",
"type": "string"
},
"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"
},
"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"
},
"links": {
"properties": {
"downloads": {
"example": [
"https://example.com/polarion/download/filename1",
"https://example.com/polarion/download/filename2"
],
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/jobs/MyJobId",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"jobsSinglePostResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"jobs"
],
"type": "string"
},
"id": {
"example": "MyJobId",
"type": "string"
},
"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"
},
"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"
},
"links": {
"properties": {
"downloads": {
"example": [
"https://example.com/polarion/download/filename1",
"https://example.com/polarion/download/filename2"
],
"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"
}
},
"type": "object"
}
},
"type": "object"
},
"license_assignmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"license_assignments"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"LOGGED_IN",
"EXPIRING",
"INACTIVE"
],
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"license_assignmentsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"license_assignments"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"relationships": {
"properties": {
"addOnSlots": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "LicenseType/ModelType/GroupId",
"type": "string"
},
"type": {
"enum": [
"license_slots"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"baseSlot": {
"properties": {
"data": {
"properties": {
"id": {
"example": "LicenseType/ModelType/GroupId",
"type": "string"
},
"type": {
"enum": [
"license_slots"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"license_assignmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"license_assignments"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"LOGGED_IN",
"EXPIRING",
"INACTIVE"
],
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/license/assignments/MyUserId",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"license_slotsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"license_slots"
],
"type": "string"
},
"id": {
"example": "LicenseType/ModelType/GroupId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"license_slotsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"license_slots"
],
"type": "string"
},
"id": {
"example": "LicenseType/ModelType/GroupId",
"type": "string"
},
"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"
},
"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": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"license_slotsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"license_slots"
],
"type": "string"
},
"attributes": {
"properties": {
"group": {
"example": "groupName",
"type": "string"
},
"total": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"license_slotsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"license_slots"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"license_slotsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"license_slots"
],
"type": "string"
},
"id": {
"example": "LicenseType/ModelType/GroupId",
"type": "string"
},
"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"
},
"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": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"licenseSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"license"
],
"type": "string"
},
"id": {
"example": "license",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/license",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"licenseSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"license"
],
"type": "string"
},
"id": {
"example": "license",
"type": "string"
},
"relationships": {
"properties": {
"defaultAddOnLicenseSlots": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "LicenseType/ModelType/GroupId",
"type": "string"
},
"type": {
"enum": [
"license_slots"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"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": "object"
}
},
"type": "object"
},
"linkedoslcresourcesListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedoslcresources"
],
"type": "string"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedoslcresourcesListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedoslcresources"
],
"type": "string"
},
"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"
},
"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"
},
"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": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"meta": {
"properties": {
"totalCount": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"linkedoslcresourcesListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedoslcresources"
],
"type": "string"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedoslcresourcesListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedoslcresources"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedworkitemsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedworkitemsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"linkedworkitemsListPostRequest": {
"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": {
"workItem": {
"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"
},
"linkedworkitemsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"linkedworkitems"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedworkitemsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"linkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"linkedworkitemsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"linkedworkitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId",
"type": "string"
},
"attributes": {
"properties": {
"revision": {
"example": "1234",
"type": "string"
},
"suspect": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"mergeDocumentRequestBody": {
"properties": {
"createBaseline": {
"description": "Specifies whether the Baseline should be created.",
"example": true,
"type": "boolean"
},
"userFilter": {
"description": "Specifies the query to filter the source Work Items for the merge.",
"example": "status:open",
"type": "string"
}
},
"type": "object"
},
"metadataSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"metadata"
],
"type": "string"
},
"id": {
"example": "metadata",
"type": "string"
},
"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"
},
"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": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/metadata",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"moveDocumentPartRequestBody": {
"properties": {
"after": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
},
"before": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
},
"parent": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
}
},
"type": "object"
},
"moveProjectRequestBody": {
"properties": {
"location": {
"description": "Location of the new Project to be created.",
"example": "MyLocation",
"nullable": false,
"type": "string"
}
},
"type": "object"
},
"moveWorkItemToDocumentRequestBody": {
"properties": {
"nextPart": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
},
"previousPart": {
"example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
"type": "string"
},
"targetDocument": {
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
}
},
"type": "object"
},
"page_attachmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"page_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"page_attachmentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"page_attachments"
],
"type": "string"
},
"attributes": {
"properties": {
"fileName": {
"example": "File Name",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"lid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"page_attachmentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"page_attachments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"page_attachmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"page_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"page_attachmentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"page_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId",
"type": "string"
},
"attributes": {
"properties": {
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"page_commentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"page_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"page_commentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"page_comments"
],
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
},
"text": {
"properties": {
"type": {
"enum": [
"text/html",
"text/plain"
],
"type": "string"
},
"value": {
"example": "My text value",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"relationships": {
"properties": {
"author": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"parentComment": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId",
"type": "string"
},
"type": {
"enum": [
"page_comments"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"page_commentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"page_comments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"page_commentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"page_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"page_commentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"page_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId/MyCommentId",
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"pagesListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"pages"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"pagesListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"pages"
],
"type": "string"
},
"attributes": {
"properties": {
"homePageContent": {
"properties": {
"type": {
"enum": [
"text/html",
"text/plain"
],
"type": "string"
},
"value": {
"example": "My text value",
"type": "string"
}
},
"type": "object"
},
"pageName": {
"example": "MyRichPageId",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"author": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"pagesListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"pages"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"pagesSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"pages"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"pagesSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"pages"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MySpaceId/MyRichPageId",
"type": "string"
},
"attributes": {
"properties": {
"homePageContent": {
"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"
},
"relationships": {
"properties": {
"watches": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"PatchDocumentAttachmentsRequestBody": {
"properties": {
"content": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/document_attachmentsSinglePatchRequest"
}
},
"required": [
"resource"
],
"title": "PatchDocumentAttachmentsRequestBody",
"type": "object"
},
"PatchPageAttachmentsRequestBody": {
"properties": {
"content": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/page_attachmentsSinglePatchRequest"
}
},
"required": [
"resource"
],
"title": "PatchPageAttachmentsRequestBody",
"type": "object"
},
"PatchTestRecordAttachmentsRequestBody": {
"properties": {
"content": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/testrecord_attachmentsSinglePatchRequest"
}
},
"required": [
"resource"
],
"title": "PatchTestRecordAttachmentsRequestBody",
"type": "object"
},
"PatchTestRunAttachmentsRequestBody": {
"properties": {
"content": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/testrun_attachmentsSinglePatchRequest"
}
},
"required": [
"resource"
],
"title": "PatchTestRunAttachmentsRequestBody",
"type": "object"
},
"PatchTestStepResultAttachmentsRequestBody": {
"properties": {
"content": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/teststepresult_attachmentsSinglePatchRequest"
}
},
"required": [
"resource"
],
"title": "PatchTestStepResultAttachmentsRequestBody",
"type": "object"
},
"PatchWorkItemAttachmentsRequestBody": {
"properties": {
"content": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/workitem_attachmentsSinglePatchRequest"
}
},
"required": [
"resource"
],
"title": "PatchWorkItemAttachmentsRequestBody",
"type": "object"
},
"plansListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"plans"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"plansListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"plans"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"plansListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"plans"
],
"type": "string"
},
"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"
},
"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"
},
"useReportFromTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"relationships": {
"properties": {
"parent": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
},
"type": {
"enum": [
"plans"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectSpan": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId",
"type": "string"
},
"type": {
"enum": [
"projects"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"template": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
},
"type": {
"enum": [
"plans"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"workItems": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"plansListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"plans"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"plansSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"plans"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"plansSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"plans"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
},
"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"
},
"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"
},
"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"
},
"useReportFromTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"relationships": {
"properties": {
"parent": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyPlanId",
"type": "string"
},
"type": {
"enum": [
"plans"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectSpan": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId",
"type": "string"
},
"type": {
"enum": [
"projects"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workItems": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"PostDocumentAttachmentsRequestBody": {
"properties": {
"files": {
"items": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/document_attachmentsListPostRequest"
}
},
"title": "PostDocumentAttachmentsRequestBody",
"type": "object"
},
"PostIconsRequestBody": {
"properties": {
"files": {
"items": {
"description": "icons' content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/iconsListPostRequest"
}
},
"title": "PostIconsRequestBody",
"type": "object"
},
"PostImportActionRequestBody": {
"properties": {
"file": {
"description": "excel file content",
"format": "binary",
"type": "string"
},
"resource": {
"$ref": "#/components/schemas/importTestResultsRequestBody"
}
},
"required": [
"file"
],
"title": "PostImportActionRequestBody",
"type": "object"
},
"PostPageAttachmentsRequestBody": {
"properties": {
"files": {
"items": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/page_attachmentsListPostRequest"
}
},
"title": "PostPageAttachmentsRequestBody",
"type": "object"
},
"PostTestRecordAttachmentsRequestBody": {
"properties": {
"files": {
"items": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/testrecord_attachmentsListPostRequest"
}
},
"title": "PostTestRecordAttachmentsRequestBody",
"type": "object"
},
"PostTestRunAttachmentsRequestBody": {
"properties": {
"files": {
"items": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/testrun_attachmentsListPostRequest"
}
},
"title": "PostTestRunAttachmentsRequestBody",
"type": "object"
},
"PostTestStepResultAttachmentsRequestBody": {
"properties": {
"files": {
"items": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/teststepresult_attachmentsListPostRequest"
}
},
"title": "PostTestStepResultAttachmentsRequestBody",
"type": "object"
},
"PostWorkItemAttachmentsRequestBody": {
"properties": {
"files": {
"items": {
"description": "attachments content",
"format": "binary",
"type": "string"
},
"type": "array"
},
"resource": {
"$ref": "#/components/schemas/workitem_attachmentsListPostRequest"
}
},
"title": "PostWorkItemAttachmentsRequestBody",
"type": "object"
},
"projectsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"projects"
],
"type": "string"
},
"id": {
"example": "MyProjectId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"projectsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"projects"
],
"type": "string"
},
"id": {
"example": "MyProjectId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/projects/MyProjectId?revision=1234",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"projectsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"projects"
],
"type": "string"
},
"id": {
"example": "MyProjectId",
"type": "string"
},
"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"
},
"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"
},
"relationships": {
"properties": {
"lead": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"projecttemplatesListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"projecttemplates"
],
"type": "string"
},
"id": {
"example": "MyProjectId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"RelationshipDataBody": {
"properties": {
"id": {
"example": "MyProjectId/MyResourceId",
"type": "string"
},
"type": {
"enum": [
"collections",
"categories",
"documents",
"document_attachments",
"document_comments",
"document_parts",
"enumerations",
"globalroles",
"icons",
"jobs",
"linkedworkitems",
"externallylinkedworkitems",
"linkedoslcresources",
"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"
},
"RelationshipDataListRequest": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/RelationshipDataBody"
},
"type": "array"
}
},
"type": "object"
},
"RelationshipDataListResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/RelationshipDataBody"
},
"type": "array"
}
},
"type": "object"
},
"RelationshipDataSingleRequest": {
"properties": {
"data": {
"$ref": "#/components/schemas/RelationshipDataBody"
}
},
"type": "object"
},
"RelationshipDataSingleResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/RelationshipDataBody"
}
},
"type": "object"
},
"RelationshipResponseBody": {
"description": "The Relationship's response body. Can return a single or a list of instances",
"example": {
"data": [
{
"type": "MyResourceType",
"id": "MyProjectId/MyResourceId"
}
]
},
"oneOf": [
{
"$ref": "#/components/schemas/RelationshipDataSingleResponse"
},
{
"$ref": "#/components/schemas/RelationshipDataListResponse"
}
],
"type": "object"
},
"relationshipsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"collections",
"categories",
"documents",
"document_attachments",
"document_comments",
"document_parts",
"enumerations",
"globalroles",
"icons",
"jobs",
"linkedworkitems",
"externallylinkedworkitems",
"linkedoslcresources",
"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"
},
"id": {
"example": "MyProjectId/MyResourceId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RelationshipsRequestBody": {
"description": "List of generic contents",
"example": {
"data": [
{
"type": "MyResourceType",
"id": "MyProjectId/MyResourceId"
}
]
},
"oneOf": [
{
"$ref": "#/components/schemas/RelationshipDataSingleRequest"
},
{
"$ref": "#/components/schemas/RelationshipDataListRequest"
}
],
"type": "object"
},
"RelationshipsRequestWithRevisionBody": {
"description": "List of generic contents",
"example": {
"data": [
{
"type": "MyResourceType",
"id": "MyProjectId/MyResourceId",
"revision": "1234"
}
]
},
"oneOf": [
{
"$ref": "#/components/schemas/RelationshipDataSingleRequest"
},
{
"$ref": "#/components/schemas/RelationshipDataListRequest"
}
],
"type": "object"
},
"ResourceQueryContext": {
"properties": {
"contextResourceReference": {
"$ref": "#/components/schemas/ResourceReference"
}
},
"type": "object"
},
"ResourceReference": {
"properties": {
"containedResource": {
"type": "boolean"
}
},
"type": "object"
},
"reuseCollectionRequestBody": {
"properties": {
"targetCollectionName": {
"description": "The name of the new Collection.",
"example": "Name",
"type": "string"
},
"targetProjectId": {
"description": "Project where new Collection will be created.",
"example": "MyProjectId",
"type": "string"
}
},
"type": "object"
},
"revisionsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"revisions"
],
"type": "string"
},
"id": {
"example": "default/1234",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"revisionsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"revisions"
],
"type": "string"
},
"id": {
"example": "default/1234",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/revisions/default/1234",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"setLicenseRequestBody": {
"properties": {
"concurrent": {
"description": "Is concurrent user",
"example": true,
"type": "boolean"
},
"group": {
"description": "License group",
"example": "Department",
"type": "string"
},
"license": {
"description": "User's license type",
"enum": [
"REVIEWER",
"XReviewer",
"XBase",
"XEssentials",
"XPro",
"XStandard",
"XEnterprise",
"XAdvanced",
"XExtended",
"XPremium",
"XAutomotive",
"PRO",
"REQUIREMENTS",
"QA",
"ALM"
],
"type": "string"
}
},
"type": "object"
},
"sparseFields": {
"properties": {
"categories": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"collections": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"customfields": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"document_attachments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"document_comments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"document_parts": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"documents": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"enumerations": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"externallylinkedworkitems": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"featureselections": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"globalroles": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"icons": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"jobs": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"license": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"license_assignments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"license_slots": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"license_types": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"linkedoslcresources": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"linkedworkitems": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"metadata": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"page_attachments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"page_comments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"pages": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"plans": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"projectroles": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"projects": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"projecttemplates": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"revisions": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testparameter_definitions": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testparameters": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testrecord_attachments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testrecords": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testrun_attachments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testrun_comments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"testruns": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"teststep_results": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"teststepresult_attachments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"teststeps": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"usergroups": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"users": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"workitem_approvals": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"workitem_attachments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"workitem_comments": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"workitems": {
"description": "Requested fields",
"example": "@all",
"type": "string"
},
"workrecords": {
"description": "Requested fields",
"example": "@all",
"type": "string"
}
},
"type": "object"
},
"SparseFields": {
"$ref": "#/components/schemas/sparseFields"
},
"testparameter_definitionsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameter_definitions"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestParamDefinition",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testparameter_definitionsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameter_definitions"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestParamDefinition",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"name": {
"example": "Test Parameter Definition example",
"type": "string"
}
},
"type": "object"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testparameter_definitionsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameter_definitions"
],
"type": "string"
},
"attributes": {
"properties": {
"name": {
"example": "Test Parameter Definition example",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testparameter_definitionsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameter_definitions"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestParamDefinition",
"type": "string"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testparameter_definitionsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testparameter_definitions"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestParamDefinition",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"name": {
"example": "Test Parameter Definition example",
"type": "string"
}
},
"type": "object"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"testparametersListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameters"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyTestParameter",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testparametersListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameters"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyTestParameter",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"name": {
"example": "Example Test Parameter value",
"type": "string"
},
"value": {
"example": "Example Test Parameter value",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testparametersListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameters"
],
"type": "string"
},
"attributes": {
"properties": {
"name": {
"example": "Example Test Parameter value",
"type": "string"
},
"value": {
"example": "Example Test Parameter value",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testparametersListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testparameters"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"testparametersSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testparameters"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyTestParameter",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"name": {
"example": "Example Test Parameter value",
"type": "string"
},
"value": {
"example": "Example Test Parameter value",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrecord_attachmentsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecord_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrecord_attachmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecord_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrecord_attachmentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecord_attachments"
],
"type": "string"
},
"attributes": {
"properties": {
"fileName": {
"example": "File Name",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"lid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrecord_attachmentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecord_attachments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrecord_attachmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrecord_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrecord_attachmentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrecord_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId",
"type": "string"
},
"attributes": {
"properties": {
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"testrecordsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecords"
],
"type": "string"
},
"id": {
"example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrecordsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecords"
],
"type": "string"
},
"id": {
"example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0",
"type": "string"
},
"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"
},
"result": {
"example": "passed",
"type": "string"
},
"testCaseRevision": {
"example": "Test Case Revision",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"defect": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"executedBy": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrecordsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecords"
],
"type": "string"
},
"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"
},
"result": {
"example": "passed",
"type": "string"
},
"testCaseRevision": {
"example": "Test Case Revision",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"defect": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"executedBy": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"testCase": {
"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"
},
"testrecordsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrecords"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrecordsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrecords"
],
"type": "string"
},
"id": {
"example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrecordsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrecords"
],
"type": "string"
},
"id": {
"example": "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0",
"type": "string"
},
"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"
},
"result": {
"example": "passed",
"type": "string"
},
"testCaseRevision": {
"example": "Test Case Revision",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"defect": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"executedBy": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"testrun_attachmentsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyAttachmentId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrun_attachmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrun_attachmentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_attachments"
],
"type": "string"
},
"attributes": {
"properties": {
"fileName": {
"example": "File Name",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"lid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrun_attachmentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_attachments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrun_attachmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrun_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrun_attachmentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrun_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyAttachmentId",
"type": "string"
},
"attributes": {
"properties": {
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"testrun_commentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrun_commentsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyCommentId",
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrun_commentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"relationships": {
"properties": {
"author": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"parentComment": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyTestRunId/MyCommentId",
"type": "string"
},
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrun_commentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrun_commentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrun_commentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testrun_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyCommentId",
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"testrunsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrunsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrunsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId",
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"idPrefix": {
"example": "MyTestRunIdPrefix",
"type": "string"
},
"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"
},
"useReportFromTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"relationships": {
"properties": {
"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"
},
"projectSpan": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId",
"type": "string"
},
"type": {
"enum": [
"projects"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"summaryDefect": {
"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"
},
"testrunsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"useReportFromTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"relationships": {
"properties": {
"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"
},
"projectSpan": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId",
"type": "string"
},
"type": {
"enum": [
"projects"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"summaryDefect": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"template": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyTestRunId",
"type": "string"
},
"type": {
"enum": [
"testruns"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrunsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"testrunsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"testrunsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"testruns"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId",
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"idPrefix": {
"example": "MyTestRunIdPrefix",
"type": "string"
},
"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"
},
"useReportFromTemplate": {
"type": "boolean"
}
},
"type": "object"
},
"relationships": {
"properties": {
"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"
},
"projectSpan": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId",
"type": "string"
},
"type": {
"enum": [
"projects"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"summaryDefect": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"type": {
"enum": [
"workitems"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"teststep_resultsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststep_results"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"teststep_resultsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststep_results"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1",
"type": "string"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststep_resultsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststep_results"
],
"type": "string"
},
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststep_resultsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststep_results"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststep_resultsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"teststep_results"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"teststep_resultsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"teststep_results"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1",
"type": "string"
},
"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"
}
},
"type": "object"
}
},
"type": "object"
},
"teststepresult_attachmentsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststepresult_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepresult_attachmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststepresult_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"teststepresult_attachmentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststepresult_attachments"
],
"type": "string"
},
"attributes": {
"properties": {
"fileName": {
"example": "File Name",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"lid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepresult_attachmentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststepresult_attachments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepresult_attachmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"teststepresult_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"teststepresult_attachmentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"teststepresult_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId",
"type": "string"
},
"attributes": {
"properties": {
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"teststepsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyTestStepIndex",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyTestStepIndex",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"teststepsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyTestStepIndex",
"type": "string"
},
"attributes": {
"properties": {
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"teststepsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyTestStepIndex",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"teststepsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"teststeps"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyTestStepIndex",
"type": "string"
},
"attributes": {
"properties": {
"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"
}
},
"type": "object"
}
},
"type": "object"
},
"updateAvatarRequestBody": {
"properties": {
"content": {
"description": "avatar content",
"format": "binary",
"type": "string"
}
},
"title": "UpdateAvatarRequestBody",
"type": "object"
},
"usergroupsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"usergroups"
],
"type": "string"
},
"id": {
"example": "MyUserGroupId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/usergroups/MyUserGroupId",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usersListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"users"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"usersListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"users"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
}
},
"required": [
"id"
],
"type": "object"
},
"relationships": {
"properties": {
"globalRoles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyRoleId",
"type": "string"
},
"type": {
"enum": [
"globalroles"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"projectRoles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyRoleId",
"type": "string"
},
"type": {
"enum": [
"projectroles"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"userGroups": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserGroupId",
"type": "string"
},
"type": {
"enum": [
"usergroups"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"usersListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"users"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/users/MyUserId",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"usersSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"users"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"items": {
"type": "object"
},
"type": "array"
},
"links": {
"properties": {
"self": {
"example": "server-host-name/application-path/users/MyUserId",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usersSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"users"
],
"type": "string"
},
"id": {
"example": "MyUserId",
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"initials": {
"example": "Initials",
"type": "string"
},
"name": {
"example": "Name",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"globalRoles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyRoleId",
"type": "string"
},
"type": {
"enum": [
"globalroles"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"projectRoles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyRoleId",
"type": "string"
},
"type": {
"enum": [
"projectroles"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"userGroups": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserGroupId",
"type": "string"
},
"type": {
"enum": [
"usergroups"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"workflowActionsActionResponseBody": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "0",
"type": "string"
},
"available": {
"type": "boolean"
},
"clearedFields": {
"items": {
"type": "string"
},
"type": "array"
},
"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"
},
"workitem_approvalsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyUserId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_approvalsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyUserId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"waiting",
"approved",
"disapproved"
],
"example": "waiting",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitem_approvalsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyUserId",
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"waiting",
"approved",
"disapproved"
],
"example": "waiting",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_approvalsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"waiting",
"approved",
"disapproved"
],
"example": "waiting",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"user": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_approvalsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_approvalsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyUserId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"waiting",
"approved",
"disapproved"
],
"example": "waiting",
"type": "string"
}
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitem_approvalsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitem_approvals"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyUserId",
"type": "string"
},
"attributes": {
"properties": {
"status": {
"enum": [
"waiting",
"approved",
"disapproved"
],
"example": "waiting",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"workitem_attachmentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitem_attachmentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_attachments"
],
"type": "string"
},
"attributes": {
"properties": {
"fileName": {
"example": "File Name",
"type": "string"
},
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
},
"lid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_attachmentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_attachments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_attachmentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitem_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyAttachmentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitem_attachmentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitem_attachments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyAttachmentId",
"type": "string"
},
"attributes": {
"properties": {
"title": {
"example": "Title",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"workitem_commentsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitem_commentsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_comments"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"relationships": {
"properties": {
"author": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"parentComment": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MyWorkItemId/MyCommentId",
"type": "string"
},
"type": {
"enum": [
"workitem_comments"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_commentsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitem_comments"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitem_commentsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitem_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyCommentId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitem_commentsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitem_comments"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyCommentId",
"type": "string"
},
"attributes": {
"properties": {
"resolved": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"workitemsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitemsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitemsListPatchRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"initialEstimate": {
"example": "5 1/2d",
"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": "object"
},
"relationships": {
"properties": {
"assignee": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyCategoryId",
"type": "string"
},
"type": {
"enum": [
"categories"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedRevisions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "default/1234",
"type": "string"
},
"type": {
"enum": [
"revisions"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"votes": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"watches": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitemsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"initialEstimate": {
"example": "5 1/2d",
"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"
}
},
"required": [
"type"
],
"type": "object"
},
"relationships": {
"properties": {
"assignee": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"author": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyCategoryId",
"type": "string"
},
"type": {
"enum": [
"categories"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedRevisions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "default/1234",
"type": "string"
},
"type": {
"enum": [
"revisions"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"module": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyProjectId/MySpaceId/MyDocumentId",
"type": "string"
},
"type": {
"enum": [
"documents"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitemsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"workitemsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workitemsSinglePatchRequest": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workitems"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId",
"type": "string"
},
"attributes": {
"properties": {
"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"
},
"initialEstimate": {
"example": "5 1/2d",
"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": "object"
},
"relationships": {
"properties": {
"assignee": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyProjectId/MyCategoryId",
"type": "string"
},
"type": {
"enum": [
"categories"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"linkedRevisions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "default/1234",
"type": "string"
},
"type": {
"enum": [
"revisions"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"votes": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"watches": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"workrecordsListDeleteRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workrecords"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyWorkRecordId",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workrecordsListGetResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workrecords"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyWorkRecordId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"type": "array"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
},
"workrecordsListPostRequest": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workrecords"
],
"type": "string"
},
"attributes": {
"properties": {
"comment": {
"example": "Comment",
"type": "string"
},
"date": {
"example": "1970-01-01",
"format": "date",
"type": "string"
},
"timeSpent": {
"example": "5 1/2d",
"type": "string"
},
"type": {
"example": "task",
"type": "string"
}
},
"type": "object"
},
"relationships": {
"properties": {
"user": {
"properties": {
"data": {
"properties": {
"id": {
"example": "MyUserId",
"type": "string"
},
"type": {
"enum": [
"users"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"workrecordsListPostResponse": {
"properties": {
"data": {
"items": {
"properties": {
"type": {
"enum": [
"workrecords"
],
"type": "string"
},
"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": "object"
},
"type": "array"
}
},
"type": "object"
},
"workrecordsSingleGetResponse": {
"properties": {
"data": {
"properties": {
"type": {
"enum": [
"workrecords"
],
"type": "string"
},
"id": {
"example": "MyProjectId/MyWorkItemId/MyWorkRecordId",
"type": "string"
},
"revision": {
"example": "1234",
"type": "string"
},
"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"
},
"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"
},
"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"
}
},
"type": "object"
},
"included": {
"description": "Related entities might be returned, see REST API User Guide.",
"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"
}
}
}