{
"openapi" : "3.0.1",
"info" : {
"title" : "Polarion REST API",
"description" : "About
The Polarion REST API lets you interact with Polarion programmatically. Use this API to integrate Polarion with your applications. This page documents the REST resources, including the HTTP response codes and example requests and responses.
For a detailed description of the REST API and how to use it, see the REST API User Guide (available on Support Center).",
"contact" : {
"name" : "Polarion REST API Support",
"url" : "https://support.sw.siemens.com/"
},
"license" : {
"name" : "Apache 2.0",
"url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version" : "v1"
},
"servers" : [ {
"url" : "https://testdrive.polarion.com/polarion/rest/v1"
} ],
"security" : [ {
"bearerAuth" : [ ]
} ],
"paths" : {
"/projects/{projectId}/workitems/{workItemId}/backlinkedworkitems" : {
"get" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Returns a list of Backlinked Work Items.",
"description" : "Returns the incoming links from other Work Items (also known as backlinks). Does not pertain to External links.",
"operationId" : "getBacklinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Creates a list of Backlinked Work Items.",
"description" : "Creates incoming links from other Work Items (backlinks). Does not pertain to External links.",
"operationId" : "postBacklinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/backlinkedworkitemsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections/{collectionId}/actions/close" : {
"post" : {
"tags" : [ "Collections" ],
"summary" : "Closes the specified Collection.",
"operationId" : "closeCollection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections/{collectionId}" : {
"get" : {
"tags" : [ "Collections" ],
"summary" : "Returns the specified Collection.",
"operationId" : "getCollection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Collections" ],
"summary" : "Deletes the specified Collection.",
"operationId" : "deleteCollection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Collections" ],
"summary" : "Updates the specified Collection.",
"operationId" : "patchCollections",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Collection(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections" : {
"get" : {
"tags" : [ "Collections" ],
"summary" : "Returns a list of Collections.",
"operationId" : "getCollections",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Collections" ],
"summary" : "Creates a list of Collections.",
"operationId" : "postCollections",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Collection(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Collections" ],
"summary" : "Deletes a list of Collections.",
"operationId" : "deleteCollections",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Collection(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections/{collectionId}/relationships/{relationshipId}" : {
"get" : {
"tags" : [ "Collections" ],
"summary" : "Returns a list of Collection Relationships.",
"operationId" : "getCollectionsRelationship",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Collections" ],
"summary" : "Creates the specific Relationships for the Collections.",
"operationId" : "postCollectionsRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Document(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestWithRevisionBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Not Allowed"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Collections" ],
"summary" : "Removes the specific Relationship from the Collection.",
"operationId" : "deleteCollectionsRelationship",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/relationshipsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"405" : {
"description" : "Not Allowed"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Collections" ],
"summary" : "Updates a list of Collection Relationships.",
"operationId" : "patchCollectionsRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestWithRevisionBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections/{collectionId}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Collections" ],
"summary" : "Returns fields for the specified resource.",
"operationId" : "getFieldsMetadataForCollection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections/{collectionId}/actions/reopen" : {
"post" : {
"tags" : [ "Collections" ],
"summary" : "Reopens the specified Collection.",
"operationId" : "reopenCollection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/collections/{collectionId}/actions/reuse" : {
"post" : {
"tags" : [ "Collections" ],
"summary" : "Reuses the specified Collection.",
"operationId" : "reuseCollection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "collectionId",
"in" : "path",
"description" : "The Collection ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Reusing parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/reuseCollectionRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/collectionsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/enumerations/defaulticons/{iconId}" : {
"get" : {
"tags" : [ "Icons" ],
"summary" : "Returns the specified Icon from the default context.",
"operationId" : "getDefaultIcon",
"parameters" : [ {
"name" : "iconId",
"in" : "path",
"description" : "The Icon ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/enumerations/defaulticons" : {
"get" : {
"tags" : [ "Icons" ],
"summary" : "Returns a list of Icons from the default context.",
"operationId" : "getDefaultIcons",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}" : {
"get" : {
"tags" : [ "Document Attachments" ],
"summary" : "Returns the specified Document Attachment.",
"operationId" : "getDocumentAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_attachmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Document Attachments" ],
"summary" : "Updates the specified Document Attachment.",
"description" : "See more in the REST API User Guide.",
"operationId" : "patchDocumentAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PatchDocumentAttachmentsRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments/{attachmentId}/content" : {
"get" : {
"tags" : [ "Document Attachments" ],
"summary" : "Downloads the file content for a specified Document Attachment.",
"operationId" : "getDocumentAttachmentContent",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/attachments" : {
"get" : {
"tags" : [ "Document Attachments" ],
"summary" : "Returns a list of Document Attachments.",
"operationId" : "getDocumentAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_attachmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Document Attachments" ],
"summary" : "Creates a list of Document Attachments.",
"description" : "Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.",
"operationId" : "postDocumentItemAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostDocumentAttachmentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_attachmentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments/{commentId}" : {
"get" : {
"tags" : [ "Document Comments" ],
"summary" : "Returns the specified Document Comment.",
"operationId" : "getDocumentComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_commentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Document Comments" ],
"summary" : "Updates the specified Document Comment.",
"operationId" : "patchDocumentComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_commentsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/comments" : {
"get" : {
"tags" : [ "Document Comments" ],
"summary" : "Returns a list of Document Comments.",
"operationId" : "getDocumentComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_commentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Document Comments" ],
"summary" : "Creates a list of Document Comments.",
"operationId" : "postDocumentComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_commentsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_commentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts" : {
"get" : {
"tags" : [ "Document Parts" ],
"summary" : "Returns a list of Document Parts.",
"operationId" : "getDocumentParts",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_partsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Document Parts" ],
"summary" : "Creates a list of Document Parts.",
"operationId" : "postDocumentParts",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Document Part(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_partsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_partsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Document Parts" ],
"summary" : "Deletes a list of Document Parts.",
"operationId" : "deleteDocumentParts",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The list of Document Part IDs to delete.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_partsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}" : {
"get" : {
"tags" : [ "Document Parts" ],
"summary" : "Returns the specified Document Part.",
"operationId" : "getDocumentPart",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "partId",
"in" : "path",
"description" : "The Document Part ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/document_partsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/{partId}/actions/move" : {
"post" : {
"tags" : [ "Document Parts" ],
"summary" : "Moves a Work Item Document Part.",
"operationId" : "moveDocumentParts",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "partId",
"in" : "path",
"description" : "The Document Part ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "References for repositioning Work Item Document Part in the Document.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/moveDocumentPartRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/parts/actions/overwrite" : {
"post" : {
"tags" : [ "Document Parts" ],
"summary" : "Overwrites multiple Work Item Document Parts.",
"operationId" : "overwriteDocumentParts",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Parameters for overwriting multiple Work Item Document Parts.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/overwriteDocumentPartsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/overwriteDocumentPartsResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch" : {
"post" : {
"tags" : [ "Documents" ],
"summary" : "Creates a Branch of the Document.",
"operationId" : "branchDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Branching parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/branchDocumentRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy" : {
"post" : {
"tags" : [ "Documents" ],
"summary" : "Creates a copy of the Document.",
"operationId" : "copyDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Copy Document parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/copyDocumentRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns a list of available options for the requested field in the specified Document.",
"operationId" : "getAvailableEnumOptionsForDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fieldId",
"in" : "path",
"description" : "The Field ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumOptionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns a list of selected options for the requested field in the specified Document.",
"operationId" : "getCurrentEnumerationOptionsForDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fieldId",
"in" : "path",
"description" : "The Field ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumOptionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns the specified Document.",
"operationId" : "getDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Documents" ],
"summary" : "Updates the specified Document.",
"operationId" : "patchDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Document name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workflowAction",
"in" : "query",
"description" : "The Workflow Action.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Document body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns fields for the specified resource.",
"operationId" : "getFieldsMetadataForDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Branch Document Name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns a list of Documents from a given Project Space.",
"operationId" : "getSpaceDocuments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Documents" ],
"summary" : "Creates a list of Documents.",
"operationId" : "postDocuments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Document body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/actions/importWordDocument" : {
"post" : {
"tags" : [ "Documents" ],
"summary" : "Imports a Word document to create a new Polarion Document.",
"operationId" : "importWordDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Multipart form data with 'file' (binary .docx) and 'parameters' (JSON object with documentName, title, documentType, and optional configurationId).",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/importWordDocumentRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeFromMaster" : {
"post" : {
"tags" : [ "Documents" ],
"summary" : "Merges Master Work Item changes to the specified Branched Document.",
"operationId" : "mergeDocumentFromMaster",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Branch Document Name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Merge Document parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/mergeDocumentRequestBody"
}
}
}
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeToMaster" : {
"post" : {
"tags" : [ "Documents" ],
"summary" : "Merges Work Item changes from specified Branched Document to Master.",
"operationId" : "mergeDocumentToMaster",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "documentName",
"in" : "path",
"description" : "The Branch Document Name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Merge Document parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/mergeDocumentRequestBody"
}
}
}
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns a list of available options for the requested field for the specified Document type.",
"operationId" : "getAvailableEnumOptionsForDocumentType",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fieldId",
"in" : "path",
"description" : "The Field ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "type",
"in" : "query",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumOptionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems/{roleId}/{hostname}/{targetProjectId}/{linkedWorkItemId}" : {
"get" : {
"tags" : [ "Externally Linked Work Items" ],
"summary" : "Returns the specified Externally Linked Work Item.",
"description" : "Returns the external links to other Work Items. (The same as the corresponding Java API method.)",
"operationId" : "getExternallyLinkedWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "roleId",
"in" : "path",
"description" : "The Role ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "hostname",
"in" : "path",
"description" : "The Target Hostname.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetProjectId",
"in" : "path",
"description" : "The Target Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "linkedWorkItemId",
"in" : "path",
"description" : "The Linked Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/externallylinkedworkitemsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Externally Linked Work Items" ],
"summary" : "Deletes the specified Externally Linked Work Item.",
"operationId" : "deleteExternallyLinkedWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "roleId",
"in" : "path",
"description" : "The Role ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "hostname",
"in" : "path",
"description" : "The Target Hostname.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetProjectId",
"in" : "path",
"description" : "The Target Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "linkedWorkItemId",
"in" : "path",
"description" : "The Linked Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/externallylinkedworkitems" : {
"get" : {
"tags" : [ "Externally Linked Work Items" ],
"summary" : "Returns a list of Externally Linked Work Items.",
"description" : "Returns the external links to other Work Items. (The same as the corresponding Java API method.)",
"operationId" : "getExternallyLinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/externallylinkedworkitemsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Externally Linked Work Items" ],
"summary" : "Creates a list of Externally Linked Work Items.",
"operationId" : "postExternallyLinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Externally Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/externallylinkedworkitemsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/externallylinkedworkitemsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Externally Linked Work Items" ],
"summary" : "Deletes a list of Externally Linked Work Items.",
"operationId" : "deleteExternallyLinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/externallylinkedworkitemsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/featureselections/{selectionTypeId}/{targetProjectId}/{targetWorkItemId}" : {
"get" : {
"tags" : [ "Feature Selections" ],
"summary" : "Returns the specified Feature Selection.",
"operationId" : "getFeatureSelection",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "selectionTypeId",
"in" : "path",
"description" : "The Selection Type ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetProjectId",
"in" : "path",
"description" : "The Target Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetWorkItemId",
"in" : "path",
"description" : "The Target Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/featureselectionsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/featureselections" : {
"get" : {
"tags" : [ "Feature Selections" ],
"summary" : "Returns a list of Feature Selections.",
"operationId" : "getFeatureSelections",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/featureselectionsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Metadata" ],
"summary" : "Returns fields for the resource type and its target type in the Project context.",
"operationId" : "getProjectFieldsMetadata",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "resourceType",
"in" : "query",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "query",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/customfields/{resourceType}/{targetType}" : {
"get" : {
"tags" : [ "Custom Fields" ],
"summary" : "Returns the defined Custom Fields for the resource type and target type in the Global context.",
"operationId" : "getGlobalCustomFields",
"parameters" : [ {
"name" : "resourceType",
"in" : "path",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Custom Fields" ],
"summary" : "Deletes the specified Custom Field configuration from the Global context.",
"operationId" : "deleteGlobalCustomFields",
"parameters" : [ {
"name" : "resourceType",
"in" : "path",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Custom Fields" ],
"summary" : "Updates the specified Custom Fields in the Global context.",
"operationId" : "patchGlobalCustomFields",
"parameters" : [ {
"name" : "resourceType",
"in" : "path",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Custom Field target type. (Use '~' when there is no specific type for the Prototype.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Custom Fields Body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/customfields" : {
"post" : {
"tags" : [ "Custom Fields" ],
"summary" : "Creates a list of Custom Fields in the Global context.",
"operationId" : "postGlobalCustomFields",
"requestBody" : {
"description" : "Custom Fields Body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/all/documents/actions/branch" : {
"post" : {
"tags" : [ "Documents" ],
"summary" : "Creates Branches of Documents.",
"operationId" : "branchDocuments",
"requestBody" : {
"description" : "Branching parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/branchDocumentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/all/documents" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns a list of Documents from all Projects.",
"operationId" : "getAllDocuments",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/enumerations/{enumContext}/{enumName}/{targetType}" : {
"get" : {
"tags" : [ "Enumerations" ],
"summary" : "Returns the specified Enumeration from the Global context.",
"operationId" : "getGlobalEnumeration",
"parameters" : [ {
"name" : "enumContext",
"in" : "path",
"description" : "The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumName",
"in" : "path",
"description" : "The Enumeration Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Enumerations" ],
"summary" : "Deletes the specified Enumeration from the Global context.",
"operationId" : "deleteGlobalEnumeration",
"parameters" : [ {
"name" : "enumContext",
"in" : "path",
"description" : "The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumName",
"in" : "path",
"description" : "The Enumeration Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Enumerations" ],
"summary" : "Updates the specified Enumeration in the Global context.",
"operationId" : "patchGlobalEnumeration",
"parameters" : [ {
"name" : "enumContext",
"in" : "path",
"description" : "The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumName",
"in" : "path",
"description" : "The Enumeration Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Enumeration(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/enumerations" : {
"get" : {
"tags" : [ "Enumerations" ],
"summary" : "Returns a list of Enumerations from the Global context.",
"operationId" : "getGlobalEnumerations",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Enumerations" ],
"summary" : "Creates a list of Enumerations in the Global context.",
"operationId" : "postGlobalEnumeration",
"requestBody" : {
"description" : "The Enumeration(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Metadata" ],
"summary" : "Returns fields for the resource type and its target type in the Global context.",
"operationId" : "getGlobalFieldsMetadata",
"parameters" : [ {
"name" : "resourceType",
"in" : "query",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "query",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/enumerations/icons/{iconId}" : {
"get" : {
"tags" : [ "Icons" ],
"summary" : "Returns the specified Icon from the Global context.",
"operationId" : "getGlobalIcon",
"parameters" : [ {
"name" : "iconId",
"in" : "path",
"description" : "The Icon ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/enumerations/icons" : {
"get" : {
"tags" : [ "Icons" ],
"summary" : "Returns a list of Icons from the Global context.",
"operationId" : "getGlobalIcons",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Icons" ],
"summary" : "Creates a list of Icons in the Global context.",
"description" : "Icons are identified by order",
"operationId" : "postGlobalIcons",
"requestBody" : {
"description" : "Icon meta data and file data",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostIconsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/metadata" : {
"get" : {
"tags" : [ "Metadata" ],
"summary" : "Returns global metadata, including version, build, REST API configuration properties, etc. (Available to all REST API users.)",
"operationId" : "getMetadata",
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/metadataSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/all/pages" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns a list of Pages from all Projects and Pages on the Repository level.",
"operationId" : "getAllPages",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/pages" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns a list of all Pages on the Repository level.",
"operationId" : "getGlobalPages",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/spaces/{spaceId}/pages" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns a list of Pages in a given Space on the Repository level.",
"operationId" : "getRepositorySpacePages",
"parameters" : [ {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/roles/{roleId}" : {
"get" : {
"tags" : [ "Roles" ],
"summary" : "Returns the specified Global Role.",
"operationId" : "getRole",
"parameters" : [ {
"name" : "roleId",
"in" : "path",
"description" : "The Role ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/globalrolesSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/all/workitems" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of Work Items from all Projects.",
"operationId" : "getAllWorkItems",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Items" ],
"summary" : "Deletes a list of Work Items from the Global context.",
"operationId" : "deleteAllWorkItems",
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Items" ],
"summary" : "Updates a list of Work Items in the Global context.",
"operationId" : "patchAllWorkItems",
"parameters" : [ {
"name" : "workflowAction",
"in" : "query",
"description" : "The Workflow Action.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/jobs/actions/execute" : {
"post" : {
"tags" : [ "Jobs" ],
"summary" : "Executes a Job.",
"operationId" : "executeJob",
"requestBody" : {
"description" : "Execute Job parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/executeJobRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/jobs/{jobId}" : {
"get" : {
"tags" : [ "Jobs" ],
"summary" : "Returns the specified Job.",
"operationId" : "getJob",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The Job ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/jobs/{jobId}/log/content" : {
"get" : {
"tags" : [ "Jobs" ],
"summary" : "Downloads the Log content for a specified job.",
"operationId" : "getJobLogContent",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The Job ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"text/plain" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/jobs/{jobId}/actions/download/{filename}" : {
"get" : {
"tags" : [ "Jobs" ],
"summary" : "Downloads the file content for a specified job.",
"operationId" : "getJobResultFileContent",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The Job ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "filename",
"in" : "path",
"description" : "The Download File Name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/jobs" : {
"get" : {
"tags" : [ "Jobs" ],
"summary" : "Returns the list of Jobs.",
"operationId" : "getJobs",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "projectId",
"in" : "query",
"description" : "The Project ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/license/assignments" : {
"get" : {
"tags" : [ "License" ],
"summary" : "Returns a list of License Assignments. (Not supported by cloud-based Polarion X.)",
"operationId" : "getLicenseAssignments",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "activeOnly",
"in" : "query",
"description" : "If set to true, only active (with status LOGGED_IN or EXPIRING) License Assignments will be returned, otherwise all the License Assignments will be returned.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_assignmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "License" ],
"summary" : "Updates the License Assignments of multiple users. (Not supported by cloud-based Polarion X.)",
"operationId" : "patchLicenseAssignments",
"requestBody" : {
"description" : "The User(s) License Assignment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_assignmentsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "The request was processed, but some user License Assignments could not be changed because they are locked or because of license slot limits. See the errors array in the response for details about each failure."
},
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/license/assignments/{userId}" : {
"get" : {
"tags" : [ "License" ],
"summary" : "Returns the specified License Assignment. (Not supported by cloud-based Polarion X.)",
"operationId" : "getLicenseAssignmentsForUser",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_assignmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "License" ],
"summary" : "Updates a user's License Assignment. (Not supported by cloud-based Polarion X.)",
"operationId" : "patchLicenseAssignment",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The User License Assignment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_assignmentsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/license" : {
"get" : {
"tags" : [ "License" ],
"summary" : "Returns information on the available License Limits.",
"operationId" : "getLicense",
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/licenseSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "License" ],
"summary" : "Updates the product License. (Not supported by cloud-based Polarion X.)",
"operationId" : "patchLicense",
"requestBody" : {
"description" : "The License body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/licenseSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/license/types/{typeId}/slots" : {
"get" : {
"tags" : [ "License" ],
"summary" : "Returns information on the available License Slots. (Not supported by cloud-based Polarion X.)",
"operationId" : "getLicenseSlots",
"parameters" : [ {
"name" : "typeId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_slotsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "License" ],
"summary" : "Creates a list of group License Slots. (Not supported by cloud-based Polarion X.)",
"operationId" : "postLicenseSlots",
"parameters" : [ {
"name" : "typeId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "License Slots body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_slotsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_slotsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "License" ],
"summary" : "Deletes a list of Group license slots. (Not supported by cloud-based Polarion X.)",
"operationId" : "deleteLicenseSlots",
"parameters" : [ {
"name" : "typeId",
"in" : "path",
"description" : "License type.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "No Content",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_slotsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/license/types/{typeId}/slots/{model}/{group}" : {
"get" : {
"tags" : [ "License" ],
"summary" : "Returns the specified License Slot. (Not supported by cloud-based Polarion X.)",
"operationId" : "getLicenseSlot",
"parameters" : [ {
"name" : "typeId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "model",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "group",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/license_slotsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden (insufficient permissions or Polarion X environment)"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/linkedoslcresources" : {
"get" : {
"tags" : [ "Linked Oslc Resources" ],
"summary" : "Returns a list of instances.",
"operationId" : "getOslcResources",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedoslcresourcesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Linked Oslc Resources" ],
"summary" : "Creates a list of instances.",
"operationId" : "postOslcResources",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Oslc Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedoslcresourcesListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedoslcresourcesListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Linked Oslc Resources" ],
"summary" : "Deletes a list of instances.",
"operationId" : "deleteOslcResources",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Oslc Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedoslcresourcesListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/linkedworkitems/{roleId}/{targetProjectId}/{linkedWorkItemId}" : {
"get" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Returns the specified Linked Work Item.",
"description" : "Returns the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.",
"operationId" : "getLinkedWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "roleId",
"in" : "path",
"description" : "The Role ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetProjectId",
"in" : "path",
"description" : "The Target Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "linkedWorkItemId",
"in" : "path",
"description" : "The Linked Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Deletes the specified Linked Work Item.",
"description" : "Deletes the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.",
"operationId" : "deleteLinkedWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "roleId",
"in" : "path",
"description" : "The Role ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetProjectId",
"in" : "path",
"description" : "The Target Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "linkedWorkItemId",
"in" : "path",
"description" : "The Linked Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Updates the specified Linked Work Item.",
"description" : "Updates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.",
"operationId" : "patchLinkedWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "roleId",
"in" : "path",
"description" : "The Role ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetProjectId",
"in" : "path",
"description" : "The Target Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "linkedWorkItemId",
"in" : "path",
"description" : "The Linked Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/linkedworkitems" : {
"get" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Returns a list of Linked Work Items.",
"description" : "Returns the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.",
"operationId" : "getLinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Creates a list of Linked Work Items.",
"description" : "Creates the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.",
"operationId" : "postLinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Linked Work Items" ],
"summary" : "Deletes a list of Linked Work Items.",
"description" : "Deletes the direct outgoing links to other Work Items. (The same as the corresponding Java API method.) Does not pertain to external links or backlinks.",
"operationId" : "deleteLinkedWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/linkedworkitemsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/llms/actions/generateCompletion" : {
"post" : {
"tags" : [ "AI" ],
"summary" : "Generates a chat completion using a Large Language Model (LLM).",
"operationId" : "generateCompletion",
"requestBody" : {
"description" : "Generate completion parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/generateCompletionRequestBody"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/generateCompletionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/llms" : {
"get" : {
"tags" : [ "AI" ],
"summary" : "Returns a list of Large Language Models (LLMs).",
"operationId" : "getLlms",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/llmsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/plans/{planId}" : {
"get" : {
"tags" : [ "Plans" ],
"summary" : "Returns the specified Plan.",
"operationId" : "getPlan",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/plansSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Plans" ],
"summary" : "Deletes the specified Plan.",
"operationId" : "deletePlan",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Plans" ],
"summary" : "Updates the specified Plan.",
"operationId" : "patchPlan",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Plan body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/plansSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/plans/{planId}/relationships/{relationshipId}" : {
"get" : {
"tags" : [ "Plans" ],
"summary" : "Returns a list of Plan Relationships.",
"operationId" : "getPlanRelationship",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Plans" ],
"summary" : "Creates the specific Relationships for the Plan.",
"operationId" : "postPlanRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Not Allowed"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Plans" ],
"summary" : "Removes the specific Relationship from the Plan.",
"operationId" : "deletePlanRelationship",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/relationshipsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"405" : {
"description" : "Not Allowed"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Plans" ],
"summary" : "Updates a list of Plan Relationships.",
"operationId" : "patchPlanRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/plans" : {
"get" : {
"tags" : [ "Plans" ],
"summary" : "Returns a list of Plans.",
"operationId" : "getPlans",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
}, {
"name" : "templates",
"in" : "query",
"description" : "If set to true, only templates will be returned, otherwise only actual instances will be returned.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/plansListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Plans" ],
"summary" : "Creates a list of Plans.",
"operationId" : "postPlans",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Plan(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/plansListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/plansListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Plans" ],
"summary" : "Deletes a list of Plans.",
"operationId" : "deletePlans",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Plan(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/plansListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/plans/{planId}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Plans" ],
"summary" : "Returns fields for the specified resource.",
"operationId" : "getFieldsMetadataForPlan",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "The Plan ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/customfields/{resourceType}/{targetType}" : {
"get" : {
"tags" : [ "Custom Fields" ],
"summary" : "Returns the defined Custom Fields for the resource type and target type in the Project context.",
"operationId" : "getProjectCustomFields",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "resourceType",
"in" : "path",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Custom Fields" ],
"summary" : "Deletes the specified Custom Field configuration from the Project context.",
"operationId" : "deleteProjectCustomFields",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "resourceType",
"in" : "path",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Custom Fields" ],
"summary" : "Updates the specified Custom Fields in the Project context.",
"operationId" : "patchCustomField",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "resourceType",
"in" : "path",
"description" : "The Resource Type.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Custom Field target type. (Use '~' when there is no specific type for the Prototype.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Custom Fields Body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/customfields" : {
"post" : {
"tags" : [ "Custom Fields" ],
"summary" : "Creates a list of Custom Fields in the Project context.",
"operationId" : "postProjectCustomFields",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Custom Fields Body",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/customfieldsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/documents" : {
"get" : {
"tags" : [ "Documents" ],
"summary" : "Returns a list of Documents from the Project context.",
"operationId" : "getDocuments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/documentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}" : {
"get" : {
"tags" : [ "Enumerations" ],
"summary" : "Returns the specified Enumeration from the Project context.",
"operationId" : "getProjectEnumeration",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumContext",
"in" : "path",
"description" : "The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumName",
"in" : "path",
"description" : "The Enumeration Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Enumerations" ],
"summary" : "Deletes the specified Enumeration from the Project context.",
"operationId" : "deleteProjectEnumeration",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumContext",
"in" : "path",
"description" : "The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumName",
"in" : "path",
"description" : "The Enumeration Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Enumerations" ],
"summary" : "Updates the specified Enumeration in the Project context.",
"operationId" : "patchProjectEnumeration",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumContext",
"in" : "path",
"description" : "The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "enumName",
"in" : "path",
"description" : "The Enumeration Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "targetType",
"in" : "path",
"description" : "The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Enumeration(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/enumerations" : {
"get" : {
"tags" : [ "Enumerations" ],
"summary" : "Returns a list of Enumerations from the Project context.",
"operationId" : "getProjectEnumerations",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Enumerations" ],
"summary" : "Creates a list of Enumerations in the Project context.",
"operationId" : "postProjectEnumeration",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Enumeration(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumerationsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/enumerations/icons/{iconId}" : {
"get" : {
"tags" : [ "Icons" ],
"summary" : "Returns the specified Icon from the Project context.",
"operationId" : "getProjectIcon",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iconId",
"in" : "path",
"description" : "The Icon ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/enumerations/icons" : {
"get" : {
"tags" : [ "Icons" ],
"summary" : "Returns a list of Icons from the Project context.",
"operationId" : "getProjectIcons",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Icons" ],
"summary" : "Creates a list of Icons in the Project context.",
"description" : "Icons are identified by order",
"operationId" : "postProjectIcons",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Icon meta data and file data",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostIconsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/iconsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns the specified Page.",
"operationId" : "getPage",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Pages" ],
"summary" : "Deletes the specified Page.",
"operationId" : "deletePage",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Pages" ],
"summary" : "Updates the specified Page.",
"operationId" : "patchRichPage",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Page body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/relationships/{relationshipId}" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns a list of Page Relationships.",
"operationId" : "getPageRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Pages" ],
"summary" : "Creates a list of Rich Page Relationships.",
"operationId" : "postPageRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"405" : {
"description" : "Not Allowed"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Pages" ],
"summary" : "Deletes a list of Page Relationships.",
"operationId" : "deletePageRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/relationshipsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"405" : {
"description" : "Not Allowed"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Pages" ],
"summary" : "Updates a list of Page Relationships.",
"operationId" : "patchPageRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/pages" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns a list of Pages from the Project context.",
"operationId" : "getPages",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages" : {
"get" : {
"tags" : [ "Pages" ],
"summary" : "Returns a list of Pages from a given Project Space.",
"operationId" : "getSpacePages",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Pages" ],
"summary" : "Creates a list of Pages.",
"operationId" : "postPages",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Page(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/pagesListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projecttemplates" : {
"get" : {
"tags" : [ "Project Templates" ],
"summary" : "Returns a list of Project Templates.",
"operationId" : "getProjectTemplates",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/projecttemplatesListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/actions/createProject" : {
"post" : {
"tags" : [ "Projects" ],
"summary" : "Creates a new Project",
"operationId" : "createProject",
"requestBody" : {
"description" : "Create project parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/createProjectRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}" : {
"get" : {
"tags" : [ "Projects" ],
"summary" : "Returns the specified Project.",
"operationId" : "getProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/projectsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Projects" ],
"summary" : "Deletes the specified Project.",
"operationId" : "deleteProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"401" : {
"description" : "Unauthorized"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Projects" ],
"summary" : "Updates the specified Project.",
"operationId" : "patchProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Project body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/projectsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testparameterdefinitions/{testParamId}" : {
"get" : {
"tags" : [ "Projects" ],
"summary" : "Returns the specified Test Parameter Definition for the specified Project.",
"operationId" : "getProjectTestParameterDefinition",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Projects" ],
"summary" : "Deletes the specified Test Parameter Definition for the specified Project.",
"operationId" : "deleteProjectTestParameterDefinition",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testparameterdefinitions" : {
"get" : {
"tags" : [ "Projects" ],
"summary" : "Returns a list of Test Parameter Definitions for the specified Project.",
"operationId" : "getProjectTestParameterDefinitions",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Projects" ],
"summary" : "Creates a list of Test Parameter Definitions for the specified Project.",
"operationId" : "postProjectTestParameterDefinitions",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Parameter Definition(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Projects" ],
"summary" : "Deletes a list of Test Parameter Definitions for the specified Project.",
"operationId" : "deleteProjectTestParameterDefinitions",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Parameter Definition(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects" : {
"get" : {
"tags" : [ "Projects" ],
"summary" : "Returns a list of Projects.",
"operationId" : "getProjects",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/projectsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/actions/markProject" : {
"post" : {
"tags" : [ "Projects" ],
"summary" : "Marks the Project.",
"operationId" : "markProject",
"requestBody" : {
"description" : "Create project parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/createProjectRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/actions/moveProject" : {
"post" : {
"tags" : [ "Projects" ],
"summary" : "Moves project to a different location",
"operationId" : "moveProjectAction",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Move project parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/moveProjectRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/actions/unmarkProject" : {
"post" : {
"tags" : [ "Projects" ],
"summary" : "Unmarks the Project.",
"operationId" : "unmarkProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"401" : {
"description" : "Unauthorized"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/revisions/{repositoryName}/{revision}" : {
"get" : {
"tags" : [ "Revisions" ],
"summary" : "Returns the specified instance.",
"operationId" : "getRevision",
"parameters" : [ {
"name" : "repositoryName",
"in" : "path",
"description" : "The Repository Name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "path",
"description" : "The revision ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/revisionsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/revisions" : {
"get" : {
"tags" : [ "Revisions" ],
"summary" : "Returns a list of instances.",
"operationId" : "getRevisions",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/revisionsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}" : {
"get" : {
"tags" : [ "Page Attachments" ],
"summary" : "Returns the specified Page Attachment.",
"operationId" : "getPageAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_attachmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Page Attachments" ],
"summary" : "Deletes the specified Page Attachment.",
"operationId" : "deletePageAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Page Attachments" ],
"summary" : "Updates the specified Page Attachment.",
"description" : "See more in the REST API User Guide.",
"operationId" : "patchPageAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PatchPageAttachmentsRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments/{attachmentId}/content" : {
"get" : {
"tags" : [ "Page Attachments" ],
"summary" : "Downloads the file content for a specified Page Attachment.",
"operationId" : "getPageAttachmentContent",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/attachments" : {
"get" : {
"tags" : [ "Page Attachments" ],
"summary" : "Returns a list of Page Attachments.",
"operationId" : "getPageAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_attachmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Page Attachments" ],
"summary" : "Creates a list of Page Attachments.",
"description" : "Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.",
"operationId" : "postPageAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostPageAttachmentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_attachmentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/comments/{commentId}" : {
"get" : {
"tags" : [ "Page Comments" ],
"summary" : "Returns the specified Page Comment.",
"operationId" : "getPageComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_commentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Page Comments" ],
"summary" : "Updates the specified Page Comment.",
"operationId" : "patchPageComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_commentsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/spaces/{spaceId}/pages/{pageName}/comments" : {
"get" : {
"tags" : [ "Page Comments" ],
"summary" : "Returns a list of Page Comments.",
"operationId" : "getPageComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_commentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Page Comments" ],
"summary" : "Creates a list of Page Comments.",
"operationId" : "postPageComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "spaceId",
"in" : "path",
"description" : "The Space ID. (Use '_default' without quotes to address the default Space.)",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "pageName",
"in" : "path",
"description" : "The Page name.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_commentsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/page_commentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}" : {
"get" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Returns the specified Test Record Attachment.",
"operationId" : "getTestRecordAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecord_attachmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Deletes the specified Test Record Attachment.",
"operationId" : "deleteTestRecordAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Updates the specified Test Record Attachment.",
"description" : "See more in the REST API User Guide.",
"operationId" : "patchTestRecordAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PatchTestRecordAttachmentsRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments" : {
"get" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Returns a list of Test Record Attachments.",
"operationId" : "getTestRecordAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecord_attachmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Creates a list of Test Record Attachments.",
"description" : "Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.",
"operationId" : "postTestRecordAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostTestRecordAttachmentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecord_attachmentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Deletes a list of Test Record Attachments.",
"operationId" : "deleteTestRecordAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Record Attachment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecord_attachmentsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/attachments/{attachmentId}/content" : {
"get" : {
"tags" : [ "Test Record Attachments" ],
"summary" : "Downloads the file content for a specified Test Record Attachment.",
"operationId" : "getTestRecordAttachmentContent",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}" : {
"get" : {
"tags" : [ "Test Records" ],
"summary" : "Returns the specified Test Record.",
"operationId" : "getTestRecord",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecordsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Records" ],
"summary" : "Deletes the specified Test Record.",
"operationId" : "deleteTestRecord",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Records" ],
"summary" : "Updates the specified Test Record.",
"operationId" : "patchTestRecord",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Record(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecordsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters/{testParamId}" : {
"get" : {
"tags" : [ "Test Records" ],
"summary" : "Returns the specified Test Parameter for the specified Test Record.",
"operationId" : "getTestRecordTestParameter",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Records" ],
"summary" : "Deletes the specified Test Parameter for the specified Test Record.",
"operationId" : "deleteTestRecordTestParameter",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Test Records" ],
"summary" : "Returns fields for the specified resource.",
"operationId" : "getFieldsMetadataForTestRecord",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/testparameters" : {
"get" : {
"tags" : [ "Test Records" ],
"summary" : "Returns a list of Test Parameters for the specified Test Record.",
"operationId" : "getTestRecordTestParameters",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Records" ],
"summary" : "Creates a list of Test Parameters for the specified Test Record.",
"operationId" : "postTestRecordTestParameters",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Parameter(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords" : {
"get" : {
"tags" : [ "Test Records" ],
"summary" : "Returns a list of Test Records.",
"operationId" : "getTestRecords",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "query",
"description" : "testCaseProjectId",
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "query",
"description" : "testCaseId",
"schema" : {
"type" : "string"
}
}, {
"name" : "testResultId",
"in" : "query",
"description" : "testResultId",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecordsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Records" ],
"summary" : "Creates a list of Test Records.",
"operationId" : "postTestRecords",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Record(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecordsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecordsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Records" ],
"summary" : "Updates a list of Test Records.",
"operationId" : "patchTestRecords",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Record(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrecordsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}" : {
"get" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Returns the specified Test Run Attachment.",
"operationId" : "getTestRunAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_attachmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Deletes the specified Test Run Attachment.",
"operationId" : "deleteTestRunAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Updates the specified Test Run Attachment.",
"description" : "See more in the REST API User Guide.",
"operationId" : "patchTestRunAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PatchTestRunAttachmentsRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/attachments" : {
"get" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Returns a list of Test Run Attachments.",
"operationId" : "getTestRunAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_attachmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Creates a list of Test Run Attachments.",
"description" : "Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.",
"operationId" : "postTestRunAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostTestRunAttachmentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_attachmentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Deletes a list of Test Run Attachments.",
"operationId" : "deleteTestRunAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run Attachment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_attachmentsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/attachments/{attachmentId}/content" : {
"get" : {
"tags" : [ "Test Run Attachments" ],
"summary" : "Downloads the file content for a specified Test Run Attachment.",
"operationId" : "getTestRunAttachmentContent",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/comments/{commentId}" : {
"get" : {
"tags" : [ "Test Run Comments" ],
"summary" : "Returns the specified Test Run Comment.",
"operationId" : "getTestRunComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_commentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Run Comments" ],
"summary" : "Updates the specified Test Run Comment.",
"operationId" : "patchTestRunComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_commentsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/comments" : {
"get" : {
"tags" : [ "Test Run Comments" ],
"summary" : "Returns a list of Test Run Comments.",
"operationId" : "getTestRunComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_commentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Run Comments" ],
"summary" : "Creates a list of Test Run Comments.",
"operationId" : "postTestRunComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_commentsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_commentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Run Comments" ],
"summary" : "Updates a list of Test Run Comments.",
"operationId" : "patchTestRunComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrun_commentsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns the specified Test Run.",
"operationId" : "getTestRun",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Runs" ],
"summary" : "Deletes the specified Test Run.",
"operationId" : "deleteTestRun",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Runs" ],
"summary" : "Updates the specified Test Run.",
"operationId" : "patchTestRun",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testparameters/{testParamId}" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns the specified Test Parameter for the specified Test Run.",
"operationId" : "getTestRunTestParameter",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Runs" ],
"summary" : "Deletes the specified Test Parameter for the specified Test Run.",
"operationId" : "deleteTestRunTestParameter",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions/{testParamId}" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns the specified Test Parameter Definition for the specified Test Run.",
"operationId" : "getTestRunTestParameterDefinition",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Runs" ],
"summary" : "Deletes the specified Test Parameter Definition for the specified Test Run.",
"operationId" : "deleteTestRunTestParameterDefinition",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testparameters" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns a list of Test Parameters for the specified Test Run.",
"operationId" : "getTestRunTestParameters",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Runs" ],
"summary" : "Creates a list of Test Parameters for the specified Test Run.",
"operationId" : "postTestRunTestParameters",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Parameter(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Runs" ],
"summary" : "Deletes a list of Test Parameters for the specified Test Run.",
"operationId" : "deleteTestRunTestParameters",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Parameter(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparametersListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns a list of Test Runs.",
"operationId" : "getTestRuns",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
}, {
"name" : "templates",
"in" : "query",
"description" : "If set to true, only templates will be returned, otherwise only actual instances will be returned.",
"schema" : {
"type" : "boolean"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Runs" ],
"summary" : "Creates a list of Test Runs.",
"operationId" : "postTestRuns",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Runs" ],
"summary" : "Deletes a list of Test Runs.",
"operationId" : "deleteTestRuns",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Runs" ],
"summary" : "Updates a list of Test Runs.",
"operationId" : "patchTestRuns",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testrunsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/actions/exportTestsToExcel" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Exports tests to Excel.",
"operationId" : "getExportExcelTests",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sortBy",
"in" : "query",
"description" : "The property to sort the test results.",
"schema" : {
"type" : "string"
}
}, {
"name" : "template",
"in" : "query",
"description" : "The export template string.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns fields for the specified resource.",
"operationId" : "getFieldsMetadataForTestRun",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testparameterdefinitions" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns a list of Test Parameter Definitions for the specified Test Run.",
"operationId" : "getTestRunTestParameterDefinitions",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Runs" ],
"summary" : "Creates a list of Test Parameter Definitions for the specified Test Run.",
"operationId" : "postTestRunParameterDefinitions",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Parameter Definition(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/actions/getWorkflowActions" : {
"get" : {
"tags" : [ "Test Runs" ],
"summary" : "Returns a list of Workflow Actions.",
"operationId" : "getWorkflowActionsForTestRun",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workflowActionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/actions/importExcelTestResults" : {
"post" : {
"tags" : [ "Test Runs" ],
"summary" : "Imports Excel test results.",
"operationId" : "importExcelTestResults",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Excel import meta data and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostImportActionRequestBody"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/actions/importXUnitTestResults" : {
"post" : {
"tags" : [ "Test Runs" ],
"summary" : "Imports XUnit test results.",
"operationId" : "importXUnitTestResults",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "XUnit File.",
"content" : {
"application/octet-stream" : {
"schema" : {
"type" : "object"
}
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Accepted",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/jobsSinglePostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}" : {
"get" : {
"tags" : [ "Test Step Results" ],
"summary" : "Returns the specified Test Step Result.",
"operationId" : "getTestStepResult",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststep_resultsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Step Results" ],
"summary" : "Updates the specified Test Step Result.",
"operationId" : "patchTestStepResult",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststep_resultsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults" : {
"get" : {
"tags" : [ "Test Step Results" ],
"summary" : "Returns a list of Test Step Results.",
"operationId" : "getTestStepResults",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststep_resultsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Step Results" ],
"summary" : "Creates a list of Test Step Results.",
"operationId" : "postTestStepResults",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step Result(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststep_resultsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststep_resultsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Step Results" ],
"summary" : "Updates a list of Test Step Results.",
"operationId" : "patchTestStepResults",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststep_resultsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/teststeps/{testStepIndex}" : {
"get" : {
"tags" : [ "Test Steps" ],
"summary" : "Returns the specified Test Step.",
"operationId" : "getTestStep",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Steps" ],
"summary" : "Deletes the specified Test Step.",
"operationId" : "deleteTestStep",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Steps" ],
"summary" : "Updates the specified Test Step.",
"operationId" : "patchTestStep",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/teststeps" : {
"get" : {
"tags" : [ "Test Steps" ],
"summary" : "Returns a list of Test Steps.",
"operationId" : "getTestSteps",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Steps" ],
"summary" : "Creates a list of Test Steps.",
"operationId" : "postTestSteps",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Steps" ],
"summary" : "Deletes a list of Test Steps.",
"operationId" : "deleteTestSteps",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Steps" ],
"summary" : "Updates a list of Test Steps.",
"operationId" : "patchTestSteps",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}" : {
"get" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Returns the specified Test Step Result Attachment for the specified Test Record.",
"operationId" : "getTestStepResultAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepresult_attachmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Deletes the specified Test Step Result Attachment.",
"operationId" : "deleteTestStepResultAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Updates the specified Test Step Result Attachment.",
"description" : "See more in the REST API User Guide.",
"operationId" : "patchTestStepResultAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PatchTestStepResultAttachmentsRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments" : {
"get" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Returns a list of Attachments for the specified Test Step Result.",
"operationId" : "getTestStepResultAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepresult_attachmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Creates a list of Test Step Result Attachments.",
"description" : "Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.",
"operationId" : "postTestStepResultAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostTestStepResultAttachmentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepresult_attachmentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Deletes a list of Test Step Result Attachments.",
"operationId" : "deleteTestStepResultAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Step Result Attachment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/teststepresult_attachmentsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/testruns/{testRunId}/testrecords/{testCaseProjectId}/{testCaseId}/{iteration}/teststepresults/{testStepIndex}/attachments/{attachmentId}/content" : {
"get" : {
"tags" : [ "Test Step Result Attachments" ],
"summary" : "Downloads the file content for a specified Test Step Result Attachment for the specified Test Record.",
"operationId" : "getTestStepResultAttachmentContent",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testRunId",
"in" : "path",
"description" : "The Test Run ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseProjectId",
"in" : "path",
"description" : "The Testcase Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testCaseId",
"in" : "path",
"description" : "The Testcase ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "iteration",
"in" : "path",
"description" : "The Iteration Number.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testStepIndex",
"in" : "path",
"description" : "The Test Step index.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/user" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "Returns the current User.",
"operationId" : "getCurrentUser",
"parameters" : [ {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usersSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/usergroups/{groupId}" : {
"get" : {
"tags" : [ "User Groups" ],
"summary" : "Returns the specified User Group.",
"operationId" : "getUserGroup",
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"description" : "The Group ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usergroupsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/users/{userId}/actions/getAvatar" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "Returns the specified User Avatar.",
"operationId" : "getAvatar",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/users/{userId}" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "Returns the specified User.",
"operationId" : "getUser",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usersSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Users" ],
"summary" : "Updates the specified User.",
"operationId" : "patchUser",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The User body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usersSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/users" : {
"get" : {
"tags" : [ "Users" ],
"summary" : "Returns a list of Users.",
"operationId" : "getUsers",
"parameters" : [ {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usersListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Users" ],
"summary" : "Creates a list of Users.",
"operationId" : "postUsers",
"requestBody" : {
"description" : "The User(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usersListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/usersListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/users/{userId}/actions/setLicense" : {
"post" : {
"tags" : [ "Users" ],
"summary" : "Sets the User's license.",
"operationId" : "setLicense",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The user license body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/setLicenseRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/users/{userId}/actions/updateAvatar" : {
"post" : {
"tags" : [ "Users" ],
"summary" : "Updates the specified User Avatar.",
"operationId" : "updateAvatar",
"parameters" : [ {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Avatar file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/updateAvatarRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/approvals/{userId}" : {
"get" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Returns the specified instance.",
"operationId" : "getWorkItemApproval",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Deletes the specified Work Item Approval.",
"operationId" : "deleteApproval",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Updates the specified instance.",
"operationId" : "patchWorkItemApproval",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "userId",
"in" : "path",
"description" : "The User ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/approvals" : {
"get" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Returns a list of instances.",
"operationId" : "getWorkItemApprovals",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Creates a list of WorkItem Approvals.",
"operationId" : "postWorkItemApprovals",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Deletes a list of Work Item Approvals.",
"operationId" : "deleteApprovals",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Workitem Approval(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Item Approvals" ],
"summary" : "Updates a list of instances.",
"operationId" : "patchWorkItemApprovals",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Test Run(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_approvalsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}" : {
"get" : {
"tags" : [ "Work Item Attachments" ],
"summary" : "Returns the specified Work Item Attachment.",
"operationId" : "getWorkItemAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_attachmentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Item Attachments" ],
"summary" : "Deletes the specified Work Item Attachment.",
"operationId" : "deleteWorkItemAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Item Attachments" ],
"summary" : "Updates the specified Work Item Attachment.",
"description" : "See more in the REST API User Guide.",
"operationId" : "patchWorkItemAttachment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PatchWorkItemAttachmentsRequestBody"
}
}
}
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/attachments/{attachmentId}/content" : {
"get" : {
"tags" : [ "Work Item Attachments" ],
"summary" : "Downloads the file content for a specified Work Item Attachment.",
"operationId" : "getWorkItemAttachmentContent",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "attachmentId",
"in" : "path",
"description" : "The Attachment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/octet-stream" : { }
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/attachments" : {
"get" : {
"tags" : [ "Work Item Attachments" ],
"summary" : "Returns a list of Work Item Attachments.",
"operationId" : "getWorkItemAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_attachmentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Work Item Attachments" ],
"summary" : "Creates a list of Work Item Attachments.",
"description" : "Files are identified by order or optionally by the 'lid' attribute. See more in the REST API User Guide.",
"operationId" : "postWorkItemAttachments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment metadata and file data.",
"content" : {
"multipart/form-data" : {
"schema" : {
"$ref" : "#/components/schemas/PostWorkItemAttachmentsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_attachmentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/comments/{commentId}" : {
"get" : {
"tags" : [ "Work Item Comments" ],
"summary" : "Returns the specified Work Item Comment.",
"operationId" : "getComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_commentsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Item Comments" ],
"summary" : "Updates the specified Work Item Comment.",
"operationId" : "patchComment",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "commentId",
"in" : "path",
"description" : "The Comment ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_commentsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/comments" : {
"get" : {
"tags" : [ "Work Item Comments" ],
"summary" : "Returns a list of Work Item Comments.",
"operationId" : "getComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_commentsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Work Item Comments" ],
"summary" : "Creates a list of Work Item Comments.",
"operationId" : "postComments",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Comment(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_commentsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitem_commentsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of Work Items.",
"operationId" : "getWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "query",
"in" : "query",
"description" : "The query string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "The sort string.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Work Items" ],
"summary" : "Creates a list of Work Items.",
"operationId" : "postWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Items" ],
"summary" : "Deletes a list of Work Items.",
"operationId" : "deleteWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Items" ],
"summary" : "Updates a list of Work Items.",
"operationId" : "patchWorkItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workflowAction",
"in" : "query",
"description" : "The Workflow Action.",
"schema" : {
"type" : "string"
}
}, {
"name" : "changeTypeTo",
"in" : "query",
"description" : "The Type the Workitem to change to.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsListPatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of Work Item Relationships.",
"operationId" : "getWorkItemsRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Work Items" ],
"summary" : "Creates a list of Work Item Relationships.",
"operationId" : "postWorkItemRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Items" ],
"summary" : "Deletes a list of Work Item Relationships.",
"operationId" : "deleteWorkItemsRelationship",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/relationshipsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"405" : {
"description" : "Not Allowed"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Items" ],
"summary" : "Updates a list of Work Item Relationships.",
"operationId" : "patchWorkItemRelationships",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "relationshipId",
"in" : "path",
"description" : "The Relationship ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Relationship body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RelationshipsRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of available options for the requested field for the specified Work Item.",
"operationId" : "getAvailableEnumOptionsForWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fieldId",
"in" : "path",
"description" : "The Field ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumOptionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of available options for the requested field for the specified Work Item Type.",
"operationId" : "getAvailableEnumOptionsForWorkItemType",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fieldId",
"in" : "path",
"description" : "The Field ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "type",
"in" : "query",
"description" : "The Type of the object. Use '~' without quotes to represent no target Type.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumOptionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of selected options for the requested field for specific Work Item.",
"operationId" : "getCurrentEnumOptionsForWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fieldId",
"in" : "path",
"description" : "The Field ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/enumOptionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/actions/getFieldsMetadata" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns fields for the specified resource.",
"operationId" : "getFieldsMetadataForWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/fieldsMetadataActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns the specified Work Item.",
"operationId" : "getWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"patch" : {
"tags" : [ "Work Items" ],
"summary" : "Updates the specified Work Item.",
"operationId" : "patchWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workflowAction",
"in" : "query",
"description" : "The Workflow Action.",
"schema" : {
"type" : "string"
}
}, {
"name" : "changeTypeTo",
"in" : "query",
"description" : "The Type the Workitem to change to.",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Item body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workitemsSinglePatchRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns the specified Test Parameter Definition for the specified Work Item.",
"operationId" : "getWorkItemTestParameterDefinition",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "testParamId",
"in" : "path",
"description" : "The Test Parameter.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/testparameterdefinitions" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of Test Parameter Definitions for the specified Work Item.",
"operationId" : "getWorkItemTestParameterDefinitions",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/testparameter_definitionsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions" : {
"get" : {
"tags" : [ "Work Items" ],
"summary" : "Returns a list of Workflow Actions.",
"operationId" : "getWorkflowActionsForWorkItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workflowActionsActionResponseBody"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument" : {
"post" : {
"tags" : [ "Work Items" ],
"summary" : "Moves the specified Work Item from the Document.",
"operationId" : "moveFromDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/actions/moveToDocument" : {
"post" : {
"tags" : [ "Work Items" ],
"summary" : "Moves the specified Work Item to the Document.",
"operationId" : "moveToDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Moving Work Item to Document parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/moveWorkItemToDocumentRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/actions/moveToDocument" : {
"post" : {
"tags" : [ "Work Items" ],
"summary" : "Moves multiple Work Items to the Document.",
"operationId" : "moveWorkItemsToDocument",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Moving Work Items to Document parameters.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/moveWorkItemsToDocumentRequestBody"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/workrecords/{workRecordId}" : {
"get" : {
"tags" : [ "Work Item Work Records" ],
"summary" : "Returns the specified instance.",
"operationId" : "getWorkRecord",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workRecordId",
"in" : "path",
"description" : "The Work Record ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workrecordsSingleGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Item Work Records" ],
"summary" : "Deletes the specified Work Record.",
"operationId" : "deleteWorkRecord",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workRecordId",
"in" : "path",
"description" : "The Work Record ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
},
"/projects/{projectId}/workitems/{workItemId}/workrecords" : {
"get" : {
"tags" : [ "Work Item Work Records" ],
"summary" : "Returns a list of instances.",
"operationId" : "getWorkRecords",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "page[size]",
"in" : "query",
"description" : "Limit the number of entities returned in a single response. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "page[number]",
"in" : "query",
"description" : "Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details.",
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Filter returned resource fields. See REST API User Guide for details.",
"style" : "deepObject",
"schema" : {
"$ref" : "#/components/schemas/sparseFields"
}
}, {
"name" : "include",
"in" : "query",
"description" : "Include related entities. See REST API User Guide for details.",
"schema" : {
"type" : "string"
}
}, {
"name" : "revision",
"in" : "query",
"description" : "The revision ID.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workrecordsListGetResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"post" : {
"tags" : [ "Work Item Work Records" ],
"summary" : "Creates a list of Work Records.",
"operationId" : "postWorkRecords",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Linked Work Item(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workrecordsListPostRequest"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workrecordsListPostResponse"
}
}
}
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"406" : {
"description" : "Not Acceptable"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
},
"delete" : {
"tags" : [ "Work Item Work Records" ],
"summary" : "Deletes a list of Work Records.",
"operationId" : "deleteWorkRecords",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "The Project ID.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "workItemId",
"in" : "path",
"description" : "The Work Item ID.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The Work Record(s) body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/workrecordsListDeleteRequest"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No Content"
},
"400" : {
"description" : "Bad Request"
},
"401" : {
"description" : "Unauthorized"
},
"403" : {
"description" : "Forbidden"
},
"404" : {
"description" : "Not Found"
},
"409" : {
"description" : "Conflict"
},
"413" : {
"description" : "Request Entity Too Large"
},
"415" : {
"description" : "Unsupported Media Type"
},
"500" : {
"description" : "Internal Server Error"
},
"503" : {
"description" : "Service Unavailable"
},
"4XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
},
"5XX" : {
"description" : "Error responses have the following structure:",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/errors"
}
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"documentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"autoSuspect" : {
"type" : "boolean"
},
"branchedWithInitializedFields" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "fieldId"
}
},
"branchedWithQuery" : {
"type" : "string",
"example" : "Branched with Query"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"derivedFields" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "fieldId"
}
},
"derivedFromLinkRole" : {
"type" : "string",
"example" : "relates_to"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"moduleFolder" : {
"type" : "string",
"example" : "MySpaceId"
},
"moduleName" : {
"type" : "string",
"example" : "MyDocumentId"
},
"outlineNumbering" : {
"type" : "object",
"properties" : {
"prefix" : {
"type" : "string",
"example" : "ABC"
}
}
},
"renderingLayouts" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : "task"
},
"label" : {
"type" : "string",
"example" : "My label"
},
"layouter" : {
"type" : "string",
"example" : "paragraph"
},
"properties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "fieldsAtStart"
},
"value" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
},
"status" : {
"type" : "string",
"example" : "draft"
},
"structureLinkRole" : {
"type" : "string",
"example" : "relates_to"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "req_specification"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"usesOutlineNumbering" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"branchedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"comments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234"
}
}
}
}
},
"derivedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"updatedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"variant" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
}
}
}
}
},
"documentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"autoSuspect" : {
"type" : "boolean"
},
"branchedWithInitializedFields" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "fieldId"
}
},
"branchedWithQuery" : {
"type" : "string",
"example" : "Branched with Query"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"derivedFields" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "fieldId"
}
},
"derivedFromLinkRole" : {
"type" : "string",
"example" : "relates_to"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"moduleFolder" : {
"type" : "string",
"example" : "MySpaceId"
},
"moduleName" : {
"type" : "string",
"example" : "MyDocumentId"
},
"outlineNumbering" : {
"type" : "object",
"properties" : {
"prefix" : {
"type" : "string",
"example" : "ABC"
}
}
},
"renderingLayouts" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : "task"
},
"label" : {
"type" : "string",
"example" : "My label"
},
"layouter" : {
"type" : "string",
"example" : "paragraph"
},
"properties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "fieldsAtStart"
},
"value" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
},
"status" : {
"type" : "string",
"example" : "draft"
},
"structureLinkRole" : {
"type" : "string",
"example" : "relates_to"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "req_specification"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"usesOutlineNumbering" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"branchedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"comments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234"
}
}
}
}
},
"derivedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"updatedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"variant" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"documentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"autoSuspect" : {
"type" : "boolean"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"outlineNumbering" : {
"type" : "object",
"properties" : {
"prefix" : {
"type" : "string",
"example" : "ABC"
}
}
},
"renderingLayouts" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : "task"
},
"label" : {
"type" : "string",
"example" : "My label"
},
"layouter" : {
"type" : "string",
"example" : "paragraph"
},
"properties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "fieldsAtStart"
},
"value" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
},
"status" : {
"type" : "string",
"example" : "draft"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "req_specification"
},
"usesOutlineNumbering" : {
"type" : "boolean"
}
}
}
}
}
}
},
"documentsSinglePostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"autoSuspect" : {
"type" : "boolean"
},
"branchedWithInitializedFields" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "fieldId"
}
},
"branchedWithQuery" : {
"type" : "string",
"example" : "Branched with Query"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"derivedFields" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "fieldId"
}
},
"derivedFromLinkRole" : {
"type" : "string",
"example" : "relates_to"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"moduleFolder" : {
"type" : "string",
"example" : "MySpaceId"
},
"outlineNumbering" : {
"type" : "object",
"properties" : {
"prefix" : {
"type" : "string",
"example" : "ABC"
}
}
},
"renderingLayouts" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : "task"
},
"label" : {
"type" : "string",
"example" : "My label"
},
"layouter" : {
"type" : "string",
"example" : "paragraph"
},
"properties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "fieldsAtStart"
},
"value" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
},
"status" : {
"type" : "string",
"example" : "draft"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "req_specification"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"usesOutlineNumbering" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"branchedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
},
"comments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234"
}
}
}
}
},
"derivedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
},
"updatedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"variant" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
}
}
}
}
}
}
},
"documentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"autoSuspect" : {
"type" : "boolean"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"moduleName" : {
"type" : "string",
"example" : "MyDocumentId"
},
"outlineNumbering" : {
"type" : "object",
"properties" : {
"prefix" : {
"type" : "string",
"example" : "ABC"
}
}
},
"renderingLayouts" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : "task"
},
"label" : {
"type" : "string",
"example" : "My label"
},
"layouter" : {
"type" : "string",
"example" : "paragraph"
},
"properties" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "fieldsAtStart"
},
"value" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
},
"status" : {
"type" : "string",
"example" : "draft"
},
"structureLinkRole" : {
"type" : "string",
"example" : "relates_to"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "req_specification"
},
"usesOutlineNumbering" : {
"type" : "boolean"
}
}
}
}
}
}
}
},
"documentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
}
}
}
}
}
}
}
},
"globalrolesSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "globalroles" ]
},
"id" : {
"type" : "string",
"example" : "MyRoleId"
},
"relationships" : {
"type" : "object",
"properties" : {
"users" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/roles/MyRoleId"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/roles/MyRoleId"
}
}
}
}
},
"testrunsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"groupId" : {
"type" : "string",
"example" : "Group ID"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"idPrefix" : {
"type" : "string",
"example" : "MyTestRunIdPrefix"
},
"isTemplate" : {
"type" : "boolean"
},
"keepInHistory" : {
"type" : "boolean"
},
"query" : {
"type" : "string",
"example" : "Query"
},
"selectTestCasesBy" : {
"type" : "string",
"example" : "manualSelection",
"enum" : [ "manualSelection", "staticQueryResult", "dynamicQueryResult", "staticLiveDoc", "dynamicLiveDoc", "automatedProcess" ]
},
"status" : {
"type" : "string",
"example" : "open"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "manual"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"summaryDefect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"template" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234"
}
}
}
}
},
"testrunsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"groupId" : {
"type" : "string",
"example" : "Group ID"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"idPrefix" : {
"type" : "string",
"example" : "MyTestRunIdPrefix"
},
"isTemplate" : {
"type" : "boolean"
},
"keepInHistory" : {
"type" : "boolean"
},
"query" : {
"type" : "string",
"example" : "Query"
},
"selectTestCasesBy" : {
"type" : "string",
"example" : "manualSelection",
"enum" : [ "manualSelection", "staticQueryResult", "dynamicQueryResult", "staticLiveDoc", "dynamicLiveDoc", "automatedProcess" ]
},
"status" : {
"type" : "string",
"example" : "open"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "manual"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"summaryDefect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"template" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns?page%5Bsize%5D=10&page%5Bnumber%5D=9"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/testruns"
}
}
}
}
},
"testrunsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"attributes" : {
"type" : "object",
"properties" : {
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"groupId" : {
"type" : "string",
"example" : "Group ID"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"idPrefix" : {
"type" : "string",
"example" : "MyTestRunIdPrefix"
},
"keepInHistory" : {
"type" : "boolean"
},
"query" : {
"type" : "string",
"example" : "Query"
},
"selectTestCasesBy" : {
"type" : "string",
"example" : "manualSelection",
"enum" : [ "manualSelection", "staticQueryResult", "dynamicQueryResult", "staticLiveDoc", "dynamicLiveDoc", "automatedProcess" ]
},
"status" : {
"type" : "string",
"example" : "open"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "manual"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
},
"summaryDefect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
},
"testrunsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"attributes" : {
"type" : "object",
"properties" : {
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"groupId" : {
"type" : "string",
"example" : "Group ID"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"idPrefix" : {
"type" : "string",
"example" : "MyTestRunIdPrefix"
},
"keepInHistory" : {
"type" : "boolean"
},
"query" : {
"type" : "string",
"example" : "Query"
},
"selectTestCasesBy" : {
"type" : "string",
"example" : "manualSelection",
"enum" : [ "manualSelection", "staticQueryResult", "dynamicQueryResult", "staticLiveDoc", "dynamicLiveDoc", "automatedProcess" ]
},
"status" : {
"type" : "string",
"example" : "open"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "manual"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
},
"summaryDefect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
}
},
"testrunsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"groupId" : {
"type" : "string",
"example" : "Group ID"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"idPrefix" : {
"type" : "string",
"example" : "MyTestRunIdPrefix"
},
"isTemplate" : {
"type" : "boolean"
},
"keepInHistory" : {
"type" : "boolean"
},
"query" : {
"type" : "string",
"example" : "Query"
},
"selectTestCasesBy" : {
"type" : "string",
"example" : "manualSelection",
"enum" : [ "manualSelection", "staticQueryResult", "dynamicQueryResult", "staticLiveDoc", "dynamicLiveDoc", "automatedProcess" ]
},
"status" : {
"type" : "string",
"example" : "open"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "manual"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
},
"summaryDefect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
},
"template" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
}
}
}
}
}
}
}
}
}
}
}
},
"testrunsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/testrun?id=MyTestRunId&revision=1234"
}
}
}
}
}
}
}
},
"testrunsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
}
}
}
}
}
},
"linkedworkitemsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"revision" : {
"type" : "string",
"example" : "1234"
},
"role" : {
"type" : "string",
"example" : "relates_to"
},
"suspect" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"sourceWorkItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
},
"linkedworkitemsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"revision" : {
"type" : "string",
"example" : "1234"
},
"role" : {
"type" : "string",
"example" : "relates_to"
},
"suspect" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"sourceWorkItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"linkedworkitemsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
}
}
}
}
}
},
"linkedworkitemsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"revision" : {
"type" : "string",
"example" : "1234"
},
"role" : {
"type" : "string",
"example" : "relates_to"
},
"suspect" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
}
},
"linkedworkitemsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems/parent/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
}
}
}
},
"linkedworkitemsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"attributes" : {
"type" : "object",
"properties" : {
"revision" : {
"type" : "string",
"example" : "1234"
},
"suspect" : {
"type" : "boolean"
}
}
}
}
}
}
},
"externallylinkedworkitemsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"role" : {
"type" : "string",
"example" : "relates_to"
},
"workItemURI" : {
"type" : "string"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
},
"externallylinkedworkitemsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"role" : {
"type" : "string",
"example" : "relates_to"
},
"workItemURI" : {
"type" : "string"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"externallylinkedworkitemsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/externallylinkedworkitems/parent/hostname/MyProjectId/MyLinkedWorkItemId?revision=1234"
}
}
}
}
}
}
}
},
"externallylinkedworkitemsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"role" : {
"type" : "string",
"example" : "relates_to"
},
"workItemURI" : {
"type" : "string"
}
}
}
}
}
}
}
},
"externallylinkedworkitemsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId"
}
}
}
}
}
},
"projectsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"finish" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"icon" : {
"type" : "string",
"example" : "Icon"
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"lockWorkRecordsDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"start" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"trackerPrefix" : {
"type" : "string",
"example" : "Tracker Prefix"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"lead" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId?revision=1234"
}
}
}
}
},
"projectsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"finish" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"icon" : {
"type" : "string",
"example" : "Icon"
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"lockWorkRecordsDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"start" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"trackerPrefix" : {
"type" : "string",
"example" : "Tracker Prefix"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"lead" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"projectsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"attributes" : {
"type" : "object",
"properties" : {
"active" : {
"type" : "boolean"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"finish" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"icon" : {
"type" : "string",
"example" : "Icon"
},
"lockWorkRecordsDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"start" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"trackerPrefix" : {
"type" : "string",
"example" : "Tracker Prefix"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"lead" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
},
"projecttemplatesListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projecttemplates" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"customIcon" : {
"type" : "string",
"example" : null
},
"description" : {
"type" : "string",
"example" : null
},
"distributions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"isDefault" : {
"type" : "boolean"
},
"name" : {
"type" : "string",
"example" : null
},
"parameters" : {
"type" : "object"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projecttemplates/MyProjectId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projecttemplates?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"pagesSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"pageName" : {
"type" : "string",
"example" : "MyRichPageId"
},
"spaceId" : {
"type" : "string",
"example" : "MySpaceId"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"updatedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234"
}
}
}
}
},
"pagesSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
},
"attributes" : {
"type" : "object",
"properties" : {
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
},
"pagesListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"pageName" : {
"type" : "string",
"example" : "MyRichPageId"
},
"spaceId" : {
"type" : "string",
"example" : "MySpaceId"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"updatedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"pagesListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"pageName" : {
"type" : "string",
"example" : "MyRichPageId"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
},
"pagesListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId?revision=1234"
}
}
}
}
}
}
}
},
"page_attachmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234"
}
}
}
}
},
"page_attachmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"page_attachmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
},
"page_attachmentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"lid" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
}
},
"page_attachmentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyAttachmentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
}
}
},
"usergroupsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "usergroups" ]
},
"id" : {
"type" : "string",
"example" : "MyUserGroupId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "MyUserGroupId"
},
"ldapSearchFilter" : {
"type" : "string",
"example" : "LDAP Search Filter"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"ssoSynchronizationAllowed" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"globalRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "globalroles" ]
},
"id" : {
"type" : "string",
"example" : "MyRoleId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"projectRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projectroles" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyRoleId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"users" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/usergroups/MyUserGroupId"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/usergroups/MyUserGroupId"
}
}
}
}
},
"usersSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"avatarUrl" : {
"type" : "string",
"example" : "http://server-host-name/application-path/icons/avatar/MyUserId/avatar.png?revision=1234"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"disabledNotifications" : {
"type" : "boolean"
},
"email" : {
"type" : "string",
"example" : "Email"
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"initials" : {
"type" : "string",
"example" : "Initials"
},
"name" : {
"type" : "string",
"example" : "Name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"addOnLicenseSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"baseLicenseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
},
"globalRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "globalroles" ]
},
"id" : {
"type" : "string",
"example" : "MyRoleId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"projectRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projectroles" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyRoleId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"userGroups" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "usergroups" ]
},
"id" : {
"type" : "string",
"example" : "MyUserGroupId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/users/MyUserId"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/users/MyUserId"
}
}
}
}
},
"usersListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"avatarUrl" : {
"type" : "string",
"example" : "http://server-host-name/application-path/icons/avatar/MyUserId/avatar.png?revision=1234"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"disabledNotifications" : {
"type" : "boolean"
},
"email" : {
"type" : "string",
"example" : "Email"
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"initials" : {
"type" : "string",
"example" : "Initials"
},
"name" : {
"type" : "string",
"example" : "Name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"addOnLicenseSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"baseLicenseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
},
"globalRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "globalroles" ]
},
"id" : {
"type" : "string",
"example" : "MyRoleId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"projectRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projectroles" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyRoleId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"userGroups" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "usergroups" ]
},
"id" : {
"type" : "string",
"example" : "MyUserGroupId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/users/MyUserId"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/users?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"usersSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"attributes" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"disabledNotifications" : {
"type" : "boolean"
},
"email" : {
"type" : "string",
"example" : "Email"
},
"initials" : {
"type" : "string",
"example" : "Initials"
},
"name" : {
"type" : "string",
"example" : "Name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"globalRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "globalroles" ]
},
"id" : {
"type" : "string",
"example" : "MyRoleId"
}
}
}
}
}
},
"projectRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projectroles" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyRoleId"
}
}
}
}
}
},
"userGroups" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "usergroups" ]
},
"id" : {
"type" : "string",
"example" : "MyUserGroupId"
}
}
}
}
}
}
}
}
}
}
}
},
"usersListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"attributes" : {
"required" : [ "id" ],
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"disabledNotifications" : {
"type" : "boolean"
},
"email" : {
"type" : "string",
"example" : "Email"
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"initials" : {
"type" : "string",
"example" : "Initials"
},
"name" : {
"type" : "string",
"example" : "Name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"globalRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "globalroles" ]
},
"id" : {
"type" : "string",
"example" : "MyRoleId"
}
}
}
}
}
},
"projectRoles" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projectroles" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyRoleId"
}
}
}
}
}
},
"userGroups" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "usergroups" ]
},
"id" : {
"type" : "string",
"example" : "MyUserGroupId"
}
}
}
}
}
}
}
}
}
}
}
}
},
"usersListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/users/MyUserId"
}
}
}
}
}
}
}
},
"workitemsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"hyperlinks" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
},
"role" : {
"type" : "string",
"example" : "ref_ext"
},
"uri" : {
"type" : "string",
"example" : "https://polarion.plm.automation.siemens.com"
}
}
}
},
"id" : {
"type" : "string",
"example" : "MyWorkItemId"
},
"initialEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"outlineNumber" : {
"type" : "string",
"example" : "1.11"
},
"plannedEnd" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"plannedStart" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"priority" : {
"type" : "string",
"example" : "90.0"
},
"remainingEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"resolution" : {
"type" : "string",
"example" : "done"
},
"resolvedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"severity" : {
"type" : "string",
"example" : "blocker"
},
"status" : {
"type" : "string",
"example" : "open"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "task"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"approvals" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"assignee" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"backlinkedWorkItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"categories" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "categories" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCategoryId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"comments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234"
}
}
}
}
},
"externallyLinkedWorkItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"linkedOslcResources" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedoslcresources" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"linkedRevisions" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"linkedWorkItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234"
}
}
}
}
},
"module" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"plannedIn" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"testSteps" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"votes" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"workRecords" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyWorkRecordId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234"
}
}
}
}
},
"workitemsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"hyperlinks" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
},
"role" : {
"type" : "string",
"example" : "ref_ext"
},
"uri" : {
"type" : "string",
"example" : "https://polarion.plm.automation.siemens.com"
}
}
}
},
"id" : {
"type" : "string",
"example" : "MyWorkItemId"
},
"initialEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"outlineNumber" : {
"type" : "string",
"example" : "1.11"
},
"plannedEnd" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"plannedStart" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"priority" : {
"type" : "string",
"example" : "90.0"
},
"remainingEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"resolution" : {
"type" : "string",
"example" : "done"
},
"resolvedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"severity" : {
"type" : "string",
"example" : "blocker"
},
"status" : {
"type" : "string",
"example" : "open"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "task"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"approvals" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"assignee" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"attachments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234"
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"backlinkedWorkItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"categories" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "categories" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCategoryId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"comments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234"
}
}
}
}
},
"externallyLinkedWorkItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "externallylinkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"linkedOslcResources" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedoslcresources" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"linkedRevisions" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"linkedWorkItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"links" : {
"type" : "object",
"properties" : {
"related" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234"
}
}
}
}
},
"module" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"plannedIn" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"testSteps" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"votes" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"workRecords" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyWorkRecordId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=9"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitems"
}
}
}
}
},
"workitemsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"attributes" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"hyperlinks" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
},
"role" : {
"type" : "string",
"example" : "ref_ext"
},
"uri" : {
"type" : "string",
"example" : "https://polarion.plm.automation.siemens.com"
}
}
}
},
"initialEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"priority" : {
"type" : "string",
"example" : "90.0"
},
"remainingEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"resolution" : {
"type" : "string",
"example" : "done"
},
"resolvedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"severity" : {
"type" : "string",
"example" : "blocker"
},
"status" : {
"type" : "string",
"example" : "open"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"assignee" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
},
"categories" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "categories" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCategoryId"
}
}
}
}
}
},
"linkedRevisions" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
}
}
}
}
}
},
"votes" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
},
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
},
"workitemsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"attributes" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"hyperlinks" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
},
"role" : {
"type" : "string",
"example" : "ref_ext"
},
"uri" : {
"type" : "string",
"example" : "https://polarion.plm.automation.siemens.com"
}
}
}
},
"initialEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"priority" : {
"type" : "string",
"example" : "90.0"
},
"remainingEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"resolution" : {
"type" : "string",
"example" : "done"
},
"resolvedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"severity" : {
"type" : "string",
"example" : "blocker"
},
"status" : {
"type" : "string",
"example" : "open"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"assignee" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
},
"categories" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "categories" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCategoryId"
}
}
}
}
}
},
"linkedRevisions" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
}
}
}
}
}
},
"votes" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
},
"watches" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
}
},
"workitemsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"attributes" : {
"required" : [ "type" ],
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"hyperlinks" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
},
"role" : {
"type" : "string",
"example" : "ref_ext"
},
"uri" : {
"type" : "string",
"example" : "https://polarion.plm.automation.siemens.com"
}
}
}
},
"initialEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"priority" : {
"type" : "string",
"example" : "90.0"
},
"remainingEstimate" : {
"type" : "string",
"example" : "5 1/2d"
},
"resolution" : {
"type" : "string",
"example" : "done"
},
"resolvedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"severity" : {
"type" : "string",
"example" : "blocker"
},
"status" : {
"type" : "string",
"example" : "open"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"type" : {
"type" : "string",
"example" : "task"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"assignee" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
},
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"categories" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "categories" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCategoryId"
}
}
}
}
}
},
"linkedRevisions" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
}
}
}
}
}
},
"module" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
}
}
}
}
}
}
}
},
"workitemsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234"
}
}
}
}
}
}
}
},
"workitemsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
},
"plansSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"allowedTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "optionId"
}
},
"calculationType" : {
"type" : "string",
"example" : "timeBased",
"enum" : [ "timeBased", "customFieldBased" ]
},
"capacity" : {
"type" : "number"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"defaultEstimate" : {
"type" : "number"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"estimationField" : {
"type" : "string",
"example" : "Estimation Field"
},
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"isTemplate" : {
"type" : "boolean"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"previousTimeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"prioritizationField" : {
"type" : "string",
"example" : "Prioritization Field"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32",
"example" : 0
},
"startDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"startedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"status" : {
"type" : "string"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"parent" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"template" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"workItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/plan?id=MyPlanId&revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234"
}
}
}
}
},
"plansListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"allowedTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "optionId"
}
},
"calculationType" : {
"type" : "string",
"example" : "timeBased",
"enum" : [ "timeBased", "customFieldBased" ]
},
"capacity" : {
"type" : "number"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"defaultEstimate" : {
"type" : "number"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"estimationField" : {
"type" : "string",
"example" : "Estimation Field"
},
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"isTemplate" : {
"type" : "boolean"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"previousTimeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"prioritizationField" : {
"type" : "string",
"example" : "Prioritization Field"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32",
"example" : 0
},
"startDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"startedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"status" : {
"type" : "string"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"parent" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"template" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"workItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/plan?id=MyPlanId&revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans?page%5Bsize%5D=10&page%5Bnumber%5D=9"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/plans"
}
}
}
}
},
"plansListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"allowedTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "optionId"
}
},
"calculationType" : {
"type" : "string",
"example" : "timeBased",
"enum" : [ "timeBased", "customFieldBased" ]
},
"capacity" : {
"type" : "number"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"defaultEstimate" : {
"type" : "number"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"estimationField" : {
"type" : "string",
"example" : "Estimation Field"
},
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"isTemplate" : {
"type" : "boolean"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"previousTimeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"prioritizationField" : {
"type" : "string",
"example" : "Prioritization Field"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32",
"example" : 0
},
"startDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"startedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"status" : {
"type" : "string"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"parent" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
},
"template" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
}
}
}
}
},
"workItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
}
}
},
"plansListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/plans/MyPlanId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/plan?id=MyPlanId&revision=1234"
}
}
}
}
}
}
}
},
"plansSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
},
"attributes" : {
"type" : "object",
"properties" : {
"allowedTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "optionId"
}
},
"calculationType" : {
"type" : "string",
"example" : "timeBased",
"enum" : [ "timeBased", "customFieldBased" ]
},
"capacity" : {
"type" : "number"
},
"color" : {
"type" : "string",
"example" : "Color"
},
"defaultEstimate" : {
"type" : "number"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"dueDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"estimationField" : {
"type" : "string",
"example" : "Estimation Field"
},
"finishedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"homePageContent" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"isTemplate" : {
"type" : "boolean"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"previousTimeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"prioritizationField" : {
"type" : "string",
"example" : "Prioritization Field"
},
"sortOrder" : {
"type" : "integer",
"format" : "int32",
"example" : 0
},
"startDate" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"startedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"status" : {
"type" : "string"
},
"useReportFromTemplate" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"parent" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
}
}
}
}
},
"projectSpan" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
},
"workItems" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
}
},
"plansListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "plans" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyPlanId"
}
}
}
}
}
},
"collectionsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"closedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"downstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"reusedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"richPages" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"testRuns" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"upstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234"
}
}
}
}
},
"collectionsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"closedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"name" : {
"type" : "string",
"example" : "Name"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"downstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"reusedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"richPages" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"testRuns" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"upstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections?page%5Bsize%5D=10&page%5Bnumber%5D=9"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/collections"
}
}
}
}
},
"collectionsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"attributes" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"name" : {
"type" : "string",
"example" : "Name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
},
"richPages" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
}
}
}
}
}
},
"testRuns" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
}
}
}
}
}
},
"upstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
}
}
}
}
}
},
"collectionsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
}
}
}
}
}
},
"collectionsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"id" : {
"type" : "string",
"example" : "ID"
},
"name" : {
"type" : "string",
"example" : "Name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
},
"richPages" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
}
}
}
}
}
},
"testRuns" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
}
}
}
}
}
},
"upstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
}
}
}
}
}
}
},
"collectionsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234"
}
}
}
}
}
}
}
},
"collectionsSinglePostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"attributes" : {
"type" : "object",
"properties" : {
"closedOn" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"description" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"name" : {
"type" : "string",
"example" : "Name"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
},
"downstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
}
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
},
"reusedFrom" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
}
}
}
}
},
"richPages" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "pages" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId"
}
}
}
}
}
},
"testRuns" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testruns" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId"
}
}
}
}
}
},
"upstreamCollections" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyCollectionId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/collections/MyCollectionId?revision=1234"
},
"portal" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/redirect/project/MyProjectId/collection?id=MyCollectionId&revision=1234"
}
}
}
}
}
}
},
"workitem_attachmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234"
}
}
}
}
},
"workitem_attachmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"workitem_attachmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyAttachmentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
},
"workitem_attachmentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"lid" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
}
},
"workitem_attachmentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyAttachmentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
}
}
},
"workitem_commentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"workitem_commentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"workitem_commentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
}
}
}
}
}
}
},
"workitem_commentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
}
}
}
}
}
}
}
}
}
}
}
},
"workitem_commentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyCommentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments/MyCommentId?revision=1234"
}
}
}
}
}
}
}
},
"testrun_attachmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234"
}
}
}
}
},
"testrun_attachmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"testrun_attachmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyAttachmentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
},
"testrun_attachmentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_attachments" ]
},
"lid" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
}
},
"testrun_attachmentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyAttachmentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
}
}
},
"testrun_attachmentsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyAttachmentId"
}
}
}
}
}
},
"enumerationsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "enumerations" ]
},
"id" : {
"type" : "string",
"example" : "~/status/~"
},
"attributes" : {
"type" : "object",
"properties" : {
"enumContext" : {
"type" : "string",
"example" : "id"
},
"enumName" : {
"type" : "string",
"example" : "id"
},
"options" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "open"
},
"name" : {
"type" : "string",
"example" : "Open"
},
"color" : {
"type" : "string",
"example" : "#F9FF4D"
},
"description" : {
"type" : "string",
"example" : "Description"
},
"hidden" : {
"type" : "boolean",
"example" : false
},
"default" : {
"type" : "boolean",
"example" : true
},
"parent" : {
"type" : "boolean",
"example" : true
},
"oppositeName" : {
"type" : "string",
"example" : "Opposite Name"
},
"columnWidth" : {
"type" : "string",
"example" : "90%"
},
"iconURL" : {
"type" : "string",
"example" : "/polarion/icons/default/enums/status_open.gif"
},
"createDefect" : {
"type" : "boolean",
"example" : true
},
"templateWorkItem" : {
"type" : "string",
"example" : "exampleTemplate"
},
"minValue" : {
"type" : "number",
"example" : 30.0
},
"requiresSignatureForTestCaseExecution" : {
"type" : "boolean",
"example" : true
},
"terminal" : {
"type" : "boolean",
"example" : true
},
"limited" : {
"type" : "boolean",
"example" : true
},
"linkRules" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"fromTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"toTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"sameType" : {
"type" : "boolean",
"example" : false
}
}
}
}
}
}
},
"targetType" : {
"type" : "string",
"example" : "id"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status/%7E"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status/%7E"
}
}
}
}
},
"enumerationsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "enumerations" ]
},
"id" : {
"type" : "string",
"example" : "~/status/~"
},
"attributes" : {
"type" : "object",
"properties" : {
"enumContext" : {
"type" : "string",
"example" : "id"
},
"enumName" : {
"type" : "string",
"example" : "id"
},
"options" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "open"
},
"name" : {
"type" : "string",
"example" : "Open"
},
"color" : {
"type" : "string",
"example" : "#F9FF4D"
},
"description" : {
"type" : "string",
"example" : "Description"
},
"hidden" : {
"type" : "boolean",
"example" : false
},
"default" : {
"type" : "boolean",
"example" : true
},
"parent" : {
"type" : "boolean",
"example" : true
},
"oppositeName" : {
"type" : "string",
"example" : "Opposite Name"
},
"columnWidth" : {
"type" : "string",
"example" : "90%"
},
"iconURL" : {
"type" : "string",
"example" : "/polarion/icons/default/enums/status_open.gif"
},
"createDefect" : {
"type" : "boolean",
"example" : true
},
"templateWorkItem" : {
"type" : "string",
"example" : "exampleTemplate"
},
"minValue" : {
"type" : "number",
"example" : 30.0
},
"requiresSignatureForTestCaseExecution" : {
"type" : "boolean",
"example" : true
},
"terminal" : {
"type" : "boolean",
"example" : true
},
"limited" : {
"type" : "boolean",
"example" : true
},
"linkRules" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"fromTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"toTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"sameType" : {
"type" : "boolean",
"example" : false
}
}
}
}
}
}
},
"targetType" : {
"type" : "string",
"example" : "id"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status/%7E"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"enumerationsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "enumerations" ]
},
"id" : {
"type" : "string",
"example" : "~/status/~"
},
"attributes" : {
"type" : "object",
"properties" : {
"options" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "open"
},
"name" : {
"type" : "string",
"example" : "Open"
},
"color" : {
"type" : "string",
"example" : "#F9FF4D"
},
"description" : {
"type" : "string",
"example" : "Description"
},
"hidden" : {
"type" : "boolean",
"example" : false
},
"default" : {
"type" : "boolean",
"example" : true
},
"parent" : {
"type" : "boolean",
"example" : true
},
"oppositeName" : {
"type" : "string",
"example" : "Opposite Name"
},
"columnWidth" : {
"type" : "string",
"example" : "90%"
},
"iconURL" : {
"type" : "string",
"example" : "/polarion/icons/default/enums/status_open.gif"
},
"createDefect" : {
"type" : "boolean",
"example" : true
},
"templateWorkItem" : {
"type" : "string",
"example" : "exampleTemplate"
},
"minValue" : {
"type" : "number",
"example" : 30.0
},
"requiresSignatureForTestCaseExecution" : {
"type" : "boolean",
"example" : true
},
"terminal" : {
"type" : "boolean",
"example" : true
},
"limited" : {
"type" : "boolean",
"example" : true
},
"linkRules" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"fromTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"toTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"sameType" : {
"type" : "boolean",
"example" : false
}
}
}
}
}
}
}
}
}
}
}
}
},
"enumerationsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "enumerations" ]
},
"id" : {
"type" : "string",
"example" : "~/status/~"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/%7E/status/%7E"
}
}
}
}
}
}
}
},
"enumerationsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "enumerations" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"enumContext" : {
"type" : "string",
"example" : "id"
},
"enumName" : {
"type" : "string",
"example" : "id"
},
"options" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "open"
},
"name" : {
"type" : "string",
"example" : "Open"
},
"color" : {
"type" : "string",
"example" : "#F9FF4D"
},
"description" : {
"type" : "string",
"example" : "Description"
},
"hidden" : {
"type" : "boolean",
"example" : false
},
"default" : {
"type" : "boolean",
"example" : true
},
"parent" : {
"type" : "boolean",
"example" : true
},
"oppositeName" : {
"type" : "string",
"example" : "Opposite Name"
},
"columnWidth" : {
"type" : "string",
"example" : "90%"
},
"iconURL" : {
"type" : "string",
"example" : "/polarion/icons/default/enums/status_open.gif"
},
"createDefect" : {
"type" : "boolean",
"example" : true
},
"templateWorkItem" : {
"type" : "string",
"example" : "exampleTemplate"
},
"minValue" : {
"type" : "number",
"example" : 30.0
},
"requiresSignatureForTestCaseExecution" : {
"type" : "boolean",
"example" : true
},
"terminal" : {
"type" : "boolean",
"example" : true
},
"limited" : {
"type" : "boolean",
"example" : true
},
"linkRules" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"fromTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"toTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"sameType" : {
"type" : "boolean",
"example" : false
}
}
}
}
}
}
},
"targetType" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
}
},
"iconsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "icons" ]
},
"id" : {
"type" : "string",
"example" : "default/example.gif"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"iconUrl" : {
"type" : "string",
"example" : "pathexample"
},
"id" : {
"type" : "string",
"example" : "pathexample"
},
"path" : {
"type" : "string",
"example" : "pathexample"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons/example.gif"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons/example.gif"
}
}
}
}
},
"iconsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "icons" ]
},
"id" : {
"type" : "string",
"example" : "default/example.gif"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"iconUrl" : {
"type" : "string",
"example" : "pathexample"
},
"id" : {
"type" : "string",
"example" : "pathexample"
},
"path" : {
"type" : "string",
"example" : "pathexample"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons/example.gif"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"iconsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "icons" ]
}
}
}
}
}
},
"iconsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "icons" ]
},
"id" : {
"type" : "string",
"example" : "default/example.gif"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/enumerations/defaulticons/example.gif"
}
}
}
}
}
}
}
},
"jobsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "jobs" ]
},
"id" : {
"type" : "string",
"example" : "MyJobId"
},
"attributes" : {
"type" : "object",
"properties" : {
"jobId" : {
"type" : "string",
"example" : "example"
},
"name" : {
"type" : "string",
"example" : "example"
},
"state" : {
"type" : "string",
"example" : "example"
},
"status" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "OK", "CANCELLED", "FAILED", "UNKNOWN" ]
},
"message" : {
"type" : "string",
"example" : "message"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
},
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs/MyJobId"
},
"log" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/job-report?jobId=MyJobId"
},
"downloads" : {
"type" : "array",
"example" : [ "https://testdrive.polarion.com/polarion/download/filename1", "https://testdrive.polarion.com/polarion/download/filename2" ],
"items" : {
"type" : "string"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs/MyJobId"
}
}
}
}
},
"jobsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "jobs" ]
},
"id" : {
"type" : "string",
"example" : "MyJobId"
},
"attributes" : {
"type" : "object",
"properties" : {
"jobId" : {
"type" : "string",
"example" : "example"
},
"name" : {
"type" : "string",
"example" : "example"
},
"state" : {
"type" : "string",
"example" : "example"
},
"status" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "OK", "CANCELLED", "FAILED", "UNKNOWN" ]
},
"message" : {
"type" : "string",
"example" : "message"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
},
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs/MyJobId"
},
"log" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/job-report?jobId=MyJobId"
},
"downloads" : {
"type" : "array",
"example" : [ "https://testdrive.polarion.com/polarion/download/filename1", "https://testdrive.polarion.com/polarion/download/filename2" ],
"items" : {
"type" : "string"
}
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"jobsSinglePostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "jobs" ]
},
"id" : {
"type" : "string",
"example" : "MyJobId"
},
"attributes" : {
"type" : "object",
"properties" : {
"jobId" : {
"type" : "string",
"example" : "example"
},
"name" : {
"type" : "string",
"example" : "example"
},
"state" : {
"type" : "string",
"example" : "example"
},
"status" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "OK", "CANCELLED", "FAILED", "UNKNOWN" ]
},
"message" : {
"type" : "string",
"example" : "message"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"document" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
},
"documents" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "documents" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
}
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/jobs/MyJobId"
},
"log" : {
"type" : "string",
"example" : "server-host-name/application-path/polarion/job-report?jobId=MyJobId"
},
"downloads" : {
"type" : "array",
"example" : [ "https://testdrive.polarion.com/polarion/download/filename1", "https://testdrive.polarion.com/polarion/download/filename2" ],
"items" : {
"type" : "string"
}
}
}
}
}
}
}
},
"document_attachmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234"
}
}
}
}
},
"document_attachmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"document_attachmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
},
"document_attachmentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"lid" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
}
},
"document_attachmentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId?revision=1234"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments/MyAttachmentId/content?revision=1234"
}
}
}
}
}
}
}
},
"document_partsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "string",
"description" : "Editable only for normal and table document parts.",
"example" : ""
},
"external" : {
"type" : "boolean",
"description" : "Whether the work item is external to the document. Applicable to: workitem parts."
},
"headingText" : {
"type" : "string",
"description" : "Applicable to: heading parts.",
"example" : "Heading Title"
},
"id" : {
"type" : "string",
"example" : "workitem_MyWorkItemId"
},
"landscape" : {
"type" : "boolean",
"description" : "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts."
},
"layout" : {
"type" : "integer",
"description" : "Rendering layout index for the part. Applicable to: workitem parts.",
"format" : "int32",
"example" : 0
},
"level" : {
"type" : "integer",
"description" : "Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts.",
"format" : "int32",
"example" : 0
},
"sequence" : {
"type" : "string",
"description" : "Sequence identifier for table of figures entry. Applicable to: tof parts.",
"example" : "Table"
},
"type" : {
"type" : "string",
"description" : "Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation.",
"example" : "workitem"
},
"wikiText" : {
"type" : "string",
"description" : "Wiki markup content for the block. Applicable to: wikiblock parts.",
"example" : "#documentPanel(true \"approved\")"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"nextPart" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"previousPart" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234"
}
}
}
}
},
"document_partsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "string",
"description" : "Editable only for normal and table document parts.",
"example" : ""
},
"external" : {
"type" : "boolean",
"description" : "Whether the work item is external to the document. Applicable to: workitem parts."
},
"headingText" : {
"type" : "string",
"description" : "Applicable to: heading parts.",
"example" : "Heading Title"
},
"id" : {
"type" : "string",
"example" : "workitem_MyWorkItemId"
},
"landscape" : {
"type" : "boolean",
"description" : "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts."
},
"layout" : {
"type" : "integer",
"description" : "Rendering layout index for the part. Applicable to: workitem parts.",
"format" : "int32",
"example" : 0
},
"level" : {
"type" : "integer",
"description" : "Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts.",
"format" : "int32",
"example" : 0
},
"sequence" : {
"type" : "string",
"description" : "Sequence identifier for table of figures entry. Applicable to: tof parts.",
"example" : "Table"
},
"type" : {
"type" : "string",
"description" : "Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation.",
"example" : "workitem"
},
"wikiText" : {
"type" : "string",
"description" : "Wiki markup content for the block. Applicable to: wikiblock parts.",
"example" : "#documentPanel(true \"approved\")"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"nextPart" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"previousPart" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"document_partsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"content" : {
"type" : "string",
"description" : "Editable only for normal and table document parts.",
"example" : ""
},
"headingText" : {
"type" : "string",
"description" : "Applicable to: heading parts.",
"example" : "Heading Title"
},
"landscape" : {
"type" : "boolean",
"description" : "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts."
},
"layout" : {
"type" : "integer",
"description" : "Rendering layout index for the part. Applicable to: workitem parts.",
"format" : "int32",
"example" : 0
},
"level" : {
"type" : "integer",
"description" : "Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts.",
"format" : "int32",
"example" : 0
},
"sequence" : {
"type" : "string",
"description" : "Sequence identifier for table of figures entry. Applicable to: tof parts.",
"example" : "Table"
},
"type" : {
"type" : "string",
"description" : "Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation.",
"example" : "workitem"
},
"wikiText" : {
"type" : "string",
"description" : "Wiki markup content for the block. Applicable to: wikiblock parts.",
"example" : "#documentPanel(true \"approved\")"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"nextPart" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
}
}
},
"previousPart" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
}
}
},
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
}
}
}
}
}
},
"document_partsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234"
}
}
}
}
}
}
}
},
"document_partsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_parts" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
}
}
}
},
"document_commentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"document_commentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"document_commentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
}
}
}
}
}
}
},
"document_commentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
}
}
}
}
}
}
}
}
}
}
}
},
"document_commentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "document_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234"
}
}
}
}
}
}
}
},
"revisionsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string"
},
"internalCommit" : {
"type" : "boolean"
},
"message" : {
"type" : "string",
"example" : "Message"
},
"repositoryName" : {
"type" : "string",
"example" : "Repository name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default/1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"revisionsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "revisions" ]
},
"id" : {
"type" : "string",
"example" : "default/1234"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string"
},
"internalCommit" : {
"type" : "boolean"
},
"message" : {
"type" : "string",
"example" : "Message"
},
"repositoryName" : {
"type" : "string",
"example" : "Repository name"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default/1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/revisions/default/1234"
}
}
}
}
},
"testparameter_definitionsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestParamDefinition"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "Test Parameter Definition example"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"testparameter_definitionsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestParamDefinition"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "Test Parameter Definition example"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition"
}
}
}
}
},
"testparameter_definitionsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "Test Parameter Definition example"
}
}
}
}
}
}
}
},
"testparameter_definitionsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestParamDefinition"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition"
}
}
}
}
}
}
}
},
"testparameter_definitionsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestParamDefinition"
}
}
}
}
}
},
"testparametersListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameters" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyTestParameter"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "Example Test Parameter value"
},
"value" : {
"type" : "string",
"example" : "Example Test Parameter value"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"definition" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestParamDefinition"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"testparametersSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameters" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyTestParameter"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "Example Test Parameter value"
},
"value" : {
"type" : "string",
"example" : "Example Test Parameter value"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"definition" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameter_definitions" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestParamDefinition"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter"
}
}
}
}
},
"testparametersListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameters" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "Example Test Parameter value"
},
"value" : {
"type" : "string",
"example" : "Example Test Parameter value"
}
}
}
}
}
}
}
},
"testparametersListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameters" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyTestParameter"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testparameters/MyTestParameter"
}
}
}
}
}
}
}
},
"testparametersListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testparameters" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyTestParameter"
}
}
}
}
}
},
"testrecordsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecords" ]
},
"id" : {
"type" : "string",
"example" : "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"duration" : {
"type" : "number"
},
"executed" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"iteration" : {
"type" : "integer",
"format" : "int32",
"example" : 0
},
"result" : {
"type" : "string",
"example" : "passed"
},
"testCaseRevision" : {
"type" : "string",
"example" : "Test Case Revision"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"defect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"executedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"testCase" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0"
}
}
}
}
},
"testrecordsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecords" ]
},
"id" : {
"type" : "string",
"example" : "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"duration" : {
"type" : "number"
},
"executed" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"iteration" : {
"type" : "integer",
"format" : "int32",
"example" : 0
},
"result" : {
"type" : "string",
"example" : "passed"
},
"testCaseRevision" : {
"type" : "string",
"example" : "Test Case Revision"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"defect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"executedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"testCase" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"testrecordsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecords" ]
},
"id" : {
"type" : "string",
"example" : "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"duration" : {
"type" : "number"
},
"executed" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"result" : {
"type" : "string",
"example" : "passed"
},
"testCaseRevision" : {
"type" : "string",
"example" : "Test Case Revision"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"defect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
},
"executedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
},
"testrecordsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecords" ]
},
"id" : {
"type" : "string",
"example" : "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"duration" : {
"type" : "number"
},
"executed" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"result" : {
"type" : "string",
"example" : "passed"
},
"testCaseRevision" : {
"type" : "string",
"example" : "Test Case Revision"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"defect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
},
"executedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
},
"testrecordsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecords" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"duration" : {
"type" : "number"
},
"executed" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"result" : {
"type" : "string",
"example" : "passed"
},
"testCaseRevision" : {
"type" : "string",
"example" : "Test Case Revision"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"defect" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
},
"executedBy" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"testCase" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
}
},
"testrecordsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecords" ]
},
"id" : {
"type" : "string",
"example" : "elibrary/MyTestRunId/MyProjectId/MyTestcaseId/0"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/elibrary/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0"
}
}
}
}
}
}
}
},
"testrecord_attachmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecord_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId/content"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId"
}
}
}
}
},
"testrecord_attachmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecord_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId/content"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"testrecord_attachmentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecord_attachments" ]
},
"lid" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
}
},
"testrecord_attachmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecord_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
},
"testrecord_attachmentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecord_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/attachments/MyAttachmentId/content"
}
}
}
}
}
}
}
},
"testrecord_attachmentsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrecord_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/MyAttachmentId"
}
}
}
}
}
},
"testrun_commentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"testrun_commentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"testrun_commentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
}
}
}
}
}
}
},
"testrun_commentsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
}
}
}
}
}
}
}
},
"testrun_commentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
}
}
}
}
}
}
}
}
}
}
}
},
"testrun_commentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "testrun_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyCommentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/comments/MyCommentId?revision=1234"
}
}
}
}
}
}
}
},
"linkedoslcresourcesListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedoslcresources" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "Label"
},
"role" : {
"type" : "string",
"example" : "http://open-services.net/ns/cm#relatedChangeRequest"
},
"uri" : {
"type" : "string",
"example" : "URI"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object"
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
}
}
},
"linkedoslcresourcesListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedoslcresources" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "Label"
},
"role" : {
"type" : "string",
"example" : "http://open-services.net/ns/cm#relatedChangeRequest"
},
"uri" : {
"type" : "string",
"example" : "URI"
}
}
}
}
}
}
}
},
"linkedoslcresourcesListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedoslcresources" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId"
},
"links" : {
"type" : "object"
}
}
}
}
}
},
"linkedoslcresourcesListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedoslcresources" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId"
}
}
}
}
}
},
"workrecordsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyWorkRecordId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "string",
"example" : "Comment"
},
"date" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"id" : {
"type" : "string"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"type" : {
"type" : "string",
"example" : "task"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234"
}
}
}
}
},
"workrecordsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyWorkRecordId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "string",
"example" : "Comment"
},
"date" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"id" : {
"type" : "string"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"type" : {
"type" : "string",
"example" : "task"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"workrecordsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyWorkRecordId"
}
}
}
}
}
},
"workrecordsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "string",
"example" : "Comment"
},
"date" : {
"type" : "string",
"format" : "date",
"example" : "1970-01-01"
},
"timeSpent" : {
"type" : "string",
"example" : "5 1/2d"
},
"type" : {
"type" : "string",
"example" : "task"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
},
"workrecordsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workrecords" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyWorkRecordId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/workrecords/MyWorkRecordId?revision=1234"
}
}
}
}
}
}
}
},
"featureselectionsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "featureselections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/included/MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"selectionType" : {
"type" : "string",
"example" : "excluded",
"enum" : [ "excluded", "included", "implicitly-included" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId/MyWorkItemId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId/MyWorkItemId?revision=1234"
}
}
}
}
},
"featureselectionsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "featureselections" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/included/MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"selectionType" : {
"type" : "string",
"example" : "excluded",
"enum" : [ "excluded", "included", "implicitly-included" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"workItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId/MyWorkItemId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/featureselections/included/MyProjectId?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"teststepsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"index" : {
"type" : "string"
},
"keys" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"values" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234"
}
}
}
}
},
"teststepsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"index" : {
"type" : "string"
},
"keys" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"values" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"teststepsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"keys" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"values" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
}
}
}
}
}
}
},
"teststepsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/teststeps/MyTestStepIndex?revision=1234"
}
}
}
}
}
}
}
},
"teststepsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"attributes" : {
"type" : "object",
"properties" : {
"keys" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"values" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
}
}
}
}
}
}
},
"teststepsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"attributes" : {
"type" : "object",
"properties" : {
"keys" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"values" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
}
}
}
}
}
},
"teststepsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
}
}
}
}
}
},
"teststep_resultsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststep_results" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"result" : {
"type" : "string",
"example" : "passed"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"testStep" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1"
}
}
}
}
},
"teststep_resultsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststep_results" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"result" : {
"type" : "string",
"example" : "passed"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"testStep" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststeps" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyTestStepIndex"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"teststep_resultsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststep_results" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"result" : {
"type" : "string",
"example" : "passed"
}
}
}
}
}
}
}
},
"teststep_resultsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststep_results" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1"
}
}
}
}
}
}
}
},
"teststep_resultsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststep_results" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"result" : {
"type" : "string",
"example" : "passed"
}
}
}
}
}
}
},
"teststep_resultsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststep_results" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1"
},
"attributes" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
},
"result" : {
"type" : "string",
"example" : "passed"
}
}
}
}
}
}
}
},
"teststepresult_attachmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststepresult_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId"
}
}
}
}
},
"teststepresult_attachmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststepresult_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"id" : {
"type" : "string",
"example" : "MyAttachmentId"
},
"length" : {
"type" : "integer",
"format" : "int32"
},
"title" : {
"type" : "string",
"example" : "Title"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"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"
},
"first" : {
"type" : "string",
"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"
},
"prev" : {
"type" : "string",
"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"
},
"next" : {
"type" : "string",
"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"
},
"last" : {
"type" : "string",
"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"
}
}
}
}
},
"teststepresult_attachmentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststepresult_attachments" ]
},
"lid" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"properties" : {
"fileName" : {
"type" : "string",
"example" : "File Name"
},
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
}
},
"teststepresult_attachmentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststepresult_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId"
},
"content" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/testruns/MyTestRunId/testrecords/MyProjectId/MyTestcaseId/0/teststepresults/1/attachments/MyAttachmentId/content"
}
}
}
}
}
}
}
},
"teststepresult_attachmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststepresult_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"title" : {
"type" : "string",
"example" : "Title"
}
}
}
}
}
}
},
"teststepresult_attachmentsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "teststepresult_attachments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyTestRunId/MyProjectId/MyTestcaseId/0/1/MyAttachmentId"
}
}
}
}
}
},
"workitem_approvalsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"example" : "waiting",
"enum" : [ "waiting", "approved", "disapproved" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234"
}
}
}
}
},
"workitem_approvalsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"example" : "waiting",
"enum" : [ "waiting", "approved", "disapproved" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"workitem_approvalsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"example" : "waiting",
"enum" : [ "waiting", "approved", "disapproved" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
}
}
}
}
}
},
"workitem_approvalsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/approvals/MyUserId?revision=1234"
}
}
}
}
}
}
}
},
"workitem_approvalsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
}
}
}
}
}
},
"workitem_approvalsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"example" : "waiting",
"enum" : [ "waiting", "approved", "disapproved" ]
}
}
}
}
}
}
},
"workitem_approvalsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitem_approvals" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId/MyUserId"
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"example" : "waiting",
"enum" : [ "waiting", "approved", "disapproved" ]
}
}
}
}
}
}
}
},
"metadataSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "metadata" ]
},
"id" : {
"type" : "string",
"example" : "metadata"
},
"attributes" : {
"type" : "object",
"properties" : {
"apiProperties" : {
"type" : "object",
"properties" : {
"defaultPageSize" : {
"type" : "integer",
"example" : 100
},
"bodySizeLimit" : {
"type" : "integer",
"example" : 2097152
},
"maxIncludedSize" : {
"type" : "integer",
"example" : 500
},
"maxPageSize" : {
"type" : "integer",
"example" : 200
},
"maxRelationshipSize" : {
"type" : "integer",
"example" : 100
}
}
},
"build" : {
"type" : "string",
"example" : "20250613-1404-master-e594c717"
},
"cluster" : {
"type" : "string",
"example" : "cluster1"
},
"logoUrl" : {
"type" : "string",
"example" : "/images/logos/repo_login_logo.png"
},
"node" : {
"type" : "string",
"example" : "node2"
},
"timezone" : {
"type" : "string",
"example" : "+05:30"
},
"version" : {
"type" : "string",
"example" : "3.25.12"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/metadata"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/metadata"
}
}
}
}
},
"license_assignmentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_assignments" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "LOGGED_IN", "EXPIRING", "INACTIVE" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"addOnSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"baseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
},
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments/MyUserId"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"license_assignmentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_assignments" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"attributes" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "LOGGED_IN", "EXPIRING", "INACTIVE" ]
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"addOnSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"baseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
},
"user" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments/MyUserId"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/assignments/MyUserId"
}
}
}
}
},
"license_assignmentsListPatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_assignments" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"relationships" : {
"type" : "object",
"properties" : {
"addOnSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
},
"baseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
}
}
}
}
}
}
},
"license_assignmentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_assignments" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"relationships" : {
"type" : "object",
"properties" : {
"addOnSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
},
"baseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
}
}
}
}
}
},
"license_slotsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
},
"attributes" : {
"type" : "object",
"properties" : {
"configured" : {
"type" : "integer",
"format" : "int32"
},
"expirationDate" : {
"type" : "string",
"format" : "date"
},
"free" : {
"type" : "integer",
"format" : "int32"
},
"group" : {
"type" : "string",
"example" : "groupName"
},
"model" : {
"type" : "string",
"example" : "named"
},
"peak" : {
"type" : "integer",
"format" : "int32"
},
"total" : {
"type" : "integer",
"format" : "int32"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"license_slotsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
},
"license_slotsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"group" : {
"type" : "string",
"example" : "groupName"
},
"total" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}
}
}
},
"license_slotsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId"
}
}
}
}
}
}
}
},
"license_slotsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
},
"attributes" : {
"type" : "object",
"properties" : {
"configured" : {
"type" : "integer",
"format" : "int32"
},
"expirationDate" : {
"type" : "string",
"format" : "date"
},
"free" : {
"type" : "integer",
"format" : "int32"
},
"group" : {
"type" : "string",
"example" : "groupName"
},
"model" : {
"type" : "string",
"example" : "named"
},
"peak" : {
"type" : "integer",
"format" : "int32"
},
"total" : {
"type" : "integer",
"format" : "int32"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license/types/LicenseType/slots/ModelType/GroupId"
}
}
}
}
},
"page_commentsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
}
}
}
}
}
}
},
"page_commentsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234"
}
}
}
}
},
"page_commentsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
}
}
}
}
}
}
}
}
}
}
}
},
"page_commentsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234"
}
}
}
}
}
}
}
},
"page_commentsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
},
"attributes" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"format" : "date-time",
"example" : "1970-01-01T00:00:00Z"
},
"id" : {
"type" : "string",
"example" : "MyCommentId"
},
"resolved" : {
"type" : "boolean"
},
"text" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "text/html", "text/plain" ]
},
"value" : {
"type" : "string",
"example" : "My text value"
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"author" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "users" ]
},
"id" : {
"type" : "string",
"example" : "MyUserId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"childComments" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"parentComment" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "page_comments" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyRichPageId/MyCommentId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
},
"project" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "projects" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId"
},
"revision" : {
"type" : "string",
"example" : "1234"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments/MyCommentId?revision=1234"
}
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=5"
},
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/pages/MyRichPageId/comments?page%5Bsize%5D=10&page%5Bnumber%5D=9"
}
}
}
}
},
"customfieldsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "customfields" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"fields" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"required" : {
"type" : "boolean"
},
"defaultValue" : {
"type" : "string"
},
"dependsOn" : {
"type" : "string"
},
"type" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "string",
"example" : "string"
}
}
},
"parameters" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "parameter1"
},
"name" : {
"type" : "string",
"example" : "parameter1"
},
"title" : {
"type" : "string",
"example" : "MyParameter"
}
}
}
}
}
}
},
"resourceType" : {
"type" : "string",
"example" : "id"
},
"targetType" : {
"type" : "string",
"example" : "id"
}
}
}
}
}
}
}
},
"customfieldsListPostResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "customfields" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/workitems/epic"
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic"
}
}
}
}
}
}
}
},
"customfieldsSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "customfields" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/workitems/epic"
},
"attributes" : {
"type" : "object",
"properties" : {
"fields" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"required" : {
"type" : "boolean"
},
"defaultValue" : {
"type" : "string"
},
"dependsOn" : {
"type" : "string"
},
"type" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "string",
"example" : "string"
}
}
},
"parameters" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "parameter1"
},
"name" : {
"type" : "string",
"example" : "parameter1"
},
"title" : {
"type" : "string",
"example" : "MyParameter"
}
}
}
}
}
}
},
"resourceType" : {
"type" : "string",
"example" : "id"
},
"targetType" : {
"type" : "string",
"example" : "id"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/customfields/workitems/epic"
}
}
}
}
},
"customfieldsSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "customfields" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/workitems/epic"
},
"attributes" : {
"type" : "object",
"properties" : {
"fields" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"required" : {
"type" : "boolean"
},
"defaultValue" : {
"type" : "string"
},
"dependsOn" : {
"type" : "string"
},
"type" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "string",
"example" : "string"
}
}
},
"parameters" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string",
"example" : "parameter1"
},
"name" : {
"type" : "string",
"example" : "parameter1"
},
"title" : {
"type" : "string",
"example" : "MyParameter"
}
}
}
}
}
}
}
}
}
}
}
}
},
"licenseSingleGetResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license" ]
},
"id" : {
"type" : "string",
"example" : "license"
},
"attributes" : {
"type" : "object",
"properties" : {
"limits" : {
"type" : "object",
"properties" : {
"projects" : {
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer"
},
"currentCount" : {
"type" : "integer"
}
}
},
"documentsAndPages" : {
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer"
},
"currentCount" : {
"type" : "integer"
}
}
},
"workitems" : {
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer"
},
"currentCount" : {
"type" : "integer"
}
}
}
}
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"defaultAddOnLicenseSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
},
"defaultBaseLicenseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license"
}
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/license"
}
}
}
}
},
"licenseSinglePatchRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license" ]
},
"id" : {
"type" : "string",
"example" : "license"
},
"relationships" : {
"type" : "object",
"properties" : {
"defaultAddOnLicenseSlots" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
},
"defaultBaseLicenseSlot" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "license_slots" ]
},
"id" : {
"type" : "string",
"example" : "LicenseType/ModelType/GroupId"
}
}
}
}
}
}
}
}
}
}
},
"llmsListGetResponse" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "llms" ]
},
"id" : {
"type" : "string",
"example" : "myLlm"
},
"attributes" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : "myLlm"
}
}
},
"meta" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"links" : {
"type" : "object"
}
}
}
},
"included" : {
"type" : "array",
"description" : "Related entities might be returned, see REST API User Guide.",
"items" : {
"type" : "object"
}
}
}
},
"relationshipsListDeleteRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections", "categories", "documents", "document_attachments", "document_comments", "document_parts", "enumerations", "globalroles", "icons", "jobs", "linkedworkitems", "externallylinkedworkitems", "linkedoslcresources", "llms", "pages", "page_attachments", "page_comments", "plans", "projectroles", "projectgroups", "projects", "projecttemplates", "spaces", "testparameters", "testparameter_definitions", "testrecords", "teststep_results", "testruns", "testrun_attachments", "teststepresult_attachments", "testrun_comments", "usergroups", "users", "workitems", "workitem_attachments", "workitem_approvals", "workitem_comments", "featureselections", "teststeps", "workrecords", "revisions", "testrecord_attachments", "license_slots", "license_types", "license", "metadata", "license_assignments", "customfields" ]
},
"id" : {
"type" : "string",
"example" : "MyResourceId"
}
}
}
}
}
},
"sparseFields" : {
"type" : "object",
"properties" : {
"collections" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"categories" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"documents" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"document_attachments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"document_comments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"document_parts" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"enumerations" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"globalroles" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"icons" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"jobs" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"linkedworkitems" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"externallylinkedworkitems" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"linkedoslcresources" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"llms" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"pages" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"page_attachments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"page_comments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"plans" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"projectroles" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"projects" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"projecttemplates" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testparameters" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testparameter_definitions" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testrecords" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"teststep_results" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testruns" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testrun_attachments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"teststepresult_attachments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testrun_comments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"usergroups" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"users" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"workitems" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"workitem_attachments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"workitem_approvals" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"workitem_comments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"featureselections" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"teststeps" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"workrecords" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"revisions" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"testrecord_attachments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"license_slots" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"license_types" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"license" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"metadata" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"license_assignments" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
},
"customfields" : {
"type" : "string",
"description" : "Requested fields",
"example" : "@all"
}
}
},
"errors" : {
"type" : "object",
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "HTTP status code applicable to this problem.",
"example" : "400"
},
"title" : {
"type" : "string",
"description" : "Short, human-readable summary of the problem.",
"example" : "Bad Request"
},
"detail" : {
"type" : "string",
"description" : "Human-readable explanation specific to this occurrence of the problem.",
"example" : "Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)"
},
"source" : {
"type" : "object",
"properties" : {
"pointer" : {
"type" : "string",
"description" : "JSON Pointer to the associated entity in the request document.",
"example" : "$.data"
},
"parameter" : {
"type" : "string",
"description" : "String indicating which URI query parameter caused the error.",
"example" : "revision"
},
"resource" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "MyProjectId/id"
},
"type" : {
"type" : "string",
"example" : "type"
}
},
"description" : "Resource causing the error."
}
}
}
}
}
}
}
},
"branchDocumentRequestBody" : {
"type" : "object",
"properties" : {
"targetProjectId" : {
"type" : "string",
"description" : "Project where new document will be created.",
"example" : "MyProjectId"
},
"targetSpaceId" : {
"type" : "string",
"description" : "Space where new document will be created.",
"example" : "MySpaceId"
},
"targetDocumentName" : {
"type" : "string",
"description" : "Name for new Document.",
"example" : "MyDocumentId"
},
"copyWorkflowStatusAndSignatures" : {
"type" : "boolean",
"description" : "Specifies that workflow status and signatures should be copied to the branched document.",
"example" : false
},
"query" : {
"type" : "string",
"description" : "Specifies optional filtering query.",
"example" : "status:open"
}
}
},
"mergeDocumentRequestBody" : {
"type" : "object",
"properties" : {
"createBaseline" : {
"type" : "boolean",
"description" : "Specifies whether the Baseline should be created.",
"example" : true
},
"userFilter" : {
"type" : "string",
"description" : "Specifies the query to filter the source Work Items for the merge.",
"example" : "status:open"
}
}
},
"branchDocumentsRequestBody" : {
"required" : [ "documentConfigurations" ],
"type" : "object",
"properties" : {
"documentConfigurations" : {
"minItems" : 1,
"type" : "array",
"items" : {
"required" : [ "sourceDocument" ],
"type" : "object",
"properties" : {
"sourceDocument" : {
"type" : "string",
"description" : "Reference path of the source Document.",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"sourceRevision" : {
"type" : "string",
"description" : "Revision of the source Document.",
"example" : "1234"
},
"targetProjectId" : {
"type" : "string",
"description" : "Project where new document will be created.",
"example" : "MyProjectId"
},
"targetSpaceId" : {
"type" : "string",
"description" : "Space where new document will be created.",
"example" : "MySpaceId"
},
"targetDocumentName" : {
"type" : "string",
"description" : "Name for new Document.",
"example" : "MyDocumentId"
},
"copyWorkflowStatusAndSignatures" : {
"type" : "boolean",
"description" : "Specifies that workflow status and signatures should be copied to the branched document.",
"example" : false
},
"query" : {
"type" : "string",
"description" : "Specifies optional filtering query.",
"example" : "status:open"
},
"targetDocumentTitle" : {
"type" : "string",
"description" : "Title for new Document.",
"example" : "My Document Title"
},
"updateTitleHeading" : {
"type" : "boolean",
"description" : "Specifies that title heading of the target Document should be set to the new Document's title.",
"example" : false
},
"overwriteWorkItems" : {
"type" : "boolean",
"description" : "Specifies that Work Items in the branched Document should be overwritten (instead of being referenced).",
"example" : false
},
"initializedFields" : {
"type" : "array",
"description" : "Specifies fields of overwritten Work Items that should be initialized (instead of being copied from source Work Items).",
"items" : {
"type" : "string",
"example" : "severity"
}
}
}
}
}
}
},
"createProjectRequestBody" : {
"type" : "object",
"properties" : {
"projectId" : {
"type" : "string",
"description" : "Id of the new Project to be created.",
"nullable" : false,
"example" : "MyProjectId"
},
"trackerPrefix" : {
"type" : "string",
"description" : "Tracker prefix of the new Project to be created.",
"nullable" : false,
"example" : "MyTrackerPrefix"
},
"location" : {
"type" : "string",
"description" : "Location of the new Project to be created.",
"nullable" : false,
"example" : "MyLocation"
},
"templateId" : {
"type" : "string",
"description" : "Id of the template to create the new Project from.",
"nullable" : true,
"example" : "MyProjectTemplateId"
},
"params" : {
"type" : "object",
"description" : "Parameters of new Project to be created.",
"nullable" : true
}
}
},
"executeJobRequestBody" : {
"type" : "object",
"properties" : {
"jobId" : {
"type" : "string",
"description" : "Id of job factory, e.g. jobs.cleanup",
"nullable" : false,
"example" : "MyJobId"
},
"name" : {
"type" : "string",
"nullable" : false,
"example" : "My Job"
},
"scope" : {
"type" : "string",
"description" : "Scope of the job. Accepted formats: 'system', 'project:{projectId}', or 'path:/{path}'.",
"nullable" : true,
"example" : "system"
},
"nodeId" : {
"type" : "string",
"nullable" : true,
"example" : "MyNodeId"
},
"params" : {
"type" : "object",
"properties" : {
"param1" : {
"type" : "string",
"example" : "value1"
},
"param2" : {
"type" : "string",
"example" : "value2"
}
},
"description" : "Parameters of Job to be executed.",
"nullable" : true
}
}
},
"moveProjectRequestBody" : {
"type" : "object",
"properties" : {
"location" : {
"type" : "string",
"description" : "Location of the new Project to be created.",
"nullable" : false,
"example" : "MyLocation"
}
}
},
"copyDocumentRequestBody" : {
"type" : "object",
"properties" : {
"targetProjectId" : {
"type" : "string",
"description" : "Project where new document will be created.",
"example" : "MyProjectId"
},
"targetSpaceId" : {
"type" : "string",
"description" : "Space where new document will be created.",
"example" : "MySpaceId"
},
"targetDocumentName" : {
"type" : "string",
"description" : "Name for new Document.",
"example" : "MyDocumentId"
},
"removeOutgoingLinks" : {
"type" : "boolean",
"description" : "Should outgoing links be removed?",
"example" : true
},
"linkOriginalItemsWithRole" : {
"type" : "string",
"description" : "Link a copy of the document to the original.",
"example" : "duplicates"
}
}
},
"moveWorkItemToDocumentRequestBody" : {
"type" : "object",
"properties" : {
"targetDocument" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"previousPart" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"nextPart" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
},
"moveWorkItemsToDocumentRequestBody" : {
"type" : "object",
"properties" : {
"targetDocument" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId"
},
"workItemGroups" : {
"type" : "array",
"example" : [ {
"workItemIds" : [ "MyProjectId/WI-123", "MyProjectId/WI-124" ],
"previousPart" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}, {
"workItemIds" : [ "MyProjectId/WI-125" ],
"nextPart" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
} ],
"items" : {
"type" : "object",
"properties" : {
"workItemIds" : {
"type" : "array",
"example" : [ "MyProjectId/WI-123", "MyProjectId/WI-124" ],
"items" : {
"type" : "string",
"description" : "The Work Item's path in the following format: ProjectId/workItemId"
}
},
"previousPart" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"nextPart" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
}
}
}
},
"moveDocumentPartRequestBody" : {
"type" : "object",
"properties" : {
"before" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"after" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"parent" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
},
"overwriteDocumentPartsRequestBody" : {
"required" : [ "partIds" ],
"type" : "object",
"properties" : {
"partIds" : {
"type" : "array",
"description" : "The list of Document Part IDs to overwrite.",
"items" : {
"type" : "string",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
}
},
"overwriteDocumentPartsResponseBody" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"overwrittenParts" : {
"type" : "array",
"description" : "Array of Part ID mappings showing old and new IDs.",
"items" : {
"type" : "object",
"properties" : {
"newPartId" : {
"type" : "string",
"description" : "New Part ID after overwrite operation.",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
},
"oldPartId" : {
"type" : "string",
"description" : "Original Part ID before overwrite operation.",
"example" : "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"
}
}
}
}
}
}
}
},
"importTestResultsRequestBody" : {
"type" : "object",
"properties" : {
"retest" : {
"type" : "boolean",
"example" : false
},
"defectTemplateId" : {
"type" : "string",
"example" : "MyProjectId/MyDefectId"
}
}
},
"setLicenseRequestBody" : {
"type" : "object",
"properties" : {
"license" : {
"type" : "string",
"description" : "User's license type",
"enum" : [ "REVIEWER", "XReviewer", "XBase", "XEssentials", "XPro", "XStandard", "XEnterprise", "XAdvanced", "XExtended", "XPremium", "XAutomotive", "PRO", "REQUIREMENTS", "QA", "ALM" ]
},
"group" : {
"type" : "string",
"description" : "License group",
"example" : "Department"
},
"concurrent" : {
"type" : "boolean",
"description" : "Is concurrent user",
"example" : true
}
}
},
"enumOptionsActionResponseBody" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "open"
},
"name" : {
"type" : "string",
"example" : "Open"
},
"color" : {
"type" : "string",
"example" : "#F9FF4D"
},
"description" : {
"type" : "string",
"example" : "Description"
},
"hidden" : {
"type" : "boolean",
"example" : false
},
"default" : {
"type" : "boolean",
"example" : true
},
"parent" : {
"type" : "boolean",
"example" : true
},
"oppositeName" : {
"type" : "string",
"example" : "Opposite Name"
},
"columnWidth" : {
"type" : "string",
"example" : "90%"
},
"iconURL" : {
"type" : "string",
"example" : "/polarion/icons/default/enums/status_open.gif"
},
"createDefect" : {
"type" : "boolean",
"example" : true
},
"templateWorkItem" : {
"type" : "string",
"example" : "exampleTemplate"
},
"minValue" : {
"type" : "number",
"example" : 30.0
},
"requiresSignatureForTestCaseExecution" : {
"type" : "boolean",
"example" : true
},
"terminal" : {
"type" : "boolean",
"example" : true
},
"limited" : {
"type" : "boolean",
"example" : true
},
"linkRules" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"fromTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"toTypes" : {
"type" : "array",
"example" : [ "requirement" ],
"items" : {
"type" : "string"
}
},
"sameType" : {
"type" : "boolean",
"example" : false
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9"
},
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5"
}
}
}
}
},
"workflowActionsActionResponseBody" : {
"type" : "object",
"properties" : {
"meta" : {
"type" : "object",
"properties" : {
"totalCount" : {
"type" : "integer",
"format" : "int32"
}
}
},
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : "0"
},
"available" : {
"type" : "boolean"
},
"clearedFields" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"isSignatureRequired" : {
"type" : "boolean"
},
"isAddingSignature" : {
"type" : "boolean"
},
"nativeActionId" : {
"type" : "string",
"example" : "nativeActionId"
},
"name" : {
"type" : "string",
"example" : "actionName"
},
"requiredFields" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"targetStatus" : {
"type" : "string",
"example" : "done"
},
"unavailableReason" : {
"type" : "string",
"example" : null
},
"requiredRoles" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"first" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1"
},
"prev" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4"
},
"next" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6"
},
"last" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9"
},
"self" : {
"type" : "string",
"example" : "server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5"
}
}
}
}
},
"fieldsMetadataActionResponseBody" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"relationships" : {
"type" : "object",
"properties" : {
"relationshipField" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "field-label"
},
"type" : {
"type" : "object",
"properties" : {
"multi" : {
"type" : "boolean",
"example" : true
},
"targetResourceTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"example" : "resource-type"
}
},
"kind" : {
"type" : "string",
"example" : "relationship"
}
}
}
}
}
}
},
"attributes" : {
"type" : "object",
"properties" : {
"enumField" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "field-label"
},
"type" : {
"type" : "object",
"properties" : {
"enumContext" : {
"type" : "string",
"example" : "enum-context"
},
"enumName" : {
"type" : "string",
"example" : "enum-name"
},
"kind" : {
"type" : "string",
"example" : "enumeration"
}
}
}
}
},
"structField" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "field-label"
},
"type" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "string",
"example" : "structure"
},
"structureName" : {
"type" : "string",
"example" : "structureId"
}
}
}
}
},
"listField" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "field-label"
},
"type" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "string",
"example" : "list"
},
"itemType" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "object",
"properties" : {
"enum" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "string", "text", "text/html", "integer", "float", "currency", "time", "date", "date-time", "boolean", "structure", "relationship" ]
}
}
}
}
}
}
}
}
}
},
"primitiveField" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string",
"example" : "field-label"
},
"type" : {
"type" : "object",
"properties" : {
"kind" : {
"type" : "object",
"properties" : {
"enum" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "string", "text", "text/html", "integer", "float", "currency", "time", "date", "date-time", "boolean" ]
}
}
}
}
}
}
}
}
}
}
}
},
"links" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : "http://localhost:8888/polarion/rest/v1/projects/MyProjectId/actions/getFieldsMetadata?resourceType=MyResourceType&targetType=MyTargetType"
}
}
}
}
},
"backlinkedworkitemsListPostRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "linkedworkitems" ]
},
"attributes" : {
"type" : "object",
"properties" : {
"revision" : {
"type" : "string",
"example" : "1234"
},
"role" : {
"type" : "string",
"example" : "relates_to"
},
"suspect" : {
"type" : "boolean"
}
}
},
"relationships" : {
"type" : "object",
"properties" : {
"sourceWorkItem" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "workitems" ]
},
"id" : {
"type" : "string",
"example" : "MyProjectId/MyWorkItemId"
}
}
}
}
}
}
}
}
}
}
}
},
"reuseCollectionRequestBody" : {
"type" : "object",
"properties" : {
"targetProjectId" : {
"type" : "string",
"description" : "Project where new Collection will be created.",
"example" : "MyProjectId"
},
"targetCollectionName" : {
"type" : "string",
"description" : "The name of the new Collection.",
"example" : "Name"
}
}
},
"SparseFields" : {
"$ref" : "#/components/schemas/sparseFields"
},
"ResourceQueryContext" : {
"type" : "object",
"properties" : {
"contextResourceReference" : {
"$ref" : "#/components/schemas/ResourceReference"
}
}
},
"ResourceReference" : {
"type" : "object",
"properties" : {
"containedResource" : {
"type" : "boolean"
}
}
},
"RelationshipDataBody" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "collections", "categories", "documents", "document_attachments", "document_comments", "document_parts", "enumerations", "globalroles", "icons", "jobs", "linkedworkitems", "externallylinkedworkitems", "linkedoslcresources", "llms", "pages", "page_attachments", "page_comments", "plans", "projectroles", "projectgroups", "projects", "projecttemplates", "spaces", "testparameters", "testparameter_definitions", "testrecords", "teststep_results", "testruns", "testrun_attachments", "teststepresult_attachments", "testrun_comments", "usergroups", "users", "workitems", "workitem_attachments", "workitem_approvals", "workitem_comments", "featureselections", "teststeps", "workrecords", "revisions", "testrecord_attachments", "license_slots", "license_types", "license", "metadata", "license_assignments", "customfields" ]
},
"id" : {
"type" : "string",
"example" : "MyResourceId"
}
}
},
"RelationshipDataListResponse" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RelationshipDataBody"
}
}
}
},
"RelationshipDataSingleResponse" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/RelationshipDataBody"
}
}
},
"RelationshipResponseBody" : {
"type" : "object",
"description" : "The Relationship's response body. Can return a single or a list of instances",
"example" : {
"data" : [ {
"type" : "workitems",
"id" : "MyProjectId/WI-123"
} ]
},
"oneOf" : [ {
"$ref" : "#/components/schemas/RelationshipDataSingleResponse"
}, {
"$ref" : "#/components/schemas/RelationshipDataListResponse"
} ]
},
"RelationshipDataListRequest" : {
"type" : "object",
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RelationshipDataBody"
}
}
}
},
"RelationshipDataSingleRequest" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/RelationshipDataBody"
}
}
},
"RelationshipsRequestWithRevisionBody" : {
"type" : "object",
"description" : "List of generic contents",
"example" : {
"data" : [ {
"type" : "workitems",
"id" : "MyProjectId/WI-123",
"revision" : "1234"
} ]
},
"oneOf" : [ {
"$ref" : "#/components/schemas/RelationshipDataSingleRequest"
}, {
"$ref" : "#/components/schemas/RelationshipDataListRequest"
} ]
},
"PatchDocumentAttachmentsRequestBody" : {
"title" : "PatchDocumentAttachmentsRequestBody",
"required" : [ "resource" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/document_attachmentsSinglePatchRequest"
},
"content" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
},
"PostDocumentAttachmentsRequestBody" : {
"title" : "PostDocumentAttachmentsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/document_attachmentsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
}
},
"importWordDocumentParameters" : {
"required" : [ "documentName", "documentType", "title" ],
"type" : "object",
"properties" : {
"documentName" : {
"type" : "string",
"description" : "Unique document name/ID for the imported document.",
"example" : "REQ-001"
},
"title" : {
"type" : "string",
"description" : "Title for the imported document.",
"example" : "System Requirements"
},
"documentType" : {
"type" : "string",
"description" : "Document type for the imported document (e.g., 'generic').",
"example" : "generic"
},
"configurationId" : {
"type" : "string",
"description" : "Optional configuration ID referencing a preexisting import configuration template. If not provided, default import behavior will be used.",
"example" : "Default.xml"
}
},
"description" : "Parameters for Word document import",
"example" : {
"documentName" : "REQ-001",
"title" : "System Requirements",
"documentType" : "generic",
"configurationId" : "Default.xml"
}
},
"importWordDocumentRequestBody" : {
"required" : [ "file", "parameters" ],
"type" : "object",
"properties" : {
"file" : {
"type" : "string",
"description" : "Word document file (.docx) to import.",
"format" : "binary"
},
"parameters" : {
"$ref" : "#/components/schemas/importWordDocumentParameters"
}
},
"description" : "Request body for importing a Word document"
},
"PostIconsRequestBody" : {
"title" : "PostIconsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/iconsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "icons' content",
"format" : "binary"
}
}
}
},
"GenerateCompletionMessage" : {
"required" : [ "content", "role" ],
"type" : "object",
"properties" : {
"role" : {
"type" : "string",
"description" : "Role of the message sender, e.g., 'user' or 'assistant.'",
"example" : "user"
},
"content" : {
"type" : "string",
"description" : "Content of the message."
}
},
"description" : "A message in the LLM completion generation request or response."
},
"GenerateCompletionResult" : {
"required" : [ "message" ],
"type" : "object",
"properties" : {
"message" : {
"$ref" : "#/components/schemas/GenerateCompletionMessage"
}
},
"description" : "The result of a completion generation request."
},
"generateCompletionResponseBody" : {
"type" : "object",
"properties" : {
"data" : {
"$ref" : "#/components/schemas/GenerateCompletionResult"
}
},
"description" : "Response body for LLM completion generation."
},
"GenerateCompletionResponseFormat" : {
"required" : [ "type" ],
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"description" : "Type of the response format. Defaults to 'text'.",
"example" : "jsonSchema",
"enum" : [ "text", "json", "jsonSchema" ]
},
"schema" : {
"type" : "object",
"description" : "The JSON schema to use when type is 'jsonSchema'.",
"example" : {
"type" : "object",
"properties" : {
"result" : {
"type" : "string"
}
}
}
}
},
"description" : "Response format for LLM completion generation."
},
"generateCompletionRequestBody" : {
"required" : [ "messages" ],
"type" : "object",
"properties" : {
"model" : {
"type" : "string",
"description" : "Name of the LLM to use. If not specified, the default model will be used, if available."
},
"messages" : {
"type" : "array",
"description" : "Prompt messages.",
"items" : {
"$ref" : "#/components/schemas/GenerateCompletionMessage"
}
},
"responseFormat" : {
"$ref" : "#/components/schemas/GenerateCompletionResponseFormat"
}
},
"description" : "Generate completion parameters."
},
"RelationshipsRequestBody" : {
"type" : "object",
"description" : "List of generic contents",
"example" : {
"data" : [ {
"type" : "workitems",
"id" : "MyProjectId/WI-123"
} ]
},
"oneOf" : [ {
"$ref" : "#/components/schemas/RelationshipDataSingleRequest"
}, {
"$ref" : "#/components/schemas/RelationshipDataListRequest"
} ]
},
"PatchPageAttachmentsRequestBody" : {
"title" : "PatchPageAttachmentsRequestBody",
"required" : [ "resource" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/page_attachmentsSinglePatchRequest"
},
"content" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
},
"PostPageAttachmentsRequestBody" : {
"title" : "PostPageAttachmentsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/page_attachmentsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
}
},
"PatchTestRecordAttachmentsRequestBody" : {
"title" : "PatchTestRecordAttachmentsRequestBody",
"required" : [ "resource" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/testrecord_attachmentsSinglePatchRequest"
},
"content" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
},
"PostTestRecordAttachmentsRequestBody" : {
"title" : "PostTestRecordAttachmentsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/testrecord_attachmentsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
}
},
"PatchTestRunAttachmentsRequestBody" : {
"title" : "PatchTestRunAttachmentsRequestBody",
"required" : [ "resource" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/testrun_attachmentsSinglePatchRequest"
},
"content" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
},
"PostTestRunAttachmentsRequestBody" : {
"title" : "PostTestRunAttachmentsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/testrun_attachmentsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
}
},
"PostImportActionRequestBody" : {
"title" : "PostImportActionRequestBody",
"required" : [ "file" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/importTestResultsRequestBody"
},
"file" : {
"type" : "string",
"description" : "excel file content",
"format" : "binary"
}
}
},
"PatchTestStepResultAttachmentsRequestBody" : {
"title" : "PatchTestStepResultAttachmentsRequestBody",
"required" : [ "resource" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/teststepresult_attachmentsSinglePatchRequest"
},
"content" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
},
"PostTestStepResultAttachmentsRequestBody" : {
"title" : "PostTestStepResultAttachmentsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/teststepresult_attachmentsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
}
},
"updateAvatarRequestBody" : {
"title" : "UpdateAvatarRequestBody",
"type" : "object",
"properties" : {
"content" : {
"type" : "string",
"description" : "avatar content",
"format" : "binary"
}
}
},
"PatchWorkItemAttachmentsRequestBody" : {
"title" : "PatchWorkItemAttachmentsRequestBody",
"required" : [ "resource" ],
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/workitem_attachmentsSinglePatchRequest"
},
"content" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
},
"PostWorkItemAttachmentsRequestBody" : {
"title" : "PostWorkItemAttachmentsRequestBody",
"type" : "object",
"properties" : {
"resource" : {
"$ref" : "#/components/schemas/workitem_attachmentsListPostRequest"
},
"files" : {
"type" : "array",
"items" : {
"type" : "string",
"description" : "attachments content",
"format" : "binary"
}
}
}
}
},
"securitySchemes" : {
"bearerAuth" : {
"type" : "http",
"scheme" : "bearer",
"bearerFormat" : "JWT"
}
}
}
}