| Open api | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
{
"openapi" : "3.0.1",
"info" : {
"title" : "Test Management for Jira (T4J)",
"description" : "Endpoints provided by T4J.",
"version" : "2.0"
},
"paths" : {
"/attachments/{id}" : {
"get" : {
"tags" : [ "attachments" ],
"summary" : "Gets folder attachment information.",
"description" : "Gets folder attachment information by attachment id.",
"operationId" : "getAttachment",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Attachment id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "attachments" ],
"summary" : "Deletes folder attachment.",
"description" : "Deletes folder attachment by attachment id.",
"operationId" : "deleteAttachment",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Attachment id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/attachments/{id}/download" : {
"get" : {
"tags" : [ "attachments" ],
"summary" : "Gets folder attachment stream.",
"description" : "Gets folder attachment stream by attachment id.",
"operationId" : "downloadAttachment",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Attachment id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/octet-stream" : { }
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/coverage/views" : {
"get" : {
"tags" : [ "coverage" ],
"summary" : "Gets coverage views of project.",
"description" : "Gets coverage views of project.",
"operationId" : "getCoverageViews",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
},
"post" : {
"tags" : [ "coverage" ],
"summary" : "Creates coverage view.",
"description" : "Creates coverage view in project.",
"operationId" : "addCoverageView",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Coverage view request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}" : {
"get" : {
"tags" : [ "coverage" ],
"summary" : "Gets coverage view.",
"description" : "Gets coverage view by view id.",
"operationId" : "getCoverageView",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "isPublic",
"in" : "query",
"description" : "Indicator if coverage view is personal or public.",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
},
"put" : {
"tags" : [ "coverage" ],
"summary" : "Updates coverage view.",
"description" : "Updates coverage view in project.",
"operationId" : "updateCoverageView",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "isPublic",
"in" : "query",
"description" : "Indicator if coverage view is personal or public.",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"requestBody" : {
"description" : "Coverage view request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "coverage" ],
"summary" : "Deletes coverage view.",
"description" : "Deletes coverage view by view id.",
"operationId" : "removeCoverageView",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "isPublic",
"in" : "query",
"description" : "Indicator if coverage view is personal or public.",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}/columns" : {
"post" : {
"tags" : [ "coverage" ],
"summary" : "Adds coverage view column.",
"description" : "Adds coverage view column.",
"operationId" : "addCoverageViewColumn",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "isPublic",
"in" : "query",
"description" : "Indicator if coverage view is personal or public.",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"requestBody" : {
"description" : "Coverage view column request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewColumnData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewColumnData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "coverage" ],
"summary" : "Removes coverage view column.",
"description" : "Removes coverage view column.",
"operationId" : "removeCoverageViewColumn",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "isPublic",
"in" : "query",
"description" : "Indicator if coverage view is personal or public.",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}/columns/{position}" : {
"put" : {
"tags" : [ "coverage" ],
"summary" : "Updates coverage view column.",
"description" : "Updates coverage view column.",
"operationId" : "updateCoverageViewColumn",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "position",
"in" : "path",
"description" : "Position of coverage view column. Starts at 1.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "isPublic",
"in" : "query",
"description" : "Indicator if coverage view is personal or public.",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"requestBody" : {
"description" : "Coverage view column request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewColumnData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewColumnData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}/move/public" : {
"put" : {
"tags" : [ "coverage" ],
"summary" : "Moves coverage view from personal to public.",
"description" : "Moves coverage view from personal to public.",
"operationId" : "moveCoverageViewPrivateToPublic",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}/move/private" : {
"put" : {
"tags" : [ "coverage" ],
"summary" : "Moves coverage view from public to personal.",
"description" : "Moves coverage view from public to personal.",
"operationId" : "moveCoverageViewPublicToPrivate",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Coverage view id.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
}, {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageViewData"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
}
}
}
},
"/projects/{projectKey}/definitions/folders/{id}" : {
"get" : {
"tags" : [ "definition-tree" ],
"summary" : "Gets definition folder structure.",
"description" : "Gets definition folder structure by folder id.",
"operationId" : "getDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Definition folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "includeIssues",
"in" : "query",
"description" : "Indicator to include issues in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestSteps",
"in" : "query",
"description" : "Indicator to include test steps in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestParameters",
"in" : "query",
"description" : "Indicator to include test parameters in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "prefixFolders",
"in" : "query",
"description" : "Indicator to include numbering in folder names.",
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
},
"put" : {
"tags" : [ "definition-tree" ],
"summary" : "Updates definition folder.",
"description" : "Updates definition folder by folder id.",
"operationId" : "updateDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Definition folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Definition folder request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderCreateData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "definition-tree" ],
"summary" : "Deletes definition folder.",
"description" : "Deletes definition folder by folder id.",
"operationId" : "deleteDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Definition folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/definitions/folders" : {
"get" : {
"tags" : [ "definition-tree" ],
"summary" : "Gets project's definition folder structure.",
"description" : "Gets project's definition folder structure.",
"operationId" : "getDefinitionFolders",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "includeIssues",
"in" : "query",
"description" : "Indicator to include issues in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestSteps",
"in" : "query",
"description" : "Indicator to include test steps in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestParameters",
"in" : "query",
"description" : "Indicator to include test parameters in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "prefixFolders",
"in" : "query",
"description" : "Indicator to include numbering in folder names.",
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
},
"post" : {
"tags" : [ "definition-tree" ],
"summary" : "Creates definition folder.",
"description" : "Creates definition folder in project.",
"operationId" : "addDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Definition folder request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderCreateData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/definitions/folders/{id}/move" : {
"put" : {
"tags" : [ "definition-tree" ],
"summary" : "Moves definition folder to another folder.",
"description" : "Moves definition folder to another folder.",
"operationId" : "moveDefinitionFolderToDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Definition folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Definition folder move request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderCreateData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/definitions/folders/{id}/attachments" : {
"post" : {
"tags" : [ "definition-tree" ],
"summary" : "Uploads attachment to definition folder.",
"description" : "Uploads attachment to definition folder.",
"operationId" : "addAttachmentToDefinition",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Definition folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "File to be uploaded.",
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FilePart"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"406" : {
"description" : "Server cannot produce a response matching the list of acceptable values in the request."
},
"415" : {
"description" : "Server refuses to accept payload in unsupported format."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/definitions/issues/{issueKey}/add/folder" : {
"put" : {
"tags" : [ "definition-tree" ],
"summary" : "Adds issue to definition folder.",
"description" : "Adds issue to definition folder.",
"operationId" : "addIssueToDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Definition folder move request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderMoveData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderIssueData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/definitions/issues/{issueKey}/move/folder" : {
"put" : {
"tags" : [ "definition-tree" ],
"summary" : "Moves issue to definition folder.",
"description" : "Moves issue to definition folder.",
"operationId" : "moveIssueToDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Definition folder move request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderMoveData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderIssueData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/definitions/issues/{issueKey}/remove/folder" : {
"put" : {
"tags" : [ "definition-tree" ],
"summary" : "Removes issue from definition folder.",
"description" : "Removes issue from definition folder.",
"operationId" : "removeIssueFromDefinitionFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Definition folder remove request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderMoveData"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/executions/{executionId}" : {
"get" : {
"tags" : [ "executions" ],
"summary" : "Gets test execution details.",
"description" : "Gets test execution details by id in project.",
"operationId" : "getTestExecution",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestIssueExecutionData"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"put" : {
"tags" : [ "executions" ],
"summary" : "Updates test execution.",
"description" : "Updates an existing test execution in a project.",
"operationId" : "updateTestExecution",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test execution details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestIssueExecutionData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestIssueExecutionData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "executions" ],
"summary" : "Deletes test execution.",
"description" : "Deletes an existing test execution in a project by id.",
"operationId" : "deleteTestExecution",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project Key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/executions/{executionId}/tests" : {
"post" : {
"tags" : [ "executions" ],
"summary" : "Executes a test by test id.",
"description" : "Executes a test execution by id in a project.",
"operationId" : "executeTest",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Execution test details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExecuteTestData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanTestExecutionData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/executions/{executionId}/tests/steps" : {
"post" : {
"tags" : [ "executions" ],
"summary" : "Execute test steps.",
"description" : "Executes a test step in a test execution.",
"operationId" : "executeTestStep",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test step execution details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExecuteTestData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/executions/{executionId}/tests/{id}/attachments" : {
"post" : {
"tags" : [ "executions" ],
"summary" : "Upload attachment to test step.",
"description" : "Uploads attachment to an executed test step in a project.",
"operationId" : "addAttachmentToTest",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Files to upload.",
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FilePart"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded but no files were attached.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"406" : {
"description" : "Server cannot produce a response matching the list of acceptable values in the request."
},
"415" : {
"description" : "Server refuses to accept payload in unsupported format."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/executions/{executionId}/result" : {
"get" : {
"tags" : [ "executions" ],
"summary" : "Gets test execution statistics.",
"description" : "Gets test execution statistics in a project.",
"operationId" : "getTestExecutionResult",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExecutionResultData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/issues/{issueKey}/executions" : {
"get" : {
"tags" : [ "issues", "executions" ],
"summary" : "Gets single test executions.",
"description" : "Gets all single test execution in an issue by project.",
"operationId" : "getIssueTestExecution",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestPlanExecutionData"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"post" : {
"tags" : [ "issues", "executions" ],
"summary" : "Creates single test execution.",
"description" : "Creates a single test execution for an issue.",
"operationId" : "addIssueTestExecution",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test execution details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestIssueExecutionData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and resource has been updated as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestIssueExecutionData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/executions/{executionId}/tests/{id}/attachments" : {
"post" : {
"tags" : [ "test-plans", "executions" ],
"summary" : "Uploads attachment to a test step.",
"description" : "Uploads attachment to an executed test step in a test plan execution.",
"operationId" : "addAttachmentToTest_1",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "executionId",
"in" : "path",
"description" : "Test execution id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "File(s) to be uploaded.",
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FilePart"
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Request has succeeded but no files were attached.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"406" : {
"description" : "Server cannot produce a response matching the list of acceptable values in the request."
},
"415" : {
"description" : "Server refuses to accept payload in unsupported format."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/executions" : {
"get" : {
"tags" : [ "test-plans", "executions" ],
"summary" : "Gets test plan executions.",
"description" : "Gets test plan executions by id in a project.",
"operationId" : "getTestExecutions",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestPlanExecutionData"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"post" : {
"tags" : [ "test-plans", "executions" ],
"summary" : "Creates test execution on a test plan.",
"description" : "Creates test execution on a test plan in a project.",
"operationId" : "addTestExecution",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test plan execution details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanExecutionData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanExecutionData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects" : {
"get" : {
"tags" : [ "projects" ],
"summary" : "Gets activated projects.",
"description" : "Gets activated projects",
"operationId" : "getProjects",
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProjectBeanData"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/enable" : {
"put" : {
"tags" : [ "projects" ],
"summary" : "Activates/Enables a project.",
"description" : "Activates/Enables a project in T4J.",
"operationId" : "enableProject",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/disable" : {
"put" : {
"tags" : [ "projects" ],
"summary" : "Deactivates/Disables a project.",
"description" : "Deactivates/Disables a project.",
"operationId" : "disableProject",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/issues/search" : {
"get" : {
"tags" : [ "issues" ],
"summary" : "Gets issues with T4J path using a jql.",
"description" : "Gets issues with T4J path using a jql.",
"operationId" : "searchIssues",
"parameters" : [ {
"name" : "jql",
"in" : "query",
"description" : "Jira JQL expression.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "Index offset of result(s).",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Maximum allowed results.",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 50
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Jira fields.",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssuePathListData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/version" : {
"get" : {
"tags" : [ "application" ],
"summary" : "Gets plugin version.",
"description" : "Gets plugin version information.",
"operationId" : "getVersion",
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PluginVersionInformation"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/license" : {
"get" : {
"tags" : [ "application" ],
"summary" : "Gets license status.",
"description" : "Gets license status of T4J plugin, Possible returns are:\n* e.g. None, Valid, Expired, Invalid, Incompatible",
"operationId" : "getLicenseStatus",
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PluginLicenseInformation"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/parameters/{id}" : {
"get" : {
"tags" : [ "test-parameters" ],
"summary" : "Gets test parameter.",
"description" : "Gets test parameter.",
"operationId" : "getTestParameter",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test parameter id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"put" : {
"tags" : [ "test-parameters" ],
"summary" : "Updates test parameter.",
"description" : "Updates test parameter by id.",
"operationId" : "updateTestParameter",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test parameter id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test parameter details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "test-parameters" ],
"summary" : "Removes test parameter.",
"description" : "Removes test parameter by id.",
"operationId" : "removeTestParameter",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test parameter id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/parameters/issues/{issueKey}" : {
"get" : {
"tags" : [ "test-parameters" ],
"summary" : "Gets all test parameters of an issue.",
"description" : "Gets all test parameters of an issue.",
"operationId" : "getTestParametersForIssue",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"post" : {
"tags" : [ "test-parameters" ],
"summary" : "Adds test parameter to an issue.",
"description" : "Adds test parameter to an issue.",
"operationId" : "addTestParameter",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Parameter data details.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{id}" : {
"get" : {
"tags" : [ "test-plans" ],
"summary" : "Gets test plan.",
"description" : "Gets test plan details by project key and test plan id.",
"operationId" : "getTestPlan",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"put" : {
"tags" : [ "test-plans" ],
"summary" : "Updates test plan details.",
"description" : "Updates test plan details.",
"operationId" : "editTestPlan",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test plan details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "test-plans" ],
"summary" : "Removes test plan.",
"description" : "Removes test plan.",
"operationId" : "removeTestPlan",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/plans" : {
"get" : {
"tags" : [ "test-plans" ],
"summary" : "Gets test plans.",
"description" : "Gets test plans by project key.",
"operationId" : "getTestPlans",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"post" : {
"tags" : [ "test-plans" ],
"summary" : "Adds test plan to project.",
"description" : "Adds test plan to project.",
"operationId" : "addTestPlan",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test plan details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
}
},
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/folders" : {
"get" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Gets test plan folders.",
"description" : "Gets test plan folders.",
"operationId" : "getTestPlanFolders",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "includeIssues",
"in" : "query",
"description" : "Indicator to include issues in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestSteps",
"in" : "query",
"description" : "Indicator to include test steps in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestParameters",
"in" : "query",
"description" : "Indicator to include test parameters in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "prefixFolders",
"in" : "query",
"description" : "Indicator to include numbering in folder names.",
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"post" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Adds test plan folder.",
"description" : "Adds a folder in a test plan.",
"operationId" : "addTestPlanFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Folder creation details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderCreateData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/folders/{id}" : {
"get" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Gets test plan folder.",
"description" : "Gets test plan folder.",
"operationId" : "getTestPlanFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "includeIssues",
"in" : "query",
"description" : "Indicator to include issues in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestSteps",
"in" : "query",
"description" : "Indicator to include test steps in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "includeTestParameters",
"in" : "query",
"description" : "Indicator to include test parameters in response data.",
"schema" : {
"type" : "boolean",
"default" : true
}
}, {
"name" : "prefixFolders",
"in" : "query",
"description" : "Indicator to include numbering in folder names.",
"schema" : {
"type" : "boolean",
"default" : false
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"put" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Updates test plan folder.",
"description" : "Updates test plan folder.",
"operationId" : "updateTestPlanFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Folder creation details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderCreateData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Removes test plan folder.",
"description" : "Removes test plan folder.",
"operationId" : "removeTestPlanFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/issues/{itemId}/remove/folder" : {
"put" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Removes issue from test plan folder.",
"description" : "Removes issue from test plan folder.",
"operationId" : "removeIssueFromFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "itemId",
"in" : "path",
"description" : "Item id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Folder position details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderPositionData"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/folders/{id}/move" : {
"put" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Moves folder to another folder.",
"description" : "Moves a test plan folder to another test plan folder.",
"operationId" : "moveFolderToFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Folder position details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderPositionData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/issues/{issueKey}/add/folder" : {
"put" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Adds issue to folder.",
"description" : "Adds issue to a test plan folder.",
"operationId" : "addIssueToFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Folder position details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderPositionData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderIssueData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/issues/{itemId}/move/folder" : {
"put" : {
"tags" : [ "test-plans", "folders" ],
"summary" : "Moves issue to test plan folder.",
"description" : "Moves issue to test plan folder.",
"operationId" : "moveIssueToFolder",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "itemId",
"in" : "path",
"description" : "Item id",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Folder position details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderPositionData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderIssueData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/folders/{id}/attachments" : {
"post" : {
"tags" : [ "test-plans" ],
"summary" : "Uploads attachment to test plan folder.",
"description" : "Uploads attachment to test plan folder.",
"operationId" : "addAttachmentToTestPlan",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Folder id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment details request body.",
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FilePart"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"406" : {
"description" : "Server cannot produce a response matching the list of acceptable values in the request."
},
"415" : {
"description" : "Server refuses to accept payload in unsupported format."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/plans/{id}/copy" : {
"post" : {
"tags" : [ "test-plans" ],
"summary" : "Copies test plan.",
"description" : "Copies test plan.",
"operationId" : "copyTestPlan",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestPlanData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/plans/{planId}/issues/{itemId}/parameters/overwrite" : {
"put" : {
"tags" : [ "test-plans" ],
"summary" : "Overwrites test parameters.",
"description" : "Overwrites test parameters.",
"operationId" : "overwriteTestParameters",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "planId",
"in" : "path",
"description" : "Test plan id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "itemId",
"in" : "path",
"description" : "Item id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Parameter overwrite details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ParameterOverwriteData"
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/steps/issues/{issueKey}" : {
"get" : {
"tags" : [ "test-steps" ],
"summary" : "Gets issue test steps.",
"description" : "Gets all test steps of an issue by issue key.",
"operationId" : "getIssueTestSteps",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
},
"post" : {
"tags" : [ "test-steps" ],
"summary" : "Creates test step of an issue.",
"description" : "Creates test step of a specific issue.",
"operationId" : "addTestStepToIssue",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "issueKey",
"in" : "path",
"description" : "Issue key.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test step request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepCreationData"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"405" : {
"description" : "Request method is known by the server but is not supported by the target resource."
},
"404" : {
"description" : "Requested resource does not exist."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/steps/{id}" : {
"get" : {
"tags" : [ "test-steps" ],
"summary" : "Gets test step.",
"description" : "Gets test step by project key and test step id.",
"operationId" : "getTestStepDetails",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"405" : {
"description" : "Request method is known by the server but is not supported by the target resource."
}
}
},
"put" : {
"tags" : [ "test-steps" ],
"summary" : "Updates test step.",
"description" : "Updates test step by project key and test step id.",
"operationId" : "updateTestStep",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Test step details request body.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"405" : {
"description" : "Request method is known by the server but is not supported by the target resource."
},
"409" : {
"description" : "Conflict with the processed resource."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [ "test-steps" ],
"summary" : "Removes test step.",
"description" : "Removes test step by project key and test step id.",
"operationId" : "removeTestStep",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded and resource has been updated as a result."
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/steps/{id}/rank/{position}" : {
"put" : {
"tags" : [ "test-steps" ],
"summary" : "Ranks test step.",
"description" : "Ranks test step to position indicated.",
"operationId" : "rankTestStep",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "position",
"in" : "path",
"description" : "Test step position.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
}
}
}
},
"/projects/{projectKey}/steps/{id}/copy" : {
"post" : {
"tags" : [ "test-steps" ],
"summary" : "Clones test step.",
"description" : "Clones the test step by test step id.",
"operationId" : "copyTestStep",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestStepData"
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/steps/{id}/attachments" : {
"post" : {
"tags" : [ "test-steps" ],
"summary" : "Uploads attachment to a test step.",
"description" : "Uploads attachment to a test step.",
"operationId" : "addAttachmentToTestStep",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Project key.",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "id",
"in" : "path",
"description" : "Test step id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "Attachment file request.",
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FilePart"
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
}
},
"400" : {
"description" : "Server could not understand the request due to invalid syntax."
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
},
"404" : {
"description" : "Requested resource does not exist."
},
"406" : {
"description" : "Server cannot produce a response matching the list of acceptable values in the request."
},
"415" : {
"description" : "Server refuses to accept payload in unsupported format."
}
}
}
}
},
"components" : {
"schemas" : {
"ListWrapperCallbackApplicationRoleBean" : {
"type" : "object"
},
"FolderMoveData" : {
"type" : "object",
"properties" : {
"position" : {
"type" : "integer",
"format" : "int64"
},
"folder" : {
"$ref" : "#/components/schemas/FolderData"
}
}
},
"ComponentJsonBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
}
}
},
"FolderIssueData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"data" : {
"$ref" : "#/components/schemas/IssueRefJsonBean"
},
"testSteps" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestStepData"
}
},
"testParameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ParameterData"
}
}
}
},
"UserJsonBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
"avatarUrls" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"displayName" : {
"type" : "string"
},
"active" : {
"type" : "boolean"
},
"timeZone" : {
"type" : "string"
}
}
},
"IssueLinkTypeJsonBean" : {
"type" : "object"
},
"IssuePath" : {
"type" : "object",
"properties" : {
"project" : {
"$ref" : "#/components/schemas/ProjectBeanData"
},
"path" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int32"
},
"type" : {
"type" : "string"
}
}
},
"GroupJsonBean" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"self" : {
"type" : "string",
"format" : "uri"
}
}
},
"ExecuteTestData" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "STEP_FAILED", "STEP_PASSED", "STEP_SKIPPED", "STEP_FAILED_CONTINUE_TEST", "STEP_FAILED_CONTINUE_STEP", "TEST_FAILED", "TEST_PASSED", "TEST_SKIPPED", "TEST_FAILED_CONTINUE", "NOT_RUN" ]
},
"testResult" : {
"type" : "string"
}
}
},
"ProjectBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"format" : "uri"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"avatarUrls" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"archived" : {
"type" : "boolean"
}
},
"xml" : {
"name" : "project"
}
},
"TestStepData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"expectedResult" : {
"type" : "string"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"status" : {
"type" : "string",
"enum" : [ "NOT_RUN", "FAILED", "PASSED", "SKIPPED" ]
},
"testResult" : {
"type" : "string"
},
"descriptionHtml" : {
"type" : "string"
},
"expectedResultHtml" : {
"type" : "string"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
}
}
},
"IssuePathData" : {
"type" : "object",
"properties" : {
"issue" : {
"$ref" : "#/components/schemas/IssueRefJsonBean"
},
"issuePaths" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssuePath"
}
}
}
},
"ParameterOverwriteData" : {
"type" : "object",
"properties" : {
"parameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ParameterInlineData"
}
}
}
},
"ProjectRoleBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"format" : "uri"
},
"name" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"actors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoleActorBean"
}
}
},
"xml" : {
"name" : "projectRole"
}
},
"LinkTypeDirectionData" : {
"type" : "object",
"properties" : {
"link" : {
"$ref" : "#/components/schemas/IssueLinkTypeJsonBean"
},
"direction" : {
"type" : "string"
}
}
},
"ProjectData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"icon" : {
"type" : "string"
}
}
},
"ParameterInlineData" : {
"type" : "object",
"properties" : {
"key" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
},
"ResultValueData" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"format" : "int64"
},
"percentage" : {
"type" : "number",
"format" : "float"
}
}
},
"ParameterData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"key" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"identifier" : {
"type" : "string"
},
"defaultValue" : {
"type" : "string"
}
}
},
"ExecutionResultSummaryData" : {
"type" : "object",
"properties" : {
"tests" : {
"$ref" : "#/components/schemas/ResultData"
},
"steps" : {
"$ref" : "#/components/schemas/ResultData"
}
}
},
"FilePart" : {
"type" : "object",
"properties" : {
"contentType" : {
"type" : "string"
},
"formField" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"inputStream" : {
"type" : "object"
}
}
},
"IssueRefJsonBean" : {
"type" : "object"
},
"CoverageViewData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"isPublic" : {
"type" : "boolean"
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FieldBean"
}
},
"columns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CoverageViewColumnData"
}
}
}
},
"CoverageViewIssueTypeData" : {
"type" : "object",
"properties" : {
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssueTypeJsonBean"
}
},
"useAllIssueTypes" : {
"type" : "boolean"
}
}
},
"ResultData" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"format" : "int64"
},
"passed" : {
"$ref" : "#/components/schemas/ResultValueData"
},
"skipped" : {
"$ref" : "#/components/schemas/ResultValueData"
},
"failed" : {
"$ref" : "#/components/schemas/ResultValueData"
}
}
},
"FolderData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"parentId" : {
"type" : "integer",
"format" : "int32"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
},
"folders" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FolderData"
}
},
"issues" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FolderIssueData"
}
}
}
},
"FilterPermissionBean" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"type" : {
"type" : "string"
},
"project" : {
"$ref" : "#/components/schemas/ProjectBean"
},
"role" : {
"$ref" : "#/components/schemas/ProjectRoleBean"
},
"group" : {
"$ref" : "#/components/schemas/GroupJsonBean"
},
"user" : {
"$ref" : "#/components/schemas/UserBean"
},
"view" : {
"type" : "boolean"
},
"edit" : {
"type" : "boolean"
}
},
"xml" : {
"name" : "filter"
}
},
"TestPlanTestExecutionData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"executor" : {
"$ref" : "#/components/schemas/UserJsonBean"
},
"issue" : {
"$ref" : "#/components/schemas/IssueRefJsonBean"
},
"path" : {
"type" : "string"
},
"steps" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestStepData"
}
},
"parameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ParameterData"
}
},
"status" : {
"type" : "string",
"enum" : [ "NOT_RUN", "FAILED", "PASSED", "SKIPPED" ]
},
"testResult" : {
"type" : "string"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
},
"completeDate" : {
"type" : "string"
}
}
},
"TestIssueExecutionData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"assignee" : {
"$ref" : "#/components/schemas/UserData"
},
"project" : {
"$ref" : "#/components/schemas/ProjectData"
},
"components" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ComponentJsonBean"
}
},
"fixVersions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VersionData"
}
},
"parameters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ParameterInlineData"
}
},
"createDate" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"startDate" : {
"type" : "string"
},
"plan" : {
"$ref" : "#/components/schemas/TestPlanData"
},
"status" : {
"type" : "string",
"enum" : [ "CREATING", "NOT_RUN", "RUNNING", "FAILED", "PASSED" ]
},
"test" : {
"$ref" : "#/components/schemas/TestPlanTestExecutionData"
}
}
},
"ExecutionResultData" : {
"type" : "object",
"properties" : {
"summary" : {
"$ref" : "#/components/schemas/ExecutionResultSummaryData"
},
"execution" : {
"$ref" : "#/components/schemas/TestPlanExecutionData"
}
}
},
"SimpleListWrapperApplicationRoleBean" : {
"type" : "object",
"properties" : {
"size" : {
"type" : "integer",
"format" : "int32",
"xml" : {
"attribute" : true
}
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"xml" : {
"name" : "max-results",
"attribute" : true
}
},
"pagingCallback" : {
"$ref" : "#/components/schemas/ListWrapperCallbackApplicationRoleBean"
},
"callback" : {
"$ref" : "#/components/schemas/ListWrapperCallbackApplicationRoleBean"
}
},
"xml" : {
"name" : "list"
}
},
"PluginLicenseInformation" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string"
}
}
},
"RoleActorBean" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"avatarUrl" : {
"type" : "string",
"format" : "uri",
"writeOnly" : true
}
},
"xml" : {
"name" : "projectRoleActor"
}
},
"UserData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"self" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
"avatarUrls" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"displayName" : {
"type" : "string"
},
"active" : {
"type" : "boolean"
}
}
},
"ListWrapperCallbackGroupJsonBean" : {
"type" : "object"
},
"TestStepCreationData" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"expectedResult" : {
"type" : "string"
},
"position" : {
"type" : "integer",
"format" : "int64"
}
}
},
"SimpleListWrapperGroupJsonBean" : {
"type" : "object",
"properties" : {
"size" : {
"type" : "integer",
"format" : "int32",
"xml" : {
"attribute" : true
}
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"xml" : {
"name" : "max-results",
"attribute" : true
}
},
"pagingCallback" : {
"$ref" : "#/components/schemas/ListWrapperCallbackGroupJsonBean"
},
"callback" : {
"$ref" : "#/components/schemas/ListWrapperCallbackGroupJsonBean"
}
},
"xml" : {
"name" : "list"
}
},
"FolderPositionData" : {
"type" : "object",
"properties" : {
"folder" : {
"$ref" : "#/components/schemas/FolderData"
},
"position" : {
"type" : "integer",
"format" : "int64"
}
}
},
"AttachmentJsonBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"filename" : {
"type" : "string"
},
"author" : {
"$ref" : "#/components/schemas/UserJsonBean"
},
"created" : {
"type" : "string",
"format" : "date-time"
},
"size" : {
"type" : "integer",
"format" : "int64"
},
"mimeType" : {
"type" : "string"
},
"content" : {
"type" : "string"
},
"thumbnail" : {
"type" : "string"
}
}
},
"UserBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"format" : "uri"
},
"key" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"emailAddress" : {
"type" : "string"
},
"avatarUrls" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"format" : "uri"
}
},
"displayName" : {
"type" : "string"
},
"active" : {
"type" : "boolean"
},
"timeZone" : {
"type" : "string"
},
"locale" : {
"type" : "string"
},
"groups" : {
"$ref" : "#/components/schemas/SimpleListWrapperGroupJsonBean"
},
"applicationRoles" : {
"$ref" : "#/components/schemas/SimpleListWrapperApplicationRoleBean"
},
"expand" : {
"type" : "string",
"xml" : {
"attribute" : true
}
}
},
"xml" : {
"name" : "user"
}
},
"CoverageViewLinkTypeData" : {
"type" : "object",
"properties" : {
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/LinkTypeDirectionData"
}
},
"useAllLinkTypes" : {
"type" : "boolean"
}
}
},
"IssuePathListData" : {
"type" : "object",
"properties" : {
"startAt" : {
"type" : "integer",
"format" : "int32"
},
"maxResult" : {
"type" : "integer",
"format" : "int32"
},
"total" : {
"type" : "integer",
"format" : "int32"
},
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssuePathData"
}
}
}
},
"IssueTypeJsonBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"iconUrl" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"subtask" : {
"type" : "boolean"
},
"avatarId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"FilterBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"format" : "uri"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"owner" : {
"$ref" : "#/components/schemas/UserBean"
},
"jql" : {
"type" : "string"
},
"viewUrl" : {
"type" : "string",
"format" : "uri"
},
"searchUrl" : {
"type" : "string",
"format" : "uri"
},
"favourite" : {
"type" : "boolean"
},
"sharePermissions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FilterPermissionBean"
}
},
"editable" : {
"type" : "boolean"
}
},
"xml" : {
"name" : "filter"
}
},
"CoverageViewColumnData" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string"
},
"source" : {
"$ref" : "#/components/schemas/CoverageViewColumnSourceData"
},
"position" : {
"type" : "integer",
"format" : "int64"
}
}
},
"JsonTypeBean" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"items" : {
"type" : "string"
},
"system" : {
"type" : "string"
},
"custom" : {
"type" : "string"
},
"customId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"TestPlanExecutionData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"project" : {
"$ref" : "#/components/schemas/ProjectData"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"createDate" : {
"type" : "string"
},
"startDate" : {
"type" : "string"
},
"completeDate" : {
"type" : "string"
},
"assignee" : {
"$ref" : "#/components/schemas/UserData"
},
"components" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ComponentJsonBean"
}
},
"fixVersions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VersionData"
}
},
"plan" : {
"$ref" : "#/components/schemas/TestPlanData"
},
"status" : {
"type" : "string",
"enum" : [ "CREATING", "NOT_RUN", "RUNNING", "FAILED", "PASSED" ]
},
"tests" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TestPlanTestExecutionData"
}
},
"test" : {
"$ref" : "#/components/schemas/TestPlanTestExecutionData"
}
}
},
"FolderCreateData" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"parent" : {
"$ref" : "#/components/schemas/FolderData"
},
"position" : {
"type" : "integer",
"format" : "int64"
}
}
},
"PluginVersionInformation" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
}
}
},
"VersionData" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"archived" : {
"type" : "boolean"
},
"released" : {
"type" : "boolean"
},
"releaseDate" : {
"type" : "string"
}
}
},
"FieldBean" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"custom" : {
"type" : "boolean"
},
"orderable" : {
"type" : "boolean"
},
"navigable" : {
"type" : "boolean"
},
"searchable" : {
"type" : "boolean"
},
"clauseNames" : {
"uniqueItems" : true,
"type" : "array",
"items" : {
"type" : "string"
}
},
"schema" : {
"$ref" : "#/components/schemas/JsonTypeBean"
}
},
"xml" : {
"name" : "field"
}
},
"CoverageViewColumnSourceData" : {
"type" : "object",
"properties" : {
"jql" : {
"type" : "string"
},
"filter" : {
"$ref" : "#/components/schemas/FilterBean"
},
"linkTypes" : {
"$ref" : "#/components/schemas/CoverageViewLinkTypeData"
},
"issueTypes" : {
"$ref" : "#/components/schemas/CoverageViewIssueTypeData"
},
"showExecutions" : {
"type" : "boolean"
},
"executions" : {
"type" : "integer",
"format" : "int64"
}
}
},
"TestPlanData" : {
"type" : "object",
"properties" : {
"prjKey" : {
"type" : "string"
},
"project" : {
"type" : "integer",
"format" : "int64"
},
"description" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int32"
},
"name" : {
"type" : "string"
},
"copying" : {
"type" : "boolean"
},
"copyFailed" : {
"type" : "boolean"
},
"testCount" : {
"type" : "integer",
"format" : "int64"
},
"stepCount" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ProjectBeanData" : {
"type" : "object"
}
}
}
} |
Page Comparison
Manage space
Manage content
Integrations