{
"openapi" : "3.0.1",
"info" : {
"title" : "Requirements for Jira (R4J)",
"description" : "Endpoints provided by R4J. ",
"version" : "2.0"
},
"paths" : {
"/attachments/{id}/download" : {
"get" : {
"tags" : [
"attachments" ],
"summary" : "Retrieves folder attachment.",
"description" : "Retrieves the attachment of a folder using attachment id.",
"operationId" : "downloadAttachment",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The existing 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."
}
}
}
},
"/attachments/{id}" : {
"get" : {
"tags" : [
"attachments" ],
"summary" : "Gets folder attachment information.",
"description" : "Gets the information of an attachment in a folder using attachment id.",
"operationId" : "getAttachment",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The existing 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 an attachment.",
"description" : "Deletes an attachment in a folder using attachment id.",
"operationId" : "deleteAttachment",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "The existing 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."
}
}
}
},
"/projects/{projectKey}/folders/{id}" : {
"get" : {
"tags" : [
"folders" ],
"summary" : "Gets the complete tree structure from a specific folder.",
"description" : "Gets the complete tree structure with or without issues from a specific folder in the tree.",
"operationId" : "getFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of a specific folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of folder used to retrieve the complete tree structure.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "includeIssues",
"in" : "query",
"description" : "The toggle to include issues in folder. This will return the list of issues under the folder sorted by issue position and positionTime.",
"schema" : {
"type" : "boolean",
"default" : true
}
},
{
"name" : "prefixFolders",
"in" : "query",
"description" : "The toggle to structure numbering prefix for 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" : [
"folders" ],
"summary" : "Updates an existing folder.",
"description" : "Triggers the update of an existing folder in the tree.",
"operationId" : "updateFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of an existing folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of folder to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The folder request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderDataREST"
}
}
},
"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" : [
"folders" ],
"summary" : "Deletes an existing folder.",
"description" : "Triggers the deletion of an existing folder in the tree.",
"operationId" : "deleteFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of an existing folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of folder to be deleted.",
"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}/folders/{id}/move" : {
"put" : {
"tags" : [
"folders" ],
"summary" : "Moves an existing folder to another folder.",
"description" : "Triggers the movement of an existing folder to another folder in the tree.",
"operationId" : "moveFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of an existing folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of folder to be moved.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The folder request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MoveFolderData"
}
}
},
"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."
}
}
}
},
"/projects/{projectKey}/folders" : {
"get" : {
"tags" : [
"folders" ],
"summary" : "Gets the complete tree structure from the root folder.",
"description" : "Gets the complete tree structure with or without issues from the root folder in the tree.",
"operationId" : "getFolders",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the root folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "includeIssues",
"in" : "query",
"description" : "The toggle to include issues in folder.",
"schema" : {
"type" : "boolean",
"default" : true
}
},
{
"name" : "prefixFolders",
"in" : "query",
"description" : "The toggle to structure numbering prefix for 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" : [
"folders" ],
"summary" : "Creates a new folder.",
"description" : "Triggers the creation of a new folder in the tree.",
"operationId" : "createFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the new folder.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The folder request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FolderDataREST"
}
}
},
"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."
}
}
}
},
"/projects/{projectKey}/folders/{id}/attachments" : {
"post" : {
"tags" : [
"folders" ],
"summary" : "Adds attachment to an existing folder.",
"description" : "Triggers the attachment of file to an existing folder in the tree.",
"operationId" : "addAttachmentToFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of an existing folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of folder where file attachments will be added.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The list of file attachments request body data.",
"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" : {
"type" : "object"
}
}
}
}
},
"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}/issues/{issueKey}/remove/folder" : {
"put" : {
"tags" : [
"issues" ],
"summary" : "Removes issue from folder.",
"description" : "Removes an issue from a folder in a project.",
"operationId" : "removeIssueFromFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the target folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "issueKey",
"in" : "path",
"description" : "The existing issue key of the issue to be removed.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The target folder request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TargetFolderRequestData"
}
}
},
"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}/issues/{issueKey}/remove/issue" : {
"put" : {
"tags" : [
"issues" ],
"summary" : "Removes issue from issue.",
"description" : "Removes an issue from an existing issue in a project.",
"operationId" : "removeIssueFromIssue",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the target issue.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "issueKey",
"in" : "path",
"description" : "The existing issue key of the issue to be removed.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The target issue request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TargetIssueRequestData"
}
}
},
"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}/issues/{issueKey}/add/folder" : {
"put" : {
"tags" : [
"issues" ],
"summary" : "Adds issue to folder.",
"description" : "Adds an issue to an existing folder in a project.",
"operationId" : "addIssueToFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the target folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "issueKey",
"in" : "path",
"description" : "The existing issue key to be added to the target folder.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The target folder request body data. If folder id is null, default target will be -1 (root folder).",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TargetFolderRequestData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueData"
}
}
}
},
"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}/move/folder" : {
"put" : {
"tags" : [
"issues" ],
"summary" : "Moves issue to folder.",
"description" : "Moves an existing issue to a folder in a project.",
"operationId" : "moveIssueToFolder",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the target folder.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "issueKey",
"in" : "path",
"description" : "The existing issue key of the issue to be moved.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The target folder request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TargetFolderRequestData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueData"
}
}
}
},
"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}/add/issue" : {
"put" : {
"tags" : [
"issues" ],
"summary" : "Adds issue to issue.",
"description" : "Adds an issue to an existing issue in a project.",
"operationId" : "addIssueToIssue",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the target issue.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "issueKey",
"in" : "path",
"description" : "The existing issue key to be added to the target issue.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The target issue request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TargetIssueRequestData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueData"
}
}
}
},
"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}/move/issue" : {
"put" : {
"tags" : [
"issues" ],
"summary" : "Moves issue to issue.",
"description" : "Moves an existing issue to another issue in a project.",
"operationId" : "moveIssueToIssue",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the target issue.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "issueKey",
"in" : "path",
"description" : "The existing issue key of the issue to be moved.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The target issue request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TargetIssueRequestData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueData"
}
}
}
},
"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" : {
"get" : {
"tags" : [
"projects" ],
"summary" : "Gets the activated projects.",
"description" : "Gets all activated projects in R4J - Requirements Management for Jira plugin.",
"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."
}
}
}
},
"/projects/{projectKey}/enable" : {
"put" : {
"tags" : [
"projects" ],
"summary" : "Enables a Project.",
"description" : "Enables a project in R4J - Requirements Management for Jira plugin.",
"operationId" : "enableProject",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "Project key of the project to be enabled. Cannot be empty.",
"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}/disable" : {
"put" : {
"tags" : [
"projects" ],
"summary" : "Disables a Project.",
"description" : "Disables a project in R4J - Requirements Management for Jira plugin.",
"operationId" : "disableProject",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "Project key of the project to be disabled. Cannot be empty.",
"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}/quick-filters" : {
"get" : {
"tags" : [
"projects" ],
"summary" : "Gets the complete list of Quick Filters in a project.",
"description" : "Gets the complete list of Quick Filters in a project.",
"operationId" : "getQuickFilters",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the quick filter.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"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" : [
"projects" ],
"summary" : "Creates a quick filter.",
"description" : "Creates a quick filter for a project.",
"operationId" : "createQuickFilters",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the quick filter.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The quick filter request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/QuickFilterData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/QuickFilterData"
}
}
}
},
"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}/quick-filters/{id}" : {
"get" : {
"tags" : [
"projects" ],
"summary" : "Get the quick filter record.",
"description" : "Get the quick filter record by id in a project.",
"operationId" : "getQuickFilter",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the quick filter.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the quick filter to be fetched.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/QuickFilterData"
}
}
}
},
"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" : [
"projects" ],
"summary" : "Updates a quick filter.",
"description" : "Updates a quick filter for a project.",
"operationId" : "updateQuickFilters",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the quick filter.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the quick filter to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The quick filter request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/QuickFilterData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/QuickFilterData"
}
}
}
},
"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."
}
}
},
"delete" : {
"tags" : [
"projects" ],
"summary" : "Deletes quick filter data.",
"description" : "Deletes a quick filter from a project.",
"operationId" : "deleteQuickFilters",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the quick filter.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the quick filter to be deleted.",
"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}/quick-filters/{id}/move/{position}" : {
"get" : {
"tags" : [
"projects" ],
"summary" : "Updates the position of quick filter record.",
"description" : "Updates the position of a quick filter record in a project.",
"operationId" : "moveQuickFilter",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the quick filter.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the quick filter to be moved.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "position",
"in" : "path",
"description" : "The new position of a quick filter record",
"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."
}
}
}
},
"/reqIF/{projectKey}/export/{mappingId}" : {
"getpost" : {
"tags" : [ "reqIFExport" ],
"summary" : "Export selected tree item using a reqIf mapping.",
"description" : "Export selected tree item using a reqIf mapping",
"operationId" : "exportReqIF",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "mappingId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"description" : "The reqIf export request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RequestDataExport"
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created 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."
}
}
}
},
"/version" : {
"get" : {
"tags" : [
"application" ],
"summary" : "Gets the plugin version.",
"description" : "Gets the R4J plugin version.",
"operationId" : "getVersion",
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PluginVersionInformation"
}
}
}
},
"401" : {
"description" : "Authentication failed."
},
"403" : {
"description" : "License is invalid or expired; or Jira version is incompatible."
}
}
}
},
"/license" : {
"get" : {
"tags" : [
"application" ],
"summary" : "Gets the license status.",
"description" : "Gets the R4J plugin license status, 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."
}
}
}
},
"/revisions/blacklist/fields" : {
"get" : {
"tags" : [
"configuration" ],
"summary" : "Get existing fields from field blacklist.",
"description" : "Retrieve existing fields from the field blacklist in R4J for a Jira instance. Only a Jira Administrator is permitted to retrieve the field blacklist",
"operationId" : "getBlacklistField",
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FieldBean"
}
}
}
}
},
"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" : "Request has failed due to exception."
}
}
},
"post" : {
"tags" : [
"configuration" ],
"summary" : "Add existing field to field blacklist.",
"description" : "Adding an existing field to the field blacklist in R4J for a Jira instance. Only a Jira Administrator is permitted to add a field to the field blacklist",
"operationId" : "addBlacklistField",
"requestBody" : {
"description" : "The search suspect link request body data.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FieldBean"
}
}
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FieldBean"
}
}
}
}
},
"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" : "Request has failed due to exception."
}
}
}
},
"/revisions/blacklist/fields/{id}" : {
"delete" : {
"tags" : [
"configuration" ],
"summary" : "Delete existing field from field blacklist.",
"description" : "Delete existing field from the field blacklist in R4J for a Jira instance. Only a Jira Administrator is permitted to remove a field from the field blacklist",
"operationId" : "removeBlacklistField",
"parameters" : [
{
"name" : "id",
"in" : "path",
"description" : "Field Id.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"204" : {
"description" : "Request has succeeded."
},
"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" : "Request has failed due to exception."
}
}
}
},
"/issues/search" : {
"get" : {
"tags" : [
"search" ],
"summary" : "Gets issues with R4J path using jql.",
"description" : "Triggers the search of issues with R4J path using jql.",
"operationId" : "searchIssues",
"parameters" : [
{
"name" : "jql",
"in" : "query",
"description" : "A valid JQL for searching issues within R4J",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "startAt",
"in" : "query",
"description" : "The index of the first issue to return (0-based)",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0
}
},
{
"name" : "maxResults",
"in" : "query",
"description" : "The maximum number of issues to return (defaults to 50). The maximum\nallowable value is dictated by the JIRA property 'jira.search.views.default.max'.\nIf you specify a value that is higher than this number, your search results\nwill be truncated",
"schema" : {
"type" : "integer",
"format" : "int32"
}
},
{
"name" : "fields",
"in" : "query",
"description" : "The list of fields to return for each issue. By default, all navigable fields\nare returned.",
"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."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/suspects/configurations/{id}" : {
"put" : {
"tags" : [
"suspects" ],
"summary" : "Updates an existing suspect configuration.",
"description" : "Triggers the update of an existing suspect configuration of a project.",
"operationId" : "updateSuspectConfiguration",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of an existing suspect configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the suspect configuration to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The suspect configuration request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SuspectConfigurationData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SuspectConfigurationData"
}
}
}
},
"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."
}
}
},
"delete" : {
"tags" : [
"suspects" ],
"summary" : "Deletes a suspect configuration.",
"description" : "Triggers the deletion of a suspect configuration of a project.",
"operationId" : "deleteSuspectConfiguration",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the suspect configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the suspect configuration to be deleted.",
"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}/suspects/configurations" : {
"get" : {
"tags" : [
"suspects" ],
"summary" : "Gets all suspect configurations.",
"description" : "Triggers the retrieval of all suspect configurations of a project.",
"operationId" : "getSuspectConfigurations",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the suspect configurations.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SuspectConfigurationData"
}
}
}
}
},
"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" : [
"suspects" ],
"summary" : "Creates a new suspect configuration.",
"description" : "Triggers the creation of a new suspect configuration of a project.",
"operationId" : "addSuspectConfiguration",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the new suspect configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The suspect configuration request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SuspectConfigurationData"
}
}
},
"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/SuspectConfigurationData"
}
}
}
},
"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}/suspects/search" : {
"post" : {
"tags" : [
"suspects" ],
"summary" : "Gets all suspects.",
"description" : "Triggers the retrieval of all suspects of a project.",
"operationId" : "searchSuspects",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the suspects.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The search suspect link request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SearchSuspectLinkData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SearchSuspectLinkData"
}
}
}
}
},
"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}/suspects" : {
"post" : {
"tags" : [
"suspects" ],
"summary" : "Creates a new suspect.",
"description" : "Triggers the creation of a new suspect of a project.",
"operationId" : "addSuspect",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the new suspect.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The suspect link request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SuspectLink"
}
}
},
"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/SuspectLink"
}
}
}
},
"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."
}
}
}
},
"/projects/{projectKey}/suspects/{id}" : {
"delete" : {
"tags" : [
"suspects" ],
"summary" : "Deletes a suspect.",
"description" : "Triggers the deletion of a suspect of a project.",
"operationId" : "removeSuspect",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the suspect.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the suspect to be deleted.",
"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."
}
}
}
},
"/projects/{projectKey}/traceability/views" : {
"get" : {
"tags" : [
"traceability" ],
"summary" : "Gets traceability view configurations.",
"description" : "Triggers the retrieval of traceability view configurations.",
"operationId" : "getTraceabilityViewConfigurations",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view configurations.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
}
}
},
"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" : [
"traceability" ],
"summary" : "Creates a new traceability view.",
"description" : "Triggers the creation of a new traceability view.",
"operationId" : "createTraceabilityView",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the new view.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The traceability configuration request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
},
"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/TraceMatrixConfigData"
}
}
}
},
"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."
}
}
}
},
"/projects/{projectKey}/traceability/views/{id}/configuration" : {
"put" : {
"tags" : [
"traceability" ],
"summary" : "Updates a traceability view configuration.",
"description" : "Triggers the update of a traceability view configuration.",
"operationId" : "updateTraceabilityViewConfig",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the view configuration to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "isPublic",
"in" : "query",
"description" : "The toggle to determine the view visibility (public or personal).",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"requestBody" : {
"description" : "The traceability configuration request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
}
},
"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}/traceability/views/{id}" : {
"get" : {
"tags" : [
"traceability" ],
"summary" : "Gets a traceability view configuration.",
"description" : "Triggers the retrieval of a traceability view configuration.",
"operationId" : "getTraceabilityViewConfiguration",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view configuration.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the view configuration to be retrieved.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "isPublic",
"in" : "query",
"description" : "The toggle to determine the view visibility (public or personal).",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
}
},
"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" : [
"traceability" ],
"summary" : "Updates a traceability view.",
"description" : "Triggers the update of a traceability view.",
"operationId" : "updateTraceabilityView",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the view to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "isPublic",
"in" : "query",
"description" : "The toggle to determine the view visibility (public or personal).",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"requestBody" : {
"description" : "The traceability configuration request body data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TraceMatrixConfigData"
}
}
}
},
"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."
}
}
},
"delete" : {
"tags" : [
"traceability" ],
"summary" : "Removes a traceability view.",
"description" : "Triggers the removal of a traceability view.",
"operationId" : "removeTraceabilityView",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the view to be removed.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "isPublic",
"in" : "query",
"description" : "The toggle to determine the view visibility (public or personal).",
"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}/traceability/views/{id}/matrix/export/excel" : {
"get" : {
"tags" : [
"traceability" ],
"summary" : "Exports a traceability view as excel file.",
"description" : "Triggers the export of a traceability view as excel file.",
"operationId" : "exportExcelFile",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the view to be exported as excel file.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "isPublic",
"in" : "query",
"description" : "The toggle to determine the view visibility (public or personal).",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded."
},
"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}/traceability/views/{id}/matrix/export/xml" : {
"get" : {
"tags" : [
"traceability" ],
"summary" : "Exports a traceability view as XML file.",
"description" : "Triggers the export of a traceability view as XML file.",
"operationId" : "exportXMLFile",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The project key of the view.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The id of the view to be exported as XML file.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "isPublic",
"in" : "query",
"description" : "The toggle to determine the view visibility (public or personal).",
"schema" : {
"type" : "boolean",
"default" : true
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded."
},
"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" : {
"get" : {
"tags" : [
"coverage" ],
"summary" : "Gets all coverage filter of a certain project.",
"description" : "Retrieves all the coverage filter created for a certain project.",
"operationId" : "getAllCoverageFilters",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filters to be retrieved.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Request has succeeded.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
"$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."
}
}
},
"post" : {
"tags" : [
"coverage" ],
"summary" : "Saves coverage filter.",
"description" : "Saves coverage filter in the specified project.",
"operationId" : "saveCoverageView",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be saved.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"description" : "The coverage filter request body data.",
"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 a specific coverage filter.",
"description" : "Retrieves a specific coverage filter based on the filter id.",
"operationId" : "getCoverageFilter",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be retrieved.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"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."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"put" : {
"tags" : [
"coverage" ],
"summary" : "Updates coverage filter.",
"description" : "Updates coverage filter in the specified project.",
"operationId" : "updateCoverageView",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"description" : "The coverage filter update request body data.",
"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."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
},
"delete" : {
"tags" : [
"coverage" ],
"summary" : "Removes a specific coverage filter.",
"description" : "Removes a specific coverage filter based on the filter id.",
"operationId" : "removeCoverageView",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be removed.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"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}/coverage/views/{id}/move/public" : {
"put" : {
"tags" : [
"coverage" ],
"summary" : "Moves coverage filter from private to public.",
"description" : "Move coverage filter from being a private to public filter.",
"operationId" : "moveCoverageViewPrivateToPublic",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be moved.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id of the filter to be moved.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"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."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}/move/private" : {
"put" : {
"tags" : [
"coverage" ],
"summary" : "Moves coverage filter from public to private.",
"description" : "Move coverage filter from being a public to private filter.",
"operationId" : "moveCoverageViewPublicToPrivate",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be moved.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id of the filter to be moved.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"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."
},
"500" : {
"description" : "Server has encountered a situation it doesn't know how to handle."
}
}
}
},
"/projects/{projectKey}/coverage/views/{id}/columns" : {
"post" : {
"tags" : [
"coverage" ],
"summary" : "Adds coverage view column.",
"description" : "Adds a coverage filter column to and existing coverage filter.",
"operationId" : "addCoverageViewColumn",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"requestBody" : {
"description" : "The coverage filter column request body data.",
"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 the last coverage filter column of an existing coverage filter.",
"operationId" : "removeCoverageViewColumn",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"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}/coverage/views/{id}/columns/{position}" : {
"put" : {
"tags" : [
"coverage" ],
"summary" : "Updates coverage view column.",
"description" : "Updates a coverage filter column of an existing coverage filter based on the position specified.",
"operationId" : "updateCoverageViewColumn",
"parameters" : [
{
"name" : "projectKey",
"in" : "path",
"description" : "The existing project key of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"name" : "id",
"in" : "path",
"description" : "The coverage filter id of the filter to be updated.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
},
{
"name" : "position",
"in" : "path",
"description" : "The position of the column to update.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32"
}
} ],
"requestBody" : {
"description" : "The coverage filter column request body data.",
"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."
}
}
}
}
},
"components" : {
"schemas" : {
"ListWrapperCallbackApplicationRoleBean" : {
"type" : "object"
},
"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"
}
}
},
"FolderDataREST" : {
"required" : [
"name" ],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Name of Folder to create/update."
},
"description" : {
"type" : "string",
"description" : "Description of the folder to create/update."
},
"parent" : {
"$ref" : "#/components/schemas/FolderData"
},
"watchers" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserJsonBean"
}
}
},
"example" : {
"name" : "string",
"description" : "string",
"parent" : {
"id" : 1
},
"watchers" : [
{
"name" : "user-name"
} ]
}
},
"ProjectTreeDataIssue" : {
"required" : [
"key" ],
"type" : "object",
"properties" : {
"issueId" : {
"type" : "integer",
"format" : "int64"
},
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"key" : {
"type" : "string",
"description" : "Target/Destination Jira issue key."
},
"url" : {
"type" : "string"
},
"summary" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"rootfolderdescription" : {
"type" : "string"
},
"description_html" : {
"type" : "string"
},
"rootfolderdescription_html" : {
"type" : "string"
},
"icon_url" : {
"type" : "string"
},
"issueType" : {
"type" : "string"
},
"childReqs" : {
"$ref" : "#/components/schemas/ChildReqRelationDatas"
},
"hasChild" : {
"type" : "boolean"
},
"parentId" : {
"type" : "integer",
"format" : "int64"
},
"projectTreeDataPage" : {
"$ref" : "#/components/schemas/ProjectTreeDataPage"
},
"issuekey" : {
"type" : "string"
},
"issueTypeIcon" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int64"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
}
}
},
"InwardOutwardData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"self" : {
"type" : "string"
},
"fields" : {
"type" : "object"
}
}
},
"IssuePath" : {
"type" : "object",
"properties" : {
"project" : {
"$ref" : "#/components/schemas/ProjectJsonBean"
},
"path" : {
"type" : "string"
},
"id" : {
"type" : "integer",
"format" : "int32"
}
}
},
"IssueLinkTypeJsonBean" : {
"type" : "object"
},
"GroupJsonBean" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"self" : {
"type" : "string",
"format" : "uri"
}
}
},
"TraceMatrixConfigColumns" : {
"type" : "object",
"properties" : {
"source" : {
"$ref" : "#/components/schemas/TraceMatrixConfigSource"
}
}
},
"TraceMatrixConfigSource" : {
"type" : "object",
"properties" : {
"jql" : {
"type" : "string"
},
"filter" : {
"$ref" : "#/components/schemas/FilterBean"
},
"issueTypes" : {
"$ref" : "#/components/schemas/TraceMatrixConfigSourceIssueTypes"
},
"displaySize" : {
"type" : "integer",
"format" : "int64"
}
}
},
"IssuePathData" : {
"type" : "object",
"properties" : {
"issue" : {
"$ref" : "#/components/schemas/IssueRefJsonBean"
},
"issuePaths" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssuePath"
}
}
}
},
"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"
}
},
"MoveFolderData" : {
"type" : "object",
"properties" : {
"folder" : {
"$ref" : "#/components/schemas/FolderData"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"folder" : {
"id" : 1
},
"position" : 1,
"absolutePosition" : 1
}
},
"TraceMatrixConfigSourceIssueTypes" : {
"type" : "object",
"properties" : {
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssueTypeJsonBean"
}
},
"useAllIssueTypes" : {
"type" : "boolean"
}
}
},
"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"
}
},
"ProjectJsonBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"projectTypeKey" : {
"type" : "string"
},
"avatarUrls" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"projectCategory" : {
"$ref" : "#/components/schemas/ProjectCategoryJsonBean"
}
}
},
"TraceMatrixConfigLinkTypes" : {
"type" : "object",
"properties" : {
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TraceMatrixConfigLinkTypesDirection"
}
},
"useAllLinkTypes" : {
"type" : "boolean"
},
"scope" : {
"type" : "boolean"
}
}
},
"ProjectCategoryJsonBean" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"TraceMatrixConfig" : {
"type" : "object",
"properties" : {
"rows" : {
"$ref" : "#/components/schemas/TraceMatrixConfigRows"
},
"columns" : {
"$ref" : "#/components/schemas/TraceMatrixConfigColumns"
},
"linkTypes" : {
"$ref" : "#/components/schemas/TraceMatrixConfigLinkTypes"
}
}
},
"Period" : {
"type" : "object",
"properties" : {
"from" : {
"type" : "string",
"format" : "date-time"
},
"to" : {
"type" : "string",
"format" : "date-time"
}
}
},
"ChildReqRelationData" : {
"type" : "object",
"properties" : {
"issueId" : {
"type" : "integer",
"format" : "int64"
},
"id" : {
"type" : "integer",
"format" : "int64"
},
"key" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"summary" : {
"type" : "string"
},
"status" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"description_html" : {
"type" : "string"
},
"icon_url" : {
"type" : "string"
},
"issueType" : {
"type" : "string"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
},
"childReqs" : {
"$ref" : "#/components/schemas/ChildReqRelationDatas"
}
}
},
"TraceMatrixConfigRows" : {
"type" : "object",
"properties" : {
"source" : {
"$ref" : "#/components/schemas/TraceMatrixConfigSource"
}
}
},
"FilePart" : {
"type" : "object",
"properties" : {
"contentType" : {
"type" : "string"
},
"formField" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"inputStream" : {
"type" : "object"
}
}
},
"IssueRefJsonBean" : {
"type" : "object"
},
"SuspectLink" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"link" : {
"$ref" : "#/components/schemas/LinkData"
}
},
"example" : {
"link" : {
"id" : "10001",
"inwardIssue" : {
"id" : "10004",
"key" : "ABC-123",
"self" : "http://www.example.com/jira/rest/api/2/issue/ABC-123"
},
"outwardIssue" : {
"id" : "10005",
"key" : "ABC-234",
"self" : "http://www.example.com/jira/rest/api/2/issue/ABC-234"
},
"type" : {
"id" : "1000",
"name" : "Duplicate",
"inward" : "Duplicated by",
"outward" : "Duplicates",
"self" : "http://www.example.com/jira/rest/api/2/issueLinkType/1000"
}
}
}
},
"FolderData" : {
"required" : [
"id" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "Target/Destination folder id.",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"parentId" : {
"type" : "integer",
"format" : "int64"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
},
"attachments" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttachmentJsonBean"
}
},
"folders" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FolderData"
}
},
"description" : {
"type" : "string"
},
"parent" : {
"$ref" : "#/components/schemas/FolderData"
},
"watchers" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserJsonBean"
}
},
"issues" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssueData"
}
}
}
},
"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"
}
},
"TargetIssueRequestData" : {
"type" : "object",
"properties" : {
"issue" : {
"$ref" : "#/components/schemas/ProjectTreeDataIssue"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
}
}
},
"ProjectTreeDataPage" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"appId" : {
"type" : "string"
},
"appUrl" : {
"type" : "string"
},
"pageId" : {
"type" : "integer",
"format" : "int64"
},
"title" : {
"type" : "string"
}
}
},
"ProjectTreeDataRequest" : {
"type" : "object",
"properties" : {
"projectId" : {
"type" : "integer",
"format" : "int64"
},
"folderId" : {
"type" : "integer",
"format" : "int64"
},
"isRootIssue" : {
"type" : "boolean",
"writeOnly" : true
},
"issueId" : {
"type" : "integer",
"format" : "int64"
},
"offset" : {
"type" : "integer",
"format" : "int32"
},
"filterArg" : {
"$ref" : "#/components/schemas/FilterArg"
},
"queryParams" : {
"type" : "string"
},
"rootIssue" : {
"type" : "boolean"
}
}
},
"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"
}
},
"ListWrapperCallbackGroupJsonBean" : {
"type" : "object"
},
"TraceMatrixConfigLinkTypesDirection" : {
"type" : "object",
"properties" : {
"direction" : {
"type" : "string"
},
"link" : {
"$ref" : "#/components/schemas/IssueLinkTypeJsonBean"
}
}
},
"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"
}
},
"SearchSuspectLinkData" : {
"type" : "object",
"properties" : {
"includeLinksToOtherProjects" : {
"type" : "boolean"
},
"period" : {
"$ref" : "#/components/schemas/Period"
},
"useAllLinkTypes" : {
"type" : "boolean"
},
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssueLinkTypeJsonBean"
}
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserJsonBean"
}
}
},
"example" : {
"includeLinksToOtherProjects" : false,
"period" : {
"from" : "2020-01-01T01:00:00Z",
"to" : "2020-07-29T01:00:00Z"
},
"useAllLinkTypes" : true,
"types" : [
{
"id" : "10002",
"name" : "Duplicate",
"inward" : "is duplicated by",
"outward" : "duplicates",
"self" : "https://jiraccdev.intra.infineon.com/rest/api/2/issueLinkType/10002"
},
{
"id" : "10003",
"name" : "Relates",
"inward" : "relates to",
"outward" : "relates to",
"self" : "https://jiraccdev.intra.infineon.com/rest/api/2/issueLinkType/10003"
} ],
"users" : [
{
"name" : "admin"
} ]
}
},
"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"
}
},
"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"
}
},
"SuspectConfigurationData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"notifyAssignee" : {
"type" : "boolean"
},
"notifyReporter" : {
"type" : "boolean"
},
"notifyProjectLead" : {
"type" : "boolean"
},
"useAllLinkTypes" : {
"type" : "boolean"
},
"useAllFields" : {
"type" : "boolean"
},
"users" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserJsonBean"
}
},
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssueLinkTypeJsonBean"
}
},
"fields" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FieldBean"
}
},
"scope" : {
"type" : "string"
}
},
"example" : {
"name" : "configuration",
"notifyAssignee" : true,
"notifyReporter" : true,
"notifyProjectLead" : true,
"users" : [
{
"name" : "admin1"
},
{
"name" : "user1"
} ],
"types" : [
{
"id" : "1000",
"name" : "Duplicate",
"inward" : "Duplicated by",
"outward" : "Duplicates",
"self" : "http://www.example.com/jira/rest/api/2//issueLinkType/1000"
} ],
"useAllLinkTypes" : true,
"useAllFields" : true,
"fields" : [
{
"id" : "assignee"
},
{
"id" : "customfield_10003"
} ],
"scope" : "both"
}
},
"ChildReqRelationDatas" : {
"type" : "object",
"properties" : {
"childReqs" : {
"type" : "array",
"xml" : {
"name" : "childReq"
},
"items" : {
"$ref" : "#/components/schemas/ChildReqRelationData"
}
}
}
},
"LinkData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"inwardIssue" : {
"$ref" : "#/components/schemas/InwardOutwardData"
},
"outwardIssue" : {
"$ref" : "#/components/schemas/InwardOutwardData"
},
"type" : {
"$ref" : "#/components/schemas/IssueLinkTypeJsonBean"
}
}
},
"QuickFilterData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"jql" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"project" : {
"type" : "integer",
"format" : "int64"
},
"position" : {
"type" : "integer",
"format" : "int32"
}
}
},
"JsonTypeBean" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
},
"items" : {
"type" : "string"
},
"system" : {
"type" : "string"
},
"custom" : {
"type" : "string"
},
"customId" : {
"type" : "integer",
"format" : "int64"
}
}
},
"IssueData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"positionTime" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
},
"data" : {
"$ref" : "#/components/schemas/IssueRefJsonBean"
},
"issues" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IssueData"
}
}
}
},
"TraceMatrixConfigData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64"
},
"name" : {
"type" : "string"
},
"configuration" : {
"$ref" : "#/components/schemas/TraceMatrixConfig"
},
"public" : {
"type" : "boolean"
}
}
},
"PluginVersionInformation" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string"
}
}
},
"FilterArg" : {
"type" : "object",
"properties" : {
"jqlStatement" : {
"type" : "string"
},
"filterId" : {
"type" : "integer",
"format" : "int64"
},
"folderIdChildrenRequired" : {
"type" : "integer",
"format" : "int64"
},
"folderSearchQuery" : {
"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"
}
},
"TargetFolderRequestData" : {
"type" : "object",
"properties" : {
"folder" : {
"$ref" : "#/components/schemas/FolderData"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"absolutePosition" : {
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"folder" : {
"id" : 1
},
"position" : 1,
"absolutePosition" : 1
}
},
"ProjectBeanData" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"avatarUrls" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"projectCategory" : {
"$ref" : "#/components/schemas/ProjectCategoryJsonBean"
},
"description" : {
"type" : "string"
}
}
},
"CoverageViewColumnData" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string"
},
"source" : {
"$ref" : "#/components/schemas/CoverageViewColumnSourceData"
},
"position" : {
"type" : "integer",
"format" : "int64"
},
"basedOn" : {
"type" : "integer",
"format" : "int64"
}
}
},
"LinkTypesData" : {
"type" : "object",
"properties" : {
"link" : {
"$ref" : "#/components/schemas/IssueLinkTypeJsonBean"
},
"direction" : {
"type" : "string"
}
}
},
"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"
}
},
"projects" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProjectData"
}
},
"useAllIssueTypes" : {
"type" : "boolean"
}
}
},
"CoverageViewLinkTypeData" : {
"type" : "object",
"properties" : {
"useAllLinkTypes" : {
"type" : "boolean"
},
"types" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/LinkTypesData"
}
}
}
},
"CoverageViewColumnSourceData" : {
"type" : "object",
"properties" : {
"jql" : {
"type" : "string"
},
"filter" : {
"$ref" : "#/components/schemas/FilterBean"
},
"issueTypes" : {
"$ref" : "#/components/schemas/CoverageViewIssueTypeData"
},
"linkTypes" : {
"$ref" : "#/components/schemas/CoverageViewLinkTypeData"
}
}
},
"ProjectData" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"key" : {
"type" : "string"
},
"url" : {
"type" : "string"
},
"icon" : {
"type" : "string"
}
}
}
}
}
} |