| Open api | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
{
"openapi" : "3.0.1",
"info" : {
"title" : "R4JC - Requirements Management for Jira Cloud Rest API",
"description" : "Rest APIs for R4JC - Requirements Management for Jira Cloud application.",
"version" : "1.0"
},
"servers" : [
{
"url" : "/"
}
],
"paths" : {
"/rest/api/1/treetraceability/projects/{projectKeyprojectId}/views/{viewId}/itemssort" : {
"put" : {
"tags" : [ "Tree"
"Traceability" ],
"summary" : "MoveSort existing item(s) in the tree.traceability views by name",
"description" : "MoveSort existingtraceability tree item(s) and all its children from one parent location to another location in the tree.views by name in R4J - Requirements Management for JIRA plugin",
"operationId" : "moveItemssortTraceabilityViews",
"parameters" : [ {
"name" : "projectKeyprojectId",
"in" : "path",
"description" : "Jira Project KeyID",
"examplerequired" : "TEST"true,
"requiredschema" : true,{
"schematype" : {"integer",
"typeformat" : "stringint64",
"example" : }null
}
]}, {
"requestBodyname" : {"viewId",
"descriptionin" : "Important for request body parameters:\n- The Object.id, Object.jiraIssueId, or Object.jiraIssueKey is the target location and where the requested Object.items[n] will be moved to. \n\n\n- The Object.items[n].jiraIssueId or Object.items[n].jiraIssueKey are the items that will be moved.\n\n\n- Only one of the identifiers (id, jiraIssueId, or jiraIssueKey) must be provided per Object.\n\n\n- \"id\" is not supported in the Object.items array. It will be ignored when provided.\n\n\n- If an invalid \"position\" is provided, the item will be moved to the last position in the target location.\n\n\n- A maximum of 100 Object.items may be processed per request.",
path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
"content":}, {
"name" : "application/jsonsort":,
{ "in" : "schema": {
query",
"$refdescription" : "#/components/schemas/UpdateRequestDto"
Order of the views when sorting.",
}, "required" : true,
"examplesschema" : {
"type" : "Move items to the root folder": {"string",
"example" : null
"description": "-1 is the root folder identifier.",}
} ],
"valueresponses" : {
"403" : {
"id": -1, "description" : "Project is not activated.",
"jiraIssueIdcontent" : null,{
"application/json" : {
"jiraIssueKey": null, "schema" : {
"items": [ "$ref" : "#/components/schemas/ErrorMessage"
{ },
"jiraIssueIdexample" : {
12195, "error" : "Project is not activated."
"jiraIssueKey": null, }
"position": 1 }
}
}, },
"404" : {
{ "description" : "View does not exist.",
"jiraIssueIdcontent" : null, {
"application/json" : {
"jiraIssueKey": "TEST-100", "schema" : {
"position$ref" : 2"#/components/schemas/ErrorMessage"
},
} "example" : {
] "error" : "View does not exist."
} }
}, }
"Move items to the another location": { }
},
"value": { "400" : {
"description" : "id": null,
Invalid data.",
"jiraIssueId": null,
"content" : {
"jiraIssueKeyapplication/json" : "TEST-99",
{
"itemsschema" : [{
"$ref" : "#/components/schemas/ErrorMessage"
{ "jiraIssueId": 12195,
},
"jiraIssueKeyexample" : null,
{
"positionerror" : 1"Sort order test is invalid."
}
}, }
{ }
},
"jiraIssueId204" : null,{
"description" : "Request is successful.",
"jiraIssueKey": "TEST-100", "content" : {
"position*/*" : 2{
"schema" : {
} "type" : "object",
] "example" : }null
},
} "example" : null
} }
}, }
"required": true
},
"responses": { "200""401" : {
"description" : "Successfully moved item(s) recursively from the previous location the the target location in tree. Only the moved items are included in the response.Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateResponseDtoErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n "value\"timeStamp\": {\"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
"values":}
[ }
{},
"500" : {
"iddescription" : 826,"Server has encountered an error it doesn't know how to handle.",
"isFoldercontent" : {
false, "application/json" : {
"jiraIssueId": 12195, "schema" : {
"position$ref" : 3,"#/components/schemas/ErrorMessage"
},
"hasChildren": false, "example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
"path": [ }
}
104, }
}
}
},
826
"/rest/api/1/traceability/projects/{projectId}/views/{viewId}/move" : {
"put" : {
"tags" : [ "Traceability" ],
"summary" : "Move a saved view between Private and Public views",
} "description" : "Move a saved view between Private and Public views in R4JC - Requirements Management ]
for Jira Cloud",
"operationId" : "moveTraceabilityView",
}"parameters" : [ {
"name" : "projectId",
} "in" : "path",
} "description" : "Jira Project ID",
} "required" : }true,
"400schema" : {
"descriptiontype" : "Request validation error.integer",
"contentformat" : {
"int64",
"application/jsonexample" : {null
}
"schema": { }, {
"$refname" : "#/components/schemas/RestApiErrorMessage"viewId",
"in" : "path",
}, "description" : "View ID",
"examples": { "required" : true,
"Multiple identifiers provided""schema" : {
"descriptiontype" : "Only one of these parameters must be provided for this object to pass.integer",
"format" : "value": {
"int64",
"errorexample" : "Younull
should specify either Id, Jira Issue Id, or Jira Issue Key only."}
}, {
}"name" : "targetId",
"in" : "query",
}, "description" : "Target view ID on where to move the source view ID."No,
identifiers provided": { "required" : true,
"valueschema" : {
"errortype" : "integer"Id,
Jira Issue Id, or Jira Issue Key must not be blank." "format" : "int64",
"example" : null
} }
}, {
"name" "Cannot move root folder": {: "siblingId",
"in" : "query",
"valuedescription" : {"View ID on where should the source ID be placed before it.",
"errorrequired" : "Rootfalse,
folder cannot be moved." "schema" : {
} "type" : "integer",
"format" : "int64",
} "example" }
: null
}
} ],
} "responses" : {
}, "401403" : {
"description" : "Authentication failedProject is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJsonErrorMessage"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"{
"error" : "Project is not activated."
}
}
}
},
"403204" : {
"description" : "User has no permission to view project or projectRequest is not active in R4Jsuccessful.",
"content" : {
"application/json" : {
"schema" : {
"$reftype" : "#/components/schemas/RestApiErrorMessage"object",
}, "example" : null
"examples": { },
"No project permission": {"example" : null
}
"value": { }
},
"error404" : "You don't have permission to view the project."{
"description" : "Project / view does not exist.",
} "content" : {
}, "application/json" : {
"Project not active"schema" : {
"$ref" : "value": {#/components/schemas/ErrorMessage"
},
"error": "Project is not active." "example" : {
} "error" : "Project / view does }not exist."
}
}
}
},
"404409" : {
"description" : "ProjectSimilar orview issue does not existalready exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessageErrorMessage"
},
"examplesexample" : {
"error"Project not: found":Similar view {already exists."
}
"value": { }
"error": "Could not find project with key TEST." }
},
"401" : {
} "description" : "Authentication failed.",
}, "content" : {
"Issue not found": { "application/json" : {
"valueschema" : {
"error$ref" : "An issue with key 'TEST-1' does not exist for field 'key'."#/components/schemas/ErrorJson"
},
} "example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov }16 09:53:46 UTC 2021\",\n }\"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
},
"post"/rest/api/1/traceability/projects/{projectId}/views/{viewId}" : {
"tagsget" : [
{
"Treetags" : [ "Traceability" ],
"summary" : "AddRetrieve existingsaved Jira issue(s) to the tree.traceability view",
"description" : "AddRetrieve saved existingtraceability Jira issue(s) to a specific location in the tree.view in R4J - Requirements Management for JIRA plugin",
"operationId" : "addExistingIssueToTree_1getSavedTraceabilityView",
"parameters" : [ {
"name" : "projectKeyprojectId",
"in" : "path",
"description" : "Jira Project KeyID",
"examplerequired" : "TEST"true,
"requiredschema" : true,{
"schematype" : {
"integer",
"typeformat" : "stringint64",
}"example" : null
}
]}, {
"requestBodyname" : {"viewId",
"descriptionin" : "Important for request body parameters:\n- The Object.id, Object.jiraIssueId, or Object.jiraIssueKey is the target location and where the requested Object.items[n] will be added to. \n\n\n- The Object.items[n].jiraIssueId or Object.items[n].jiraIssueKey are the items that will be added.\n\n\n- Only one of the identifiers (id, jiraIssueId, or jiraIssueKey) must be provided per Object.\n\n\n- \"id\" is not supported in the Object.items array. It will be ignored when provided.\n\n\n- If an invalid \"position\" is provided, the item will be moved to the last position in the target location.\n\n\n- A maximum of 100 Object.items may be processed per request.","path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRequestDtoErrorMessage"
},
"examplesexample" : {
"Adderror" issues: to"Project theis rootnot folderactivated.":
{ }
"description": "-1 is the root folder identifier.", }
"value":}
{ },
"id404" : -1,{
"description" : "View does not exist.",
"jiraIssueId": null, "content" : {
"jiraIssueKey": null, "application/json" : {
"itemsschema" : [{
"$ref" : "#/components/schemas/ErrorMessage"
{ },
"jiraIssueId": 12195, "example" : {
"jiraIssueKeyerror" : null,"View does not exist."
}
"position": 1 }
},
},
"200" : {
"description" : "Request is successful.",
"jiraIssueIdcontent" : null,{
"application/json" : {
"jiraIssueKey": "TEST-100", "schema" : {
"position$ref" : 2"#/components/schemas/CoverageFilterDto"
},
} "example" : {
] "id" : 25,
} "name" : "traceability }view",
"Add issues to the another location": { "isPublic" : false,
"valuecolumns" : [ {
"id" : null1,
"jiraIssueIdlabel" : "Row nullDefinition",
"jiraIssueKeycolumnBasis" : "TEST-99"0,
"itemssource" : ["ISSUE_TYPES",
"projects" : {[ ],
"jiraIssueIdissueTypes" : 12195,[ {
"jiraIssueKeyid" : null1,
"value" : "position10008": 1
}, ]
}, {
"jiraIssueIdid" : null2,
"jiraIssueKeylabel" : "TEST-100Column Definition",
"columnBasis" : 1,
"position": 2 "source" : "ISSUE_TYPES",
} "projects" : [ ],
"issueTypes" : }[ {
} "id" : 2,
} } "value" : "10008"
}, "required": true } ]
}, "responses": { } ],
"200": { "descriptionfields" : "Successfully[ added],
Jira issue(s) as tree items in the target location specified. Only the added issues are included in the response."scope", : false,
"content": { "linkTypes" : [ {
"application/json": { "schemaid" : 1,
{ "$refvalue" : "#/components/schemas/RestApiErrorMessage10000-IN"
}, ]
"example": [}
}
{ }
"id": 826,
},
"isFolder401" : false,{
"description" : "jiraIssueId": 12195,
"Authentication failed.",
"positioncontent" : 1,
{
"hasChildrenapplication/json" : false,
{
"pathschema" : [{
"$ref" : "#/components/schemas/ErrorJson"
104, },
826 "example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n ] \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n }
]\"trace\": null\n}"
}
}
},
"400500" : {
"description" : "Request validation errorServer has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessageErrorMessage"
},
"examplesexample" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
"Multiple identifiers provided": { }
}
"description": "Only one of these parameters must}
be provided for this object to pass."},
"put" : {
"tags" : [ "valueTraceability": {],
"summary" : "Update saved traceability view",
"errordescription" : "YouUpdate shouldsaved specifytraceability eitherview Id,in JiraR4J Issue- Id,Requirements orManagement Jirafor Issue Key only."JIRA plugin",
"operationId" : "updateTraceabilityFilter",
"parameters" }: [ {
"name" : "projectId",
}, "in" : "path",
"description"No identifiers: provided":Jira {project ID",
"required" : true,
"value": { "schema" : {
"errortype" : "integer"Id,
Jira Issue Id, or Jira Issue Key must not be blank." "format" : "int64",
"example" : null
} }
}, {
"Issue(s) already exist in tree": {"name" : "viewId",
"in" "value": {: "path",
"error""description" : "Some issues are already in tree."View ID",
"required" : true,
} "schema" : {
"type" }: "integer",
"format" : "int64",
} "example" : }
null
}
} }],
"401requestBody" : {
"description" : "AuthenticationRequest failed.data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJsonCoverageFilterDto"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"{
"id" : 10000,
"name" : "Sample Project",
} } "isPublic" : true,
}, "type" : "403": {TRACEABILITY_FOLDER",
"descriptionscope" : "Userfalse,
has no permission to view project or project is not active in R4J.", "linkTypes" : [ {
"content": { "value" : "application/json": {10000-IN"
"schema": {
} ],
"$refcolumns" : "#/components/schemas/RestApiErrorMessage"
},[ {
"examplesid" : {10002,
"label"No project: permission":Row {Definition",
"valuecolumnBasis" : {
0,
"errorsource" : "ISSUE_TYPES"You,
don't have permission to view the project." "projects" : [ {
} "id" : 10004,
}, "Projectvalue" not: active":sample {value1"
} ]
"value": { } ],
"error": "Project is not active." "parentId" : 10001
} }
}
},
"required" }
: true
},
"responses" : },{
"404403" : {
"description" : "Project or issue doesis not existactivated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessageErrorMessage"
},
"examplesexample" : {
"error" : "Project is not foundactivated.":
{ }
"value": { }
}
"error": "Could not find project with key TEST." },
"404" : {
} "description" : "View does not exist.",
}, "content" : {
"Issue not found": { "application/json" : {
"valueschema" : {
"$ref" : "error": "An issue with key 'TEST-1' does not exist for field 'key'.""#/components/schemas/ErrorMessage"
},
"example" : {
} "error" : "View does not }exist."
}
}
}
},
"500200" : {
"description" : "ServerRequest has encountered an error it doesn't know how to handleis successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessageCoverageFilterDto"
},
"example" : "{\n
\"error\": \"Unknown error has occurred.\"\n}" "id" : }10000,
} "name" : }
"Sample Project",
} }, "deleteisPublic" : {true,
"tags": [ "type" : "TreeTRACEABILITY_FOLDER",
], "summaryscope" : "Remove existing item(s) from the tree.", false,
"descriptionlinkTypes" : [ "Remove{
existing item(s) and all its children from any location in the tree.", "operationIdvalue" : "removeItems",10000-IN"
"parameters": [ } ],
{ "namecolumns" : "projectKey", [ {
"inid" : "path",10001,
"descriptionlabel" : "JiraRow project keyDefinition",
"required": true, "columnBasis" : 10002,
"schema": { "typesource" : "stringISSUE_TYPES",
},
"exampleprojects" : "TEST"[ {
}, { "id" : 10004,
"name": "idOrJiraIssueKey", "invalue" : "querysample value1",
"description": "List of tree item id or Jira issue} key",]
"required": true, } ],
"schema": {
"typeparentId" : "string"10001
}, }
"example": "TEST-100" }
} }
], "responses": {},
"200400" : {
"description" : "SuccessfullyInvalid removed item(s) and their children from the tree. Only the total number of items removed out of the requested ones will be counted in the response.",
"content"user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RemovedItemsDtoErrorMessage"
},
"example" : {
"totalItemsRemovederror" : 10"Invalid user input."
}
}
}
},
"400409" : {
"description" : "RequestSimilar view validationalready errorexists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessageErrorMessage"
},
"examplesexample" : {
"Maxerror" items: exceeded":View {with name Test already exists."
"value":}
{ }
"error": "Only a maximum of}
100 items can be removed per request." },
"401" : {
} "description" : "Authentication failed.",
}, "content" : {
"Cannot remove root folder"application/json" : {
"valueschema" : {
"error$ref" : "Root folder can not be removed.#/components/schemas/ErrorJson"
},
} "example" : "{\n \"status\": 401,\n } \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n }\"trace\": null\n}"
}
}
},
"401500" : {
"description" : "Authentication failedServer has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJsonErrorMessage"
},
"example" : "{\n \"statuserror\": 401,\n \"Unknown error has occurred.\"error\n}":
\"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
} }
} }
},
"403delete" : {
"tags" : [ "descriptionTraceability": ],
"User has no permission to view project or project"summary" is: not"Delete activesaved intraceability R4J.view",
"contentdescription" : {"Delete saved traceability view in R4J - Requirements Management for JIRA plugin",
"application/json": { "operationId" : "deleteTraceabilityView",
"schemaparameters" : [ {
"$refname" : "#/components/schemas/RestApiErrorMessage"projectId",
"in" : "path",
}, "description" : "Project ID",
"examples": { "required" : true,
"schema"No project permission": {
"value": {
"type" : "integer",
"errorformat" : "int64"You,
don't have permission to view the project." "example" : null
}
}, {
"name" : "Project not active": {"viewId",
"value": {"in" : "path",
"description" : "View ID",
"error": "Project is not active.required" : true,
"schema" : {
} "type" : "integer",
} "format" : "int64",
} "example" : null
}
} ],
} "responses" : {
},
"404403" : {
"description" : "Project oris issue does not existactivated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessageErrorMessage"
},
"examples" : {
"Project not foundactive" : {
"valuedescription" : {"Project not active",
"errorvalue" : "Could{
not find project with key TEST "error" : "Project is not activated."
}
},
"IssueNo notproject foundpermission" : {
"description" : "No project permission",
"value" : {
"error" : "An issue with key 'TEST-1' does not exist for field 'key'You don't have permission to view the project."
}
}
},
"example" : null
}
}
},
"500204" : {
"description" : "ServerRequest has encountered an error it doesn't know how to handleis successful.",
"content" : {
"application*/json*" : {
"schema" : {
"$reftype" : "#/components/schemas/ErrorMessage"object",
}, "example" : null
"example": "{\n \"error\": \"Unknown error has occurred.\"\n}"},
} "example" : null
} }
} }
} },
"/rest/api/1/tree/projects/{projectKey}/items/{idOrJiraIssueKey}": { "get401" : {
"tags": [ "description" : "Tree""Authentication failed.",
], "content" : {
"summary": "Get tree item(s).", "descriptionapplication/json" : "Get{
the children of the specified tree item id or Jira issue key. You can retrieve the complete"schema" tree: structure{
by recursively using this endpoint on items that return 'hasChildren' parameter as true.", "operationId$ref" : "getTreeStructureById",#/components/schemas/ErrorJson"
"parameters": [ },
{ "name": "projectKey",
example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"400" : {
"description" : "Invalid user account.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "User Account ID is empty."
}
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/tasks/{taskId}" : {
"get" : {
"tags" : [ "BackgroundTask" ],
"summary" : "Retrieve the background details for the specified task Id",
"description" : "Retrieve the background details for the specified task Id in the application",
"operationId" : "getBackgroundTaskById",
"parameters" : [ {
"name" : "taskId",
"in" : "path",
"description" : "task ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Task doesn't exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Task doesn't exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"id" : "619",
"taskName" : "Sample task",
"data" : "Sample data",
"status" : "IN_PROGRESS",
"createdDate" : "12/12/12"
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"put" : {
"tags" : [ "BackgroundTask" ],
"summary" : "Abort a background task with a specified task Id",
"description" : "Abort a background task for the specified task Id in the application",
"operationId" : "cancelBackgroundTaskById",
"parameters" : [ {
"name" : "taskId",
"in" : "path",
"description" : "task ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Task doesn't exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "Async task not found."
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : "Task Cancelling..."
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/enable" : {
"put" : {
"tags" : [ "Project" ],
"summary" : "Enable a disabled project",
"description" : "Enables a disabled project in R4JC - Requirements Management for Jira Cloud",
"operationId" : "enableProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"404" : {
"description" : "Resource / project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Resource / project does not exist.."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/disable" : {
"put" : {
"tags" : [ "Project" ],
"summary" : "Disable an active project",
"description" : "Disables an active project in R4JC - Requirements Management for Jira Cloud",
"operationId" : "disableProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"404" : {
"description" : "Resource / project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Resource / project does not exist.."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/{baselineId}" : {
"get" : {
"tags" : [ "Baseline" ],
"summary" : "Retrieve the baseline details",
"description" : "Retrieve baseline details in R4J - Requirements Management for JIRA plugin",
"operationId" : "getBaselineDetails",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "Baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Baseline does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline doesn't exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Name",
"description" : "Sample Description",
"fixVersionIds" : [ 1245, 151, 251 ],
"componentIds" : [ 215, 1561, 141 ],
"createdBy" : "test-user",
"createdDate" : "2022-10-14T09:42:21.402+00:00"
}
}
}
},
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"put" : {
"tags" : [ "Baseline" ],
"summary" : "Update baseline details",
"description" : "Update details of an existing baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "updateBaseline",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "Baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineDto"
},
"example" : {
"name" : "Baseline",
"description" : "Description",
"fixVersionIds" : [ 1 ],
"componentIds" : [ 2 ]
}
}
},
"required" : true
},
"responses" : {
"404" : {
"description" : "Baseline does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline doesn't exist."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline name must not be blank."
}
}
}
},
"409" : {
"description" : "Baseline name already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline name already exists."
}
}
}
},
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"delete" : {
"tags" : [ "Baseline" ],
"summary" : "Removes the specified baseline.",
"description" : "Removes the specified baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "deleteBaseline",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"200" : {
"description" : "File does not exist or already deleted.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline doesn't exist or already deleted."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/issuetypes/associate" : {
"put" : {
"tags" : [ "Project" ],
"summary" : "Associate issue type(s) to active project(s)",
"description" : "Associate issue type(s) to active project(s) in R4J - Requirements Management for JIRA plugin",
"operationId" : "associateIssueTypesToProjects",
"parameters" : [ {
"name" : "contextId",
"in" : "query",
"description" : "Context ID of the task",
"required" : false,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "requirementsIssueTypes"
} ],
"requestBody" : {
"description" : "List of issue types to associate.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"example" : [ "10000" ]
}
},
"required" : true
},
"responses" : {
"202" : {
"description" : "Task is still in progress.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Background task already in progress."
}
}
}
},
"400" : {
"description" : "Invalid issue types",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Issue types must not be empty."
}
}
}
},
"200" : {
"description" : "Successfully started association of issue types to projects.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"id" : 10000
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/export-template/{templateId}/enable" : {
"put" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Enables the specified template.",
"description" : "Enables the specified Export template in R4J - Requirements Management for JIRA plugin",
"operationId" : "enableExportTemplate",
"parameters" : [ {
"name" : "templateId",
"in" : "path",
"description" : "Template ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"404" : {
"description" : "Template does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template does not exist."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/export-template/{templateId}/disable" : {
"put" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Disables the specified template.",
"description" : "Disables the specified Export template in R4J - Requirements Management for JIRA plugin",
"operationId" : "disableExportTemplate",
"parameters" : [ {
"name" : "templateId",
"in" : "path",
"description" : "Template ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"404" : {
"description" : "Template does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template does not exist."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/export-template/{templateId}" : {
"get" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Get Export Template details",
"description" : "Get Export Template details in R4J - Requirements Management for JIRA plugin",
"operationId" : "getExportTemplateDetails",
"parameters" : [ {
"name" : "templateId",
"in" : "path",
"description" : "Template ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"404" : {
"description" : "Template does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template does not exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportTemplateDto"
},
"example" : {
"id" : 15,
"fileId" : "4d49460b-390a-49f9-92c7-48bd390ed984",
"description" : "This is a sample xml",
"scopes" : [ "TREE_VIEW" ],
"projects" : [ 10032, 10030 ],
"fileSize" : 366576,
"enable" : true,
"createdBy" : "5ffbb4758332a1010e17eb65",
"createdDate" : "2022-08-15T05:30:04.418+00:00",
"templateName" : "Sample.xml"
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"put" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Update an export template",
"description" : "Update an existing export template in R4J - Requirements Management for JIRA plugin",
"operationId" : "updateExportTemplate",
"parameters" : [ {
"name" : "templateId",
"in" : "path",
"description" : "Export template ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportTemplateDto"
},
"example" : {
"fileId" : "4d49460b-390a-49f9-92c7-48bd390ed984",
"templateName" : "Sample5.xml",
"description" : "This is a sample xml",
"projects" : [ 10032, 10030 ],
"scopes" : [ "TREE_VIEW" ],
"enable" : true
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"400" : {
"description" : "Required parameter is empty.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Required parameter is empty."
}
}
}
},
"404" : {
"description" : "Template does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template does not exist."
}
}
}
},
"409" : {
"description" : "Template name already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template name already exists."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"delete" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Removes the specified template.",
"description" : "Removes the specified Export template in R4J - Requirements Management for JIRA plugin",
"operationId" : "deleteExportTemplate",
"parameters" : [ {
"name" : "templateId",
"in" : "path",
"description" : "Template ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"200" : {
"description" : "File does not exist or already deleted.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template doesn't exist or already deleted."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/display-fields/projects/{projectId}/views/{viewId}" : {
"get" : {
"tags" : [ "Display Field" ],
"summary" : "Retrieve the fields of selected display field view",
"description" : "Retrieve fields of display field view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getDisplayFieldViewFields",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "Display field view id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "componentType",
"in" : "query",
"description" : "Component module of display fields",
"required" : true,
"schema" : {
"type" : "string",
"example" : null,
"enum" : [ "COVERAGE_VIEW", "TREE_VIEW", "READING_VIEW", "TABULAR_VIEW" ]
}
} ],
"responses" : {
"404" : {
"description" : "Display field view does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Display field view doesn't exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisplayFieldViewDto"
},
"example" : {
"id" : 1,
"name" : "Default",
"description" : "Test Description",
"isPublic" : false,
"type" : "Coverage",
"fieldItems" : {
"other" : [ "key", "description" ],
"10000" : [ "key", "description", "priority" ],
"10001" : [ "key", "issuetype", "issuetype__icon" ]
}
}
}
}
},
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"put" : {
"tags" : [ "Display Field" ],
"summary" : "Update saved display field view",
"description" : "Update saved display field view in R4J - Requirements Management for JIRA plugin",
"operationId" : "updateDisplayFieldView",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisplayFieldViewDto"
},
"example" : {
"id" : 1,
"name" : "Default",
"description" : "Test Description",
"isPublic" : false,
"type" : "Coverage",
"fieldItems" : {
"other" : [ "key", "description" ],
"10000" : [ "key", "description", "priority" ],
"10001" : [ "key", "issuetype", "issuetype__icon" ]
}
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"404" : {
"description" : "View does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "View does not exist."
}
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisplayFieldViewDto"
},
"example" : {
"id" : 1,
"name" : "Default",
"description" : "Test Description",
"isPublic" : false,
"type" : "Coverage",
"fieldItems" : {
"other" : [ "key", "description" ],
"10000" : [ "key", "description", "priority" ],
"10001" : [ "key", "issuetype", "issuetype__icon" ]
}
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/coverage/projects/{projectId}/views/{viewId}/sort" : {
"put" : {
"tags" : [ "Coverage" ],
"summary" : "Sort coverage views by name",
"description" : "Sort coverage views by name in R4J - Requirements Management for JIRA plugin",
"operationId" : "sortCoverageViewChildOrder",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "Order of the views when sorting.",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"404" : {
"description" : "View does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "View does not exist."
}
}
}
},
"400" : {
"description" : "Invalid data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Sort order test is invalid."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/coverage/projects/{projectId}/views/{viewId}/move" : {
"put" : {
"tags" : [ "Coverage" ],
"summary" : "Move a saved view between Private and Public views",
"description" : "Move a saved view between Private and Public views in R4JC - Requirements Management for Jira Cloud",
"operationId" : "moveCoverageView",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "targetId",
"in" : "query",
"description" : "Target view ID on where to move the source view ID.",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "siblingId",
"in" : "query",
"description" : "View ID on where should the source ID be placed before it.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Project / view does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project / view does not exist."
}
}
}
},
"409" : {
"description" : "Similar view already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Similar view already exists."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/coverage/projects/{projectId}/views/{viewId}" : {
"get" : {
"tags" : [ "Coverage" ],
"summary" : "Retrieve saved coverage view",
"description" : "Retrieve saved coverage view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getSavedCoverageView",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "FOLDER",
"columns" : [ {
"id" : 10001,
"label" : "LABEL1",
"columnBasis" : 10002,
"source" : "PRIVATE",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ],
"issueTypes" : [ {
"id" : 10005,
"value" : "sample value2"
} ],
"linkTypes" : [ {
"id" : 10006,
"value" : "sample value3"
} ],
"filterId" : 10003,
"jql" : "Sample JQL"
} ],
"parentId" : 10001,
"fields" : [ "summary", "description", "..." ]
}
}
}
},
"404" : {
"description" : "View does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "View does not exist."
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"put" : {
"tags" : [ "Coverage" ],
"summary" : "Update saved coverage view",
"description" : "Update saved coverage view in R4J - Requirements Management for JIRA plugin",
"operationId" : "updateCoverageFilter",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "FOLDER",
"columns" : [ {
"id" : 10001,
"label" : "LABEL1",
"columnBasis" : 10002,
"source" : "PRIVATE",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ],
"issueTypes" : [ {
"id" : 10005,
"value" : "sample value2"
} ],
"linkTypes" : [ {
"id" : 10006,
"value" : "sample value3"
} ],
"filterId" : 10003,
"jql" : "Sample JQL"
} ],
"parentId" : 10001,
"fields" : [ "summary", "description", "..." ]
}
}
},
"required" : true
},
"responses" : {
"409" : {
"description" : "Similar view already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Similar View already exists."
}
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"404" : {
"description" : "View does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "View does not exist."
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "FOLDER",
"columns" : [ {
"id" : 10001,
"label" : "LABEL1",
"columnBasis" : 10002,
"source" : "PRIVATE",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ],
"issueTypes" : [ {
"id" : 10005,
"value" : "sample value2"
} ],
"linkTypes" : [ {
"id" : 10006,
"value" : "sample value3"
} ],
"filterId" : 10003,
"jql" : "Sample JQL"
} ],
"parentId" : 10001
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"delete" : {
"tags" : [ "Coverage" ],
"summary" : "Delete saved coverage view",
"description" : "Delete saved coverage view in R4J - Requirements Management for JIRA plugin",
"operationId" : "deleteCoverageFilter",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not activated."
}
},
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
}
},
"example" : null
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"400" : {
"description" : "Invalid user account.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "User Account ID is empty."
}
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/tree/projects/{projectKey}/items" : {
"put" : {
"tags" : [ "Tree" ],
"summary" : "Move existing item(s) in the tree.",
"description" : "Move existing tree item(s) and all its children from one parent location to another location in the tree.",
"operationId" : "moveItems",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Jira Project Key",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "TEST"
} ],
"requestBody" : {
"description" : "Important for request body parameters:\n\n\n- The Object.id, Object.jiraIssueId, or Object.jiraIssueKey is the target location and where the requested Object.items[n] will be moved to. \n\n\n- The Object.items[n].jiraIssueId or Object.items[n].jiraIssueKey are the items that will be moved.\n\n\n- Only one of the identifiers (id, jiraIssueId, or jiraIssueKey) must be provided per Object.\n\n\n- \\\"id\\\" is not supported in the Object.items array. It will be ignored when provided.\n\n\n- If an invalid \\\"position\\\" is provided, the item will be moved to the last position in the target location.\n\n\n- A maximum of 100 Object.items may be processed per request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTreeItemRequestDto"
},
"examples" : {
"Move items to the root folder" : {
"description" : "-1 is the root folder identifier.",
"value" : {
"id" : -1,
"jiraIssueId" : null,
"jiraIssueKey" : null,
"items" : [ {
"jiraIssueId" : 12195,
"jiraIssueKey" : null,
"position" : 1
}, {
"jiraIssueId" : null,
"jiraIssueKey" : "TEST-100",
"position" : 2
} ]
}
},
"Move items to the another location" : {
"description" : "Move items to the another location",
"value" : {
"id" : null,
"jiraIssueId" : null,
"jiraIssueKey" : "TEST-99",
"items" : [ {
"jiraIssueId" : 12195,
"jiraIssueKey" : null,
"position" : 1
}, {
"jiraIssueId" : null,
"jiraIssueKey" : "TEST-100",
"position" : 2
} ]
}
}
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Successfully moved item(s) recursively from the previous location the the target location in tree. Only the moved items are included in the response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTreeItemResponseDto"
},
"example" : {
"values" : [ {
"id" : 826,
"isFolder" : false,
"jiraIssueId" : 12195,
"position" : 3,
"hasChildren" : false,
"path" : [ 104, 826 ]
} ]
}
}
}
},
"404" : {
"description" : "Project or issue does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Project not found" : {
"description" : "Project not found",
"value" : {
"error" : "Could not find project with key TEST."
}
},
"Issue not found" : {
"description" : "Issue not found",
"value" : {
"error" : "An issue with key 'TEST-1' does not exist for field 'key'."
}
}
},
"example" : null
}
}
},
"403" : {
"description" : "User has no permission to view project or project is not active in R4J.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
},
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not active."
}
}
},
"example" : null
}
}
},
"400" : {
"description" : "Request validation error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Multiple identifiers provided" : {
"description" : "Only one of these parameters must be provided for this object to pass.",
"value" : {
"error" : "You should specify either Id, Jira Issue Id, or Jira Issue Key only."
}
},
"No identifiers provided" : {
"description" : "No identifiers provided",
"value" : {
"error" : "Id, Jira Issue Id, or Jira Issue Key must not be blank."
}
},
"Cannot move root folder" : {
"description" : "Cannot move root folder",
"value" : {
"error" : "Root folder cannot be moved."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"post" : {
"tags" : [ "Tree" ],
"summary" : "Add existing Jira issue(s) to the tree.",
"description" : "Add existing Jira issue(s) to a specific location in the tree.",
"operationId" : "addExistingIssuesToTree",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Jira Project Key",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "TEST"
} ],
"requestBody" : {
"description" : "Important for request body parameters:\n- The Object.id, Object.jiraIssueId, or Object.jiraIssueKey is the target location and where the requested Object.items[n] will be added to. \n\n\n- The Object.items[n].jiraIssueId or Object.items[n].jiraIssueKey are the items that will be added.\n\n\n- Only one of the identifiers (id, jiraIssueId, or jiraIssueKey) must be provided per Object.\n\n\n- \"id\" is not supported in the Object.items array. It will be ignored when provided.\n\n\n- If an invalid \"position\" is provided, the item will be moved to the last position in the target location.\n\n\n- A maximum of 100 Object.items may be processed per request.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTreeItemRequestDto"
},
"examples" : {
"Add issues to the root folder" : {
"description" : "-1 is the root folder identifier.",
"value" : {
"id" : -1,
"jiraIssueId" : null,
"jiraIssueKey" : null,
"items" : [ {
"jiraIssueId" : 12195,
"jiraIssueKey" : null,
"position" : 1
}, {
"jiraIssueId" : 12195,
"jiraIssueKey" : "TEST-100",
"position" : 1
} ]
}
},
"Add issues to the another location" : {
"description" : "Add issues to the another location",
"value" : {
"id" : null,
"jiraIssueId" : null,
"jiraIssueKey" : "TEST-99",
"items" : [ {
"jiraIssueId" : 12195,
"jiraIssueKey" : null,
"position" : 1
}, {
"jiraIssueId" : 12195,
"jiraIssueKey" : "TEST-100",
"position" : 1
} ]
}
}
},
"example" : null
}
},
"required" : true
},
"responses" : {
"404" : {
"description" : "Project or issue does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Project not found" : {
"description" : "Project not found",
"value" : {
"error" : "Could not find project with key TEST."
}
},
"Issue not found" : {
"description" : "Issue not found",
"value" : {
"error" : "An issue with key 'TEST-1' does not exist for field 'key'."
}
}
},
"example" : null
}
}
},
"403" : {
"description" : "User has no permission to view project or project is not active in R4J.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
},
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not active."
}
}
},
"example" : null
}
}
},
"400" : {
"description" : "Request validation error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Multiple identifiers provided" : {
"description" : "Only one of these parameters must be provided for this object to pass.",
"value" : {
"error" : "You should specify either Id, Jira Issue Id, or Jira Issue Key only."
}
},
"No identifiers provided" : {
"description" : "No identifiers provided",
"value" : {
"error" : "Id, Jira Issue Id, or Jira Issue Key must not be blank."
}
},
"Issue(s) already exist in tree" : {
"description" : "Issue(s) already exist in tree",
"value" : {
"error" : "Some issues are already in tree."
}
}
},
"example" : null
}
}
},
"200" : {
"description" : "Successfully added Jira issue(s) as tree items in the target location specified. Only the added issues are included in the response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTreeItemResponseDto"
},
"example" : {
"values" : [ {
"id" : 826,
"isFolder" : false,
"jiraIssueId" : 12195,
"position" : 1,
"hasChildren" : false,
"path" : [ 104, 826 ]
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"delete" : {
"tags" : [ "Tree" ],
"summary" : "Remove existing item(s) from tree.",
"description" : "Remove existing item(s) and all its children from any location in the tree.",
"operationId" : "removeItems",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Jira project key",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "TEST"
}, {
"name" : "idOrJiraIssueKey",
"in" : "query",
"description" : "List of tree item id or Jira issue key",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "TEST-100"
} ],
"responses" : {
"404" : {
"description" : "Project or issue does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Project not found" : {
"description" : "Project not found",
"value" : {
"error" : "Could not find project with key TEST."
}
},
"Issue not found" : {
"description" : "Issue not found",
"value" : {
"error" : "An issue with key 'TEST-1' does not exist for field 'key'."
}
}
},
"example" : null
}
}
},
"200" : {
"description" : "Successfully removed item(s) and their children from the tree. Only the total number of items removed out of the requested ones will be counted in the response.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RemovedItemsDto"
},
"example" : {
"totalItemsRemoved" : 10
}
}
}
},
"403" : {
"description" : "User has no permission to view project or project is not active in R4J.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
},
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not active."
}
}
},
"example" : null
}
}
},
"400" : {
"description" : "Request validation error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Max items exceeded" : {
"description" : "Max items exceeded",
"value" : {
"error" : "Only a maximum of 100 items can be removed per request."
}
},
"Cannot remove root folder" : {
"description" : "Cannot remove root folder",
"value" : {
"error" : "Root folder can not be removed."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/traceability/projects/{projectId}/views" : {
"post" : {
"tags" : [ "Traceability" ],
"summary" : "Save new traceability view",
"description" : "Saves new traceability view in R4J - Requirements Management for JIRA plugin",
"operationId" : "saveTraceabilityView",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "TRACEABILITY_FOLDER",
"scope" : false,
"linkTypes" : [ {
"value" : "10000-IN"
} ],
"columns" : [ {
"id" : 10001,
"label" : "Row Definition",
"columnBasis" : 10002,
"source" : "ISSUE_TYPES",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ]
} ],
"parentId" : 10001
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"201" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "TRACEABILITY_FOLDER",
"scope" : false,
"linkTypes" : [ {
"value" : "10000-IN"
} ],
"columns" : [ {
"id" : 10001,
"label" : "Row Definition",
"columnBasis" : 10002,
"source" : "ISSUE_TYPES",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ]
} ],
"parentId" : 10001
}
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"409" : {
"description" : "Similar view already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Similar view already exists."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/reqif-import" : {
"post" : {
"tags" : [ "ReqIF" ],
"summary" : "Imports or validates a ReqIF file",
"description" : "Imports or validates a ReqIF file in R4JC - Requirements Management for Jira Cloud",
"operationId" : "importOrValidateReqIf",
"parameters" : [ {
"name" : "isValidate",
"in" : "query",
"description" : "Flag if validation only",
"required" : false,
"schema" : {
"type" : "boolean",
"example" : null
},
"example" : "r4jc"
}, {
"name" : "issueTypeId",
"in" : "query",
"description" : "Issue type ID for folder creation",
"required" : false,
"schema" : {
"type" : "string",
"example" : null
},
"example" : 10006
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ReqIFFileProject"
}
},
"example" : [ {
"fileId" : "123-456-789",
"projectKey" : "TEST"
} ]
}
},
"required" : true
},
"responses" : {
"404" : {
"description" : "File does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "File with ID 123 doesn't exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"id" : 1
}
}
}
},
"400" : {
"description" : "File is invalid or does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"File list empty" : {
"description" : "File list empty",
"value" : {
"error" : "File list is empty."
}
},
"File ID empty" : {
"description" : "File ID empty",
"value" : {
"error" : "File ID is empty."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/items/statistics" : {
"post" : {
"tags" : [ "Tree" ],
"summary" : "Get existing issues statistics",
"description" : "Get existing issues statistics in R4JC - Requirements Management for Jira Cloud",
"operationId" : "getExistingIssueStatistics",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueRequestDto"
},
"example" : {
"type" : "Sample type",
"isLink" : false,
"linkTypeId" : "10007",
"isLinkOutward" : false,
"targetItemId" : 10006,
"jql" : "Sample jql",
"filter" : 10005,
"isChildRequirement" : false,
"issueIdList" : [ 10001, 10002, 10003 ]
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExistingIssueStatisticsDto"
},
"example" : [ {
"selectedIssuesCount" : 1,
"newIssuesCount" : 5,
"issuesInTreeCount" : 12
} ]
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/items/create-link" : {
"post" : {
"tags" : [ "Tree" ],
"summary" : "Add issue(s) and create issue links for each issue to target issue",
"description" : "Add issue(s) and create issue links for each issue to target issue R4JC - Requirements Management for Jira Cloud",
"operationId" : "createIssueLink",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project Id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueRequestDto"
},
"example" : {
"type" : "Sample type",
"isLink" : false,
"linkTypeId" : "10007",
"isLinkOutward" : false,
"targetItemId" : 10006,
"jql" : "Sample jql",
"filter" : 10005,
"isChildRequirement" : false,
"issueIdList" : [ 10001, 10002, 10003 ]
}
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "Issues are already added or still in progress",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"202" : {
"description" : "Background task already in progress.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/IssueRequestDto"
},
"example" : {
"type" : "Sample type",
"isLink" : false,
"linkTypeId" : "10007",
"isLinkOutward" : false,
"targetItemId" : 10006,
"jql" : "Sample jql",
"filter" : 10005,
"isChildRequirement" : false,
"issueIdList" : [ 10001, 10002, 10003 ]
}
}
}
},
"404" : {
"description" : "Project / issue does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project / issue does not exist" : {
"description" : "Project / issue does not exist",
"value" : {
"error" : "Project / issue does not exist."
}
},
"Issue does not exist or you do not have permission to see it" : {
"description" : "Issue does not exist or you do not have permission to see it",
"value" : {
"error" : "Issue does not exist or you do not have permission to see it."
}
}
},
"example" : null
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"id" : 4040,
"contextData" : {
"type" : "Sample type",
"isLink" : false,
"linkTypeId" : "10007",
"isLinkOutward" : false,
"targetItemId" : 10006,
"jql" : "Sample jql",
"filter" : 10005,
"isChildRequirement" : false,
"issueIdList" : [ 10001, 10002, 10003 ]
}
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/items/copy" : {
"post" : {
"tags" : [ "Tree" ],
"summary" : "Reuse items in tree",
"description" : "Reuse items from source item to target item in tree in R4JC - Requirements Management for Jira Cloud",
"operationId" : "reuseItem",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project Id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReuseRequestDto"
},
"example" : {
"targetId" : -1,
"itemIdList" : [ 101, 102, 103 ],
"isCopy" : true,
"createAttachment" : true,
"linkIssue" : true,
"linkTypeId" : 1,
"isLinkOutward" : false,
"filter" : {
"type" : "TEXT",
"query" : "text",
"fields" : {
"project" : [ 1000, 10001 ]
}
}
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"400" : {
"description" : "Root folder cannot be copied.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Root folder cannot be copied."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"id" : 1
}
}
}
},
"404" : {
"description" : "Project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project does not exist."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/export" : {
"post" : {
"tags" : [ "Word Export" ],
"summary" : "Export issue details on Word format",
"description" : "Export issue details on Word format in R4JC - Requirements Management for Jira Cloud",
"operationId" : "wordExport",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/WordExportDto"
},
"example" : {
"templateId" : 123,
"itemOrIssueId" : 123,
"scope" : "TREE_VIEW",
"filter" : {
"type" : "TEXT",
"query" : "text",
"fields" : {
"project" : [ 1000, 10001 ]
}
}
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"taskId" : 1
}
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"403" : {
"description" : "User has no permission to view project or project is not active in R4J.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
},
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not activated."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/search" : {
"post" : {
"tags" : [ "Baseline" ],
"summary" : "Retrieve the list of baseline",
"description" : "Retrieve the list of baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "getBaselines",
"parameters" : [ {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
}, {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Filter the results using a literal string. Baseline name and description with a matching name are returned (case insensitive).",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineSearchDto"
},
"example" : {
"query" : "Baseline1"
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/BaselineDto"
}
},
"example" : [ {
"startAt" : 0,
"maxResults" : 20,
"total" : 25,
"values" : {
"id" : 10000,
"name" : "Sample Name",
"description" : "Sample Description",
"fixVersionIds" : [ 1245, 151, 251 ],
"componentIds" : [ 215, 1561, 141 ],
"createdBy" : "test-user",
"createdDate" : "2022-10-14T09:42:21.402+00:00"
}
} ]
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/items/search" : {
"post" : {
"tags" : [ "Baseline" ],
"summary" : "Retrieve all items of a baseline with changes compared to another baseline",
"description" : "Retrieve all items of a baseline with changes compared to another baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "searchBaselineTreeItemsWithChanges",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineTreeItemSearchRequestDto"
},
"example" : {
"fromBaselineId" : 1,
"toBaselineId" : 2
}
}
},
"required" : true
},
"responses" : {
"404" : {
"description" : "Baseline does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline doesn't exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineTreeItemListDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 1000,
"total" : 1,
"values" : [ {
"id" : 5617,
"projectId" : 10043,
"sourceProjectId" : 10043,
"issueId" : 13715,
"path" : "5616.5617",
"baselineId" : 41,
"issueKey" : "VAPL-532",
"deleted" : false,
"issueRevision" : 0,
"toIssueRevision" : 0
} ]
}
}
}
},
"400" : {
"description" : "Invalid request data.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Source and target baseline IDs must be either -1 or greater than 0" : {
"description" : "Source and target baseline IDs must be either -1 or greater than 0",
"value" : {
"error" : "Source and target baseline IDs must be either -1 or greater than 0."
}
},
"Source and target baseline IDs should not be the same" : {
"description" : "Source and target baseline IDs should not be the same",
"value" : {
"error" : "Source and target baseline IDs should not be the same."
}
}
},
"example" : null
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Project doesn't exist or you don't have permission to view it" : {
"description" : "Project doesn't exist or you don't have permission to view it",
"value" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines" : {
"post" : {
"tags" : [ "Baseline" ],
"summary" : "Save new baseline",
"description" : "Saves new baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "createBaseline",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineDto"
},
"example" : {
"name" : "Baseline",
"description" : "Description",
"filter" : {
"type" : "TEXT",
"query" : "text",
"fields" : {
"project" : [ 1000, 10001 ]
}
},
"fixVersionIds" : [ 1 ],
"componentIds" : [ 2 ]
}
}
},
"required" : true
},
"responses" : {
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline name must not be blank."
}
}
}
},
"201" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineDto"
},
"example" : {
"id" : 1,
"contextData" : {
"id" : 16,
"name" : "Baseline",
"description" : "Description",
"fixVersionIds" : [ 1 ],
"componentIds" : [ 2 ],
"createdBy" : "test-user",
"createdDate" : "2022-10-14T09:42:21.402+00:00"
}
}
}
}
},
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
}
},
"409" : {
"description" : "Similar view already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline name already exists."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects" : {
"get" : {
"tags" : [ "Project" ],
"summary" : "Retrieve the list of active projects",
"description" : "View a list of active projects in R4JC - Requirements Management for Jira Cloud",
"operationId" : "getAllProjects",
"parameters" : [ {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
}, {
"name" : "query",
"in" : "query",
"description" : "Filter the results using a literal string. Projects with a matching key or name are returned.",
"required" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "string",
"example" : null
},
"example" : {
"total" : 1,
"maxResults" : 20,
"values" : [ {
"id" : 10000,
"key" : "TRY",
"name" : "TRY",
"enabled" : true,
"icon" : "https://sample.atlassian.net/rest/api/3/type/project/avatar/123123?size=small"
} ],
"startAt" : 0
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"post" : {
"tags" : [ "Project" ],
"summary" : "Activate a list of projects",
"description" : "Save projects in R4J - Requirements Management for JIRA plugin",
"operationId" : "saveActivatedProject",
"parameters" : [ {
"name" : "async",
"in" : "query",
"description" : "Runs the project activation in an async operation.",
"required" : false,
"schema" : {
"type" : "boolean",
"example" : null,
"default" : false
}
} ],
"requestBody" : {
"description" : "List of projects to activate.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ActiveProjectDto"
}
},
"example" : [ {
"id" : 10000
} ]
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "Request has succeeded and a new resource has been created as a result.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ActiveProjectDto"
}
},
"example" : [ {
"id" : 10000,
"key" : "SP",
"name" : "Sample Project",
"enabled" : true,
"icon" : "https://easesolutions-dev.atlassian.net/secure/projectavatar?size=small&s=small&pid=10000&avatarId=10410"
} ]
}
}
},
"409" : {
"description" : "Project(s) is/are already activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project(s) is/are already activated."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/preferences" : {
"get" : {
"tags" : [ "UserPreference" ],
"summary" : "Get user preferences",
"description" : "Get user preferences globally or by project.",
"operationId" : "getPreferences",
"parameters" : [ {
"name" : "projectId",
"in" : "query",
"description" : "JIRA project ID.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not active. This is only applicable when project ID is specified.",
"content" : {
"application/json" : {
"example" : {
"error" : "Project not active."
}
}
}
},
"200" : {
"description" : "Successfully get user preferences.",
"content" : {
"application/json" : {
"example" : {
"readingViewDisplayFields" : [ "summary", "description" ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"post" : {
"tags" : [ "UserPreference" ],
"summary" : "Save user preferences",
"description" : "Save user preferences globally or by project.",
"operationId" : "savePreferences",
"parameters" : [ {
"name" : "projectId",
"in" : "query",
"description" : "JIRA project ID.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Map of user preferences.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"example" : null
},
"example" : null
},
"example" : {
"readingViewDisplayFields" : [ "summary", "description" ]
}
}
},
"required" : true
},
"responses" : {
"400" : {
"description" : "Request data is empty.",
"content" : {
"application/json" : {
"example" : {
"error" : "Request data must not be empty."
}
}
}
},
"200" : {
"description" : "Successfully saved user preferences."
},
"403" : {
"description" : "Project is not active. This is only applicable when project ID is specified.",
"content" : {
"application/json" : {
"example" : {
"error" : "Project not active."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/export-template" : {
"get" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Retrieve the list of Export Template",
"description" : "Retrieve the list of Export Template in R4J - Requirements Management for JIRA plugin",
"operationId" : "getExportTemplates",
"parameters" : [ {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
}, {
"name" : "query",
"in" : "query",
"description" : "Template name",
"required" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ExportTemplateDto"
}
},
"example" : [ {
"startAt" : 0,
"maxResults" : 10,
"total" : 100,
"values" : [ {
"id" : 123123,
"fileId" : "file135-21",
"templateName" : "Sample.xml",
"fileSize" : 1243,
"description" : "This is a sample xml",
"projects" : [ 10009, 10010 ],
"scopes" : [ "TREE_VIEW" ],
"enable" : true,
"createdBy" : "test",
"createdDate" : "Thu Apr 22 19:33:08 SGT 2021"
} ]
} ]
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
},
"post" : {
"tags" : [ "ExportTemplate" ],
"summary" : "Create a new Export template",
"description" : "Create a new Export template in R4J - Requirements Management for JIRA plugin",
"operationId" : "createExportTemplate",
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportTemplateDto"
},
"example" : {
"fileId" : "4d49460b-390a-49f9-92c7-48bd390ed984",
"templateName" : "Sample5.xml",
"description" : "This is a sample xml",
"projects" : [ 10032, 10030 ],
"scopes" : [ "TREE_VIEW" ]
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "No permission.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "You do not have permission to perform this action."
}
}
}
},
"201" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ExportTemplateDto"
},
"example" : {
"id" : 15,
"fileId" : "4d49460b-390a-49f9-92c7-48bd390ed984",
"description" : "This is a sample xml",
"scopes" : [ "TREE_VIEW" ],
"projects" : [ 10032, 10030 ],
"fileSize" : 366576,
"enable" : true,
"createdBy" : "5ffbb4758332a1010e17eb65",
"createdDate" : "2022-08-15T05:30:04.418+00:00",
"templateName" : "Sample.xml"
}
}
}
},
"400" : {
"description" : "Required parameter is empty.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Required parameter is empty."
}
}
}
},
"409" : {
"description" : "Template name already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Template name already exists."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/display-fields/projects/{projectId}/views" : {
"post" : {
"tags" : [ "Display Field" ],
"summary" : "Add display field view",
"description" : "Add display field view in R4J - Requirements Management for JIRA plugin",
"operationId" : "addDisplayFieldView",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisplayFieldViewDto"
},
"example" : {
"id" : 4,
"name" : "Current",
"description" : "Test Description",
"isPublic" : false,
"componentType" : "COVERAGE_VIEW",
"type" : "VIEW",
"fieldItems" : {
"other" : [ "key", "description" ],
"10000" : [ "key", "description", "priority" ],
"10001" : [ "key", "issuetype", "issuetype__icon" ]
}
}
}
},
"required" : true
},
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"409" : {
"description" : "Similar view already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Similar View already exists."
}
}
}
},
"404" : {
"description" : "Parent item does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Parent item in Project ID 10000 does not exist."
}
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"201" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisplayFieldViewDto"
},
"example" : {
"id" : 4,
"name" : "Default",
"description" : "Test Description",
"isPublic" : false,
"componentType" : "COVERAGE_VIEW",
"type" : "VIEW",
"fieldItems" : {
"other" : [ "key", "description" ],
"10000" : [ "key", "description", "priority" ],
"10001" : [ "key", "issuetype", "issuetype__icon" ]
}
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/coverage/projects/{projectId}/views" : {
"post" : {
"tags" : [ "Coverage" ],
"summary" : "Save new coverage view",
"description" : "Saves new coverage view in R4J - Requirements Management for JIRA plugin",
"operationId" : "saveCoverageView",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "FOLDER",
"columns" : [ {
"id" : 10001,
"label" : "LABEL1",
"columnBasis" : 10002,
"source" : "PRIVATE",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ],
"issueTypes" : [ {
"id" : 10005,
"value" : "sample value2"
} ],
"linkTypes" : [ {
"id" : 10006,
"value" : "sample value3"
} ],
"filterId" : 10003,
"jql" : "Sample JQL"
} ],
"parentId" : 10001,
"fields" : [ "summary", "description", "..." ]
}
}
},
"required" : true
},
"responses" : {
"409" : {
"description" : "Similar view already exists.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Similar view already exists."
}
}
}
},
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"201" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterDto"
},
"example" : {
"id" : 10000,
"name" : "Sample Project",
"isPublic" : true,
"type" : "FOLDER",
"columns" : [ {
"id" : 10001,
"label" : "LABEL1",
"columnBasis" : 10002,
"source" : "PRIVATE",
"projects" : [ {
"id" : 10004,
"value" : "sample value1"
} ],
"issueTypes" : [ {
"id" : 10005,
"value" : "sample value2"
} ],
"linkTypes" : [ {
"id" : 10006,
"value" : "sample value3"
} ],
"filterId" : 10003,
"jql" : "Sample JQL"
} ],
"parentId" : 10001
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/configurations/{configurationKey}" : {
"post" : {
"tags" : [ "Configuration" ],
"summary" : "Update/insert global configuration",
"description" : "Update/insert global configuration in R4JC - Requirements Management for Jira Cloud",
"operationId" : "upsertConfiguration",
"parameters" : [ {
"name" : "configurationKey",
"in" : "path",
"description" : "Configuration key",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"requestBody" : {
"description" : "Request data",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpsertConfigurationRequestDto"
},
"example" : {
"value" : 10001
}
}
},
"required" : true
},
"responses" : {
"400" : {
"description" : "Invalid user input.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Invalid user input."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"example" : {
"folderIssueType" : 10000
}
}
}
},
"403" : {
"description" : "User is not an admin.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "User is not an admin."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/tree/search" : {
"post" : {
"tags" : [ "Tree" ],
"summary" : "Search for existing item(s) in any tree via JQL",
"description" : "Search for existing item(s) in any tree based on a valid JQL query provided.",
"operationId" : "searchItems",
"parameters" : [ {
"name" : "startAt",
"in" : "query",
"description" : "Start offset of the resulting items",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of resulting items (Maximum of 100)",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 50
},
"example" : 50
} ],
"requestBody" : {
"description" : "Important for request body parameters:\n- The Object.treeProjectId and Object.treeProjectKey is the activated R4J project tree you want to search issues from.\n\n\n- If none of the tree project identifiers are provided, all activated R4J project trees will be searched.\n\n\n- If specifying the activated R4J poject tree you want to search, only one of the identifiers (treeProjectId or treeProjectKey) must be provided per Object.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SearchRequestDto"
},
"example" : {
"treeProjectId" : 10000,
"treeProjectKey" : "TEST",
"jql" : "project = TEST"
}
}
},
"required" : true
},
"responses" : {
"404" : {
"description" : "Project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Project not found" : {
"description" : "Project not found",
"value" : {
"error" : "Could not find project with key TEST."
}
}
},
"example" : null
}
}
},
"200" : {
"description" : "Successfully searched item(s) based on JQL query provided.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedSearchItemResponseDto"
},
"examples" : {
"Issue located in one tree" : {
"description" : "Issue located in one tree",
"value" : {
"startAt" : 0,
"maxResults" : 50,
"isLast" : true,
"values" : [ {
"jiraIssueId" : 10000,
"items" : [ {
"id" : 2,
"path" : [ 1, 2 ],
"treeProjectId" : 10000,
"isFolder" : true,
"position" : 1,
"hasChildren" : true
} ]
} ]
}
},
"Issue located in multiple trees" : {
"description" : "Issue located in multiple trees",
"value" : {
"startAt" : 0,
"maxResults" : 50,
"isLast" : true,
"values" : [ {
"jiraIssueId" : 10000,
"items" : [ {
"id" : 22,
"path" : [ 13, 22 ],
"treeProjectId" : 10000,
"isFolder" : false,
"position" : 5,
"hasChildren" : true
}, {
"id" : 86,
"path" : [ 82, 28, 62, 86 ],
"treeProjectId" : 10025,
"isFolder" : false,
"position" : 15,
"hasChildren" : true
} ]
} ]
}
}
},
"example" : null
}
}
},
"403" : {
"description" : "User has no permission to view project or project is not active in R4J.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
},
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not active."
}
}
},
"example" : null
}
}
},
"400" : {
"description" : "Request validation error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"Multiple identifiers provided" : {
"description" : "Multiple identifiers provided",
"value" : {
"error" : "You should specify either tree project id or key only."
}
},
"No identifiers provided" : {
"description" : "No identifiers provided",
"value" : {
"error" : "Tree project id or key must not be empty."
}
},
"JQL is empty" : {
"description" : "JQL is empty",
"value" : {
"error" : "JQL must not be empty."
}
},
"Invalid JQL" : {
"description" : "Invalid JQL",
"value" : {
"error" : "Invalid JQL provided."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/version" : {
"get" : {
"tags" : [ "Version" ],
"summary" : "Retrieve application version",
"description" : "Retrieve Application version in R4J - Requirements Management for JIRA plugin",
"operationId" : "getVersionDetails_1",
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VersionDto"
},
"example" : {
"version" : "1.0",
"buildNumber" : "5"
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/traceability/projects/{projectId}/views/{viewId}/move/check" : {
"get" : {
"tags" : [ "Traceability" ],
"summary" : "Check if allow to move saved view from Public to Private view",
"description" : "Check if allow to move saved view from Public to Private view in R4JC - Requirements Management for Jira Cloud",
"operationId" : "checkMoveTraceabilityViewToPrivate",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "Id of view that will be moved",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "targetId",
"in" : "query",
"description" : "Id of target filter which can either be public or private",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"404" : {
"description" : "Project / view does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project / view does not exist."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/traceability/projects/{projectId}/views/{viewId}/children" : {
"get" : {
"tags" : [ "Traceability" ],
"summary" : "Retrieve list of saved traceability views",
"description" : "Retrieve list of saved traceability views in R4J - Requirements Management for JIRA plugin",
"operationId" : "getTraceabilityViews",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"404" : {
"description" : "View does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "View does not exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterListDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 20,
"total" : 25,
"values" : [ {
"id" : 10001,
"name" : "Sample Name",
"isPublic" : false,
"type" : "FOLDER"
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/tasks" : {
"get" : {
"tags" : [ "BackgroundTask" ],
"summary" : "Check the status for the specified task type",
"description" : "Checks the background task for the specified task type in the application",
"operationId" : "checkBackgroundStatus",
"parameters" : [ {
"name" : "contextId",
"in" : "query",
"description" : "Id of the context, for project specific, projectId.",
"required" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "taskName",
"in" : "query",
"description" : "Background task Name",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"taskName" : "Sample task",
"data" : "Sample data",
"status" : "IN_PROGRESS",
"createdDate" : "12/12/12"
}
}
}
},
"204" : {
"description" : "No task currently running.",
"content" : {
"*/*" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"400" : {
"description" : "Invalid task name.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Task name must not be empty" : {
"description" : "Task name must not be empty",
"value" : {
"error" : "Task name must not be empty."
}
},
"Task name TEST is invalid" : {
"description" : "Task name TEST is invalid",
"value" : {
"error" : "Task name TEST is invalid."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/screens/{screenId}/tabs/{tabId}/fields" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Retrieve all screen tab fields",
"description" : "Retrieve all screen tab fields for detail view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getScreenFields",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "screenId",
"in" : "path",
"description" : "Screen ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "tabId",
"in" : "path",
"description" : "Screen Tab ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScreenTabField"
},
"example" : [ {
"id" : "field id name",
"name" : "Field Id Name"
} ]
}
}
},
"400" : {
"description" : "Screen or screen tab does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Screen with id 10000 does not exist."
}
}
}
},
"404" : {
"description" : "Project is not found.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Could not find project with id 10000."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/issuetypescreenschemes" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Get issue type screen scheme",
"description" : "Get issue type screen scheme for detail view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getFieldsInIssueTypeScreenScheme",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "issueTypeId",
"in" : "query",
"description" : "Jira issue type ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "allTabs",
"in" : "query",
"description" : "Indicator to retrieve one or all screen tabs and fields",
"required" : false,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScreenTabFieldSearch"
},
"example" : {
"values" : [ {
"id" : 1,
"name" : "Sample name"
} ]
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Project doesn't exist or you don't have permission to view it" : {
"description" : "Project doesn't exist or you don't have permission to view it",
"value" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
},
"example" : null
}
}
},
"404" : {
"description" : "Project is not found.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Could not find project with id 10000."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/issuetypes/{issueTypeId}/screen/tabs" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Get list of screen tabs",
"description" : "Get list of screen tabs in R4J - Requirements Management for JIRA plugin",
"operationId" : "getScreenTabs",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project Id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "issueTypeId",
"in" : "path",
"description" : "Jira Issue Type ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScreenTabSearch"
},
"example" : {
"screenId" : 10003,
"values" : [ {
"id" : 1,
"name" : "Sample name"
} ]
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Project doesn't exist or you don't have permission to view it" : {
"description" : "Project doesn't exist or you don't have permission to view it",
"value" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
},
"example" : null
}
}
},
"404" : {
"description" : "Project is not found.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Could not find project with id 10000."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/issues/{issueId}/projects" : {
"get" : {
"tags" : [ "Tree" ],
"summary" : "Retrieve projects that contains issue selected",
"description" : "Retrieve projects that contains issue selected in R4J - Requirements Management for JIRA plugin",
"operationId" : "getProjectsByIssue",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "issueId",
"in" : "path",
"description" : "Issue ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TreeItemListDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 20,
"total" : 25,
"values" : [ {
"id" : 10000,
"key" : "VAPL",
"name" : "VAPL"
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/fieldconfigurationschemes" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Get field configuration IDs",
"description" : "Get list of field configuration IDs for detail view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getFieldConfigurationIds",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "issueTypeId",
"in" : "query",
"description" : "Jira issue type ID",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"example" : [ 10000, 10001 ]
}
}
},
"404" : {
"description" : "Field config associated in project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Field config associated in project does not exist."
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Project doesn't exist or you don't have permission to view it" : {
"description" : "Project doesn't exist or you don't have permission to view it",
"value" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/fieldconfigurations/{fieldConfigurationId}/fields" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Get field configuration fields",
"description" : "Get field configuration fields for detail view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getFieldConfigurationFields",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "JIRA project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "fieldConfigurationId",
"in" : "path",
"description" : "Field configuration ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null,
"default" : 50
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/FieldConfigurationSearch"
},
"example" : {
"startAt" : 0,
"maxResults" : 50,
"total" : 1,
"isLast" : true,
"values" : [ {
"id" : 1,
"isHidden" : true,
"isRequired" : true
} ]
}
}
}
},
"404" : {
"description" : "Field config does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Field config does not exist."
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Project doesn't exist or you don't have permission to view it" : {
"description" : "Project doesn't exist or you don't have permission to view it",
"value" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/{baselineId}/items/{itemId}/path" : {
"get" : {
"tags" : [ "Baseline" ],
"summary" : "Get baseline tree item path",
"description" : "Get baseline tree item path for baseline tree comparison view in R4J - Requirements Management for JIRA plugin",
"operationId" : "getBaselineItemPath",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "Baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "itemId",
"in" : "path",
"description" : "Item ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Item/issue does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Baseline item not found."
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Project doesn't exist or you don't have permission to view it" : {
"description" : "Project doesn't exist or you don't have permission to view it",
"value" : {
"error" : "Project doesn't exist or you don't have permission to view it."
}
}
},
"example" : null
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DetailPathDto"
},
"example" : {
"itemIdPath" : [ -1, 2 ],
"issueIdList" : [ -1, 100004 ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/{baselineId}/items/{itemId}/children" : {
"get" : {
"tags" : [ "Baseline" ],
"summary" : "Retrieve all children of a specific parent tree item in a baseline",
"description" : "Retrieve all children of a specific parent tree item in a baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "getBaselineTreeItems",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "itemId",
"in" : "path",
"description" : "Parent Item ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"404" : {
"description" : "Item does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Item does not exist."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineIssueListDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 20,
"total" : 6,
"values" : [ {
"id" : 5617,
"projectId" : 10043,
"sourceProjectId" : 10043,
"issueId" : 13715,
"path" : "5616.5617",
"hasChild" : true,
"baselineId" : 41,
"issueKey" : "VAPL-532",
"deleted" : false,
"issueRevision" : 0
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/{baselineId}/issues/{issueId}" : {
"get" : {
"tags" : [ "Baseline" ],
"summary" : "Retrieve issue detail from current baseline",
"description" : "Retrieve issue detail from current baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "getBaselineIssue",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "issueId",
"in" : "path",
"description" : "Jira Issue ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Baseline does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Baseline does not exist" : {
"description" : "Baseline does not exist",
"value" : {
"error" : "Baseline does not exist."
}
},
"Baseline issue does not exist" : {
"description" : "Baseline issue does not exist",
"value" : {
"error" : "Baseline issue does not exist."
}
}
},
"example" : null
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineIssueListDto"
},
"example" : {
"id" : "14147",
"key" : "TEST-100",
"issueRevision" : 0,
"deleted" : false,
"fields" : {
"summary" : "Timmy"
},
"schema" : {
"statuscategorychangedate" : {
"type" : "datetime",
"system" : "statuscategorychangedate"
}
},
"changelog" : {
"startAt" : 0,
"maxResults" : 0,
"total" : 0,
"histories" : [ ]
},
"names" : {
"statuscategorychangedate" : "Status Category Changed"
}
}
}
}
},
"403" : {
"description" : "Forbidden.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"examples" : {
"Project is not activated" : {
"description" : "Project is not activated",
"value" : {
"error" : "Project is not activated."
}
},
"Issue does not exist or you do not have permission to see it." : {
"description" : "Issue does not exist or you do not have permission to see it.",
"value" : {
"error" : "Issue does not exist or you do not have permission to see it."
}
}
},
"example" : null
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/{baselineId}/issues" : {
"get" : {
"tags" : [ "Baseline" ],
"summary" : "Retrieve all issues for current baseline",
"description" : "Retrieve all issues for current baseline in R4J - Requirements Management for JIRA plugin",
"operationId" : "getBaselineIssues",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "baselineId",
"in" : "path",
"description" : "baseline ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "toBaselineId",
"in" : "query",
"description" : "Baseline ID to get issue revision in another baseline",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BaselineIssueListDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 20,
"total" : 25,
"values" : [ {
"id" : 11979,
"issueId" : 11979,
"issueRevision" : 17529,
"deleted" : false,
"key" : "TC9-751"
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}/baselines/issues/{issueId}/revisions" : {
"get" : {
"tags" : [ "Baseline" ],
"summary" : "Get all revision baseline count of an issue",
"description" : "Get all revision baseline count of an specific issue in R4J - Requirements Management for JIRA plugin",
"operationId" : "getAllRevisionBaselineCount",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "issueId",
"in" : "path",
"description" : "Jira issue ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"404" : {
"description" : "Project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Could not find project with id 10000."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RevisionBaselineCountResponseDto"
},
"example" : [ {
"issueRevision" : 20,
"count" : 6
} ]
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/jira" : {
"get" : {
"tags" : [ "Project" ],
"summary" : "Retrieve the list of jira projects",
"description" : "View a list of all jira projects in R4JC - Requirements Management for Jira Cloud",
"operationId" : "getAllJiraProjects",
"parameters" : [ {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "string",
"example" : null
},
"example" : {
"total" : 1,
"maxResults" : 20,
"values" : [ {
"id" : 10000,
"key" : "TRY",
"name" : "TRY",
"enabled" : true,
"isActive" : true,
"icon" : "https://sample.atlassian.net/rest/api/3/type/project/avatar/123123?size=small"
} ],
"startAt" : 0
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/pickers/projects/recent" : {
"get" : {
"tags" : [ "Picker" ],
"summary" : "Get recent activated projects",
"description" : "Get recent activated projects.",
"operationId" : "getRecentActivatedProjects",
"parameters" : [ {
"name" : "excludeId",
"in" : "query",
"description" : "JIRA project ID to exclude from the result.",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Successfully return recent activated projects.",
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Project"
}
},
"example" : [ {
"self" : 10000,
"id" : 10000,
"key" : "SP",
"name" : "Sample Project",
"projectTypeKey" : true,
"simplified" : true,
"avatarUrls" : { }
} ]
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/pickers/projects/non-activated" : {
"get" : {
"tags" : [ "Picker" ],
"summary" : "Get non-activated projects",
"description" : "Get non-activated projects.",
"operationId" : "getNonActivatedProject",
"parameters" : [ {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
}, {
"name" : "query",
"in" : "query",
"description" : "Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).",
"required" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "Successfully return non-activated projects.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProjectSearch"
},
"example" : {
"maxResults" : 25,
"startAt" : 0,
"total" : 30,
"isLast" : true,
"values" : [ {
"self" : 10000,
"id" : 10000,
"key" : "SP",
"name" : "Sample Project",
"projectTypeKey" : true,
"simplified" : true,
"avatarUrls" : {
"48x48" : "https://test.atlassian.net/rest/api/3/universal_avatar/view/type/project/avatar/10404",
"32x32" : "https://test.atlassian.net/rest/api/3/universal_avatar/view/type/project/avatar/10404?size=medium",
"24x24" : "https://test.atlassian.net/rest/api/3/universal_avatar/view/type/project/avatar/10404?size=small",
"16x16" : "https://test.atlassian.net/rest/api/3/universal_avatar/view/type/project/avatar/10404?size=xsmall"
}
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/pickers/projects/field/{fieldId}/context/{contextId}/option" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Retrieve custom field option for a context",
"description" : "Retrieve custom field option for a context in R4J - Requirements Management for JIRA plugin",
"operationId" : "getCustomFieldOptions",
"parameters" : [ {
"name" : "fieldId",
"in" : "path",
"description" : "ID of the custom field",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "contextId",
"in" : "path",
"description" : "ID of the context",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset)",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null,
"default" : 100
}
} ],
"responses" : {
"404" : {
"description" : "Custom field does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "The custom field was not found."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomFieldContextOptionResponseDto"
},
"example" : {
"maxResults" : 100,
"startAt" : 0,
"total" : 4,
"isLast" : true,
"values" : [ {
"id" : "10001",
"value" : "New York"
}, {
"id" : "10002",
"value" : "Boston",
"disabled" : true
}, {
"id" : "10004",
"value" : "Denver"
}, {
"id" : "10003",
"value" : "Brooklyn",
"optionId" : "10001"
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/pickers/projects/field/{fieldId}/context/projectmapping" : {
"get" : {
"tags" : [ "Detail" ],
"summary" : "Retrieve project mappings for custom field context",
"description" : "Retrieve project mappings for custom field context in R4J - Requirements Management for JIRA plugin",
"operationId" : "getProjectMappingForCustomFieldContext",
"parameters" : [ {
"name" : "fieldId",
"in" : "path",
"description" : "ID of the custom field",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset)",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null,
"default" : 50
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomFieldContextProjectMappingResponseDto"
},
"example" : {
"maxResults" : 100,
"startAt" : 0,
"total" : 2,
"isLast" : true,
"values" : [ {
"contextId" : "10025",
"projectId" : "10001"
}, {
"contextId" : "10026",
"isGlobalContext" : true
} ]
}
}
}
},
"404" : {
"description" : "Custom field does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "The custom field was not found."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/permissions/projects/{projectId}/activated" : {
"get" : {
"tags" : [ "Permission" ],
"summary" : "Check if project is activated",
"description" : "Check if project is activated in R4J - Requirements Management for JIRA plugin",
"operationId" : "checkActivatedProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Project does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project not found!"
}
}
}
},
"400" : {
"description" : "Project ID is empty.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project ID is empty."
}
}
}
},
"403" : {
"description" : "No project permission or project not active.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : null
}
}
},
"204" : {
"description" : "Project is activated."
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/display-fields/projects/{projectId}/views/{viewId}/children" : {
"get" : {
"tags" : [ "Display Field" ],
"summary" : "Retrieve list of saved display field views",
"description" : "Retrieve list of saved display field views in R4J - Requirements Management for JIRA plugin",
"operationId" : "getDisplayFieldViews",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : false,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
}, {
"name" : "componentType",
"in" : "query",
"description" : "Component module of display fields",
"required" : true,
"schema" : {
"type" : "string",
"example" : null,
"enum" : [ "COVERAGE_VIEW", "TREE_VIEW", "READING_VIEW", "TABULAR_VIEW" ]
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "Display field view id",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 20,
"total" : 25,
"values" : [ {
"id" : 10001,
"name" : "Sample Name",
"isPublic" : false,
"type" : "FOLDER",
"description" : "Sample Description"
} ]
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/coverage/projects/{projectId}/views/{viewId}/move/check" : {
"get" : {
"tags" : [ "Coverage" ],
"summary" : "Check if allow to move saved view from Public to Private view",
"description" : "Check if allow to move saved view from Public to Private view in R4JC - Requirements Management for Jira Cloud",
"operationId" : "checkMoveCoverageViewToPrivate",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira Project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "Id of view that will be moved",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "targetId",
"in" : "query",
"description" : "Id of target filter which can either be public or private",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Project / view does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project / view does not exist."
}
}
}
},
"204" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"example" : null
},
"example" : null
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/coverage/projects/{projectId}/views/{viewId}/children" : {
"get" : {
"tags" : [ "Coverage" ],
"summary" : "Retrieve list of saved coverage views",
"description" : "Retrieve list of saved coverage views in R4J - Requirements Management for JIRA plugin",
"operationId" : "getCoverageViews",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "viewId",
"in" : "path",
"description" : "View ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}, {
"name" : "startAt",
"in" : "query",
"description" : "The index of the first item to return in a page of results (page offset).",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
}
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of results/items to return per page",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 20
}
} ],
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CoverageFilterListDto"
},
"example" : {
"startAt" : 0,
"maxResults" : 20,
"total" : 25,
"values" : [ {
"id" : 10001,
"name" : "Sample Name",
"isPublic" : false,
"type" : "FOLDER"
} ]
}
}
}
},
"403" : {
"description" : "Project is not activated.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Project is not activated."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/configurations" : {
"get" : {
"tags" : [ "Configuration" ],
"summary" : "Retrieve global configuration",
"description" : "Retrieve global configuration in R4JC - Requirements Management for Jira Cloud",
"operationId" : "retrieveConfiguration",
"responses" : {
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"example" : {
"folderIssueType" : 10000
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/tree/projects/{projectKey}/items/{idOrJiraIssueKey}" : {
"get" : {
"tags" : [ "Tree" ],
"summary" : "Get tree item(s).",
"description" : "Get the children of the specified tree item id or Jira issue key. You can retrieve the complete tree structure by recursively using this endpoint on items that return 'hasChildren' parameter as true.",
"operationId" : "getTreeStructureById",
"parameters" : [ {
"name" : "projectKey",
"in" : "path",
"description" : "Jira project key",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "TEST"
}, {
"name" : "idOrJiraIssueKey",
"in" : "path",
"description" : "The tree item id or jira issue key (Use -1 to get from root folder)",
"required" : true,
"schema" : {
"type" : "string",
"example" : null
},
"example" : "TEST-100"
}, {
"name" : "startAt",
"in" : "query",
"description" : "Start offset of the resulting items",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 0
},
"example" : 0
}, {
"name" : "maxResults",
"in" : "query",
"description" : "Max number of resulting items (Maximum of 100)",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null,
"default" : 50
},
"example" : 50
} ],
"responses" : {
"200" : {
"description" : "Successfully retrieved tree structure of tree item id or issue key provided. Only the immediate children will be included in the response.\\n\\n_Tip: Use the \\\"hasChildren\\\" property to identify which objects must be recursed to get the complete tree structure._",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaginatedTreeItemResponseDto"
},
"examples" : {
"Structure to recurse" : {
"description" : "If some of the \\\"children\\\" returned has \\\"hasChildren\\\" set to true, further retrieval can be done to complete your tree structure data.",
"value" : {
"startAt" : 0,
"maxResults" : 50,
"total" : 2,
"isLast" : true,
"values" : [ {
"id" : 625,
"jiraIssueId" : 12195,
"position" : 78,
"hasChildren" : true,
"isFolder" : true,
"path" : [ 546, 625 ],
"children" : [ {
"id" : 951,
"jiraIssueId" : 13526,
"parentId" : 52654,
"position" : 1,
"hasChildren" : true,
"isFolder" : false,
"path" : [ 546, 625, 951 ]
}, {
"id" : 952,
"jiraIssueId" : 13526,
"parentId" : 52654,
"position" : 1,
"hasChildren" : false,
"isFolder" : false,
"path" : [ 546, 625, 952 ]
} ]
} ]
}
},
"Structure to skip recursion" : {
"description" : "If all the \\\"children\\\" returned has \\\"hasChildren\\\" all set to false, there's nothing else in the structure to retrieve.",
"value" : {
"startAt" : 0,
"maxResults" : 50,
"total" : 2,
"isLast" : true,
"values" : [ {
"id" : 625,
"jiraIssueId" : 12195,
"position" : 78,
"hasChildren" : true,
"isFolder" : true,
"path" : [ 546, 625 ],
"children" : [ {
"id" : 951,
"jiraIssueId" : 13526,
"parentId" : 52654,
"position" : 1,
"hasChildren" : false,
"isFolder" : false,
"path" : [ 546, 625, 951 ]
}, {
"id" : 952,
"jiraIssueId" : 13526,
"parentId" : 52654,
"position" : 2,
"hasChildren" : false,
"isFolder" : false,
"path" : [ 546, 625, 952 ]
} ]
} ]
}
},
"Structure with errors in return" : {
"description" : "Some item(s) may not be returned successfully due to user browse permissions or issue security.",
"value" : {
"startAt" : 0,
"maxResults" : 3,
"total" : 100,
"isLast" : false,
"values" : [ {
"error" : "User does not have permission to browse this issue."
}, {
"id" : 625,
"jiraIssueId" : 12195,
"position" : 78,
"hasChildren" : true,
"isFolder" : true,
"path" : [ 546, 625 ],
"children" : [ {
"id" : 951,
"jiraIssueId" : 13526,
"parentId" : 52654,
"position" : 1,
"hasChildren" : true,
"isFolder" : false,
"path" : [ 546, 625, 951 ]
} ]
} ]
}
}
},
"example" : null
}
}
},
"400" : {
"description" : "Request validation error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"example" : {
"error" : "maxResults should be of type Integer."
}
}
}
},
"403" : {
"description" : "User has no permission to view project or project is not active in R4J.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"examples" : {
"No project permission" : {
"description" : "No project permission",
"value" : {
"error" : "You don't have permission to view the project."
}
},
"Project not active" : {
"description" : "Project not active",
"value" : {
"error" : "Project is not activated."
}
}
},
"example" : null
}
}
},
"404" : {
"description" : "Id or Issue Key does not exist.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"example" : {
"error" : "Id or Issue Key does not exist."
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/license" : {
"get" : {
"tags" : [ "License" ],
"summary" : "Retrieve application license",
"description" : "Retrieve Application license in R4J - Requirements Management for JIRA plugin",
"operationId" : "getLicenseStatus",
"responses" : {
"403" : {
"description" : "Request validation error.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RestApiErrorMessage"
},
"example" : {
"error" : "No active license."
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LicenseStatusDto"
},
"example" : {
"status" : "Active"
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
},
"/rest/api/1/projects/{projectId}" : {
"delete" : {
"tags" : [ "Project" ],
"summary" : "Deactivate an active project",
"description" : "Deactivate an active project in R4JC - Requirements Management for Jira Cloud",
"operationId" : "deactivateProject",
"parameters" : [ {
"name" : "projectId",
"in" : "path",
"description" : "Jira project ID",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"404" : {
"description" : "Cannot find requested Project ID",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : {
"error" : "Cannot find requested Project ID"
}
}
}
},
"200" : {
"description" : "Request is successful.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BackgroundTaskDto"
},
"example" : {
"id" : 1
}
}
}
},
"401" : {
"description" : "Authentication failed.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorJson"
},
"example" : "{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}"
}
}
},
"500" : {
"description" : "Server has encountered an error it doesn't know how to handle.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ErrorMessage"
},
"example" : "{\n \"error\": \"Unknown error has occurred.\"\n}"
}
}
}
}
}
}
},
"components" : {
"schemas" : {
"ErrorMessage" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"error" : {
"type" : "string",
"example" : null
},
"errors" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
},
"example" : null
},
"CoverageFilterColumnDto" : {
"required" : [ "label", "source" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"label" : {
"type" : "string",
"example" : null
},
"columnBasis" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"source" : {
"type" : "string",
"example" : null
},
"projects" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/OptionDto"
}
},
"issueTypes" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/OptionDto"
}
},
"linkTypes" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/OptionDto"
}
},
"jql" : {
"type" : "string",
"example" : null
},
"filter" : {
"$ref" : "#/components/schemas/OptionDto"
}
},
"example" : null
},
"CoverageFilterDto" : {
"required" : [ "name" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"name" : {
"type" : "string",
"example" : null
},
"isPublic" : {
"type" : "boolean",
"example" : null
},
"columns" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/CoverageFilterColumnDto"
}
},
"fields" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"scope" : {
"type" : "boolean",
"example" : null
},
"type" : {
"type" : "string",
"example" : null,
"enum" : [ "ROOT", "FOLDER", "VIEW", "TRACEABILITY_ROOT", "TRACEABILITY_FOLDER", "TRACEABILITY_VIEW" ]
},
"parentId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"linkTypes" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/OptionDto"
}
}
},
"example" : null
},
"OptionDto" : {
"required" : [ "value" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"value" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"BackgroundTaskDto" : {
"type" : "object",
"properties" : {
"taskName" : {
"type" : "string",
"example" : null
},
"data" : {
"type" : "string",
"example" : null
},
"status" : {
"type" : "string",
"example" : null,
"enum" : [ "IN_PROGRESS", "FINISHED", "FAILED", "EXCEEDED", "ABORTING", "ABORTED" ]
},
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"createdDate" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"contextData" : {
"type" : "object",
"example" : null
}
},
"example" : null
},
"BaselineDto" : {
"required" : [ "name" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"readOnly" : true,
"example" : null
},
"sourceItemId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"name" : {
"maxLength" : 255,
"minLength" : 0,
"type" : "string",
"example" : null
},
"description" : {
"type" : "string",
"example" : null
},
"fixVersionIds" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"componentIds" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"jqlFilter" : {
"type" : "string",
"example" : null
},
"filter" : {
"$ref" : "#/components/schemas/TreeSearchRequestDto"
},
"createdBy" : {
"type" : "string",
"readOnly" : true,
"example" : null
},
"createdDate" : {
"type" : "string",
"format" : "date-time",
"readOnly" : true,
"example" : null
},
"taskData" : {
"type" : "object",
"readOnly" : true,
"example" : null
}
},
"example" : null
},
"TreeSearchRequestDto" : {
"required" : [ "type" ],
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : null
},
"query" : {
"type" : "string",
"example" : null
},
"fields" : {
"type" : "object",
"additionalProperties" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"example" : null
}
},
"example" : null
},
"ExportTemplateDto" : {
"required" : [ "fileId", "templateName" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"readOnly" : true,
"example" : null
},
"fileId" : {
"type" : "string",
"example" : null
},
"description" : {
"type" : "string",
"example" : null
},
"scopes" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"projects" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"enable" : {
"type" : "boolean",
"example" : null
},
"fileSize" : {
"type" : "integer",
"format" : "int64",
"readOnly" : true,
"example" : null
},
"fileName" : {
"type" : "string",
"readOnly" : true,
"example" : null
},
"createdBy" : {
"type" : "string",
"readOnly" : true,
"example" : null
},
"createdDate" : {
"type" : "string",
"format" : "date-time",
"readOnly" : true,
"example" : null
},
"templateName" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"DisplayFieldViewDto" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"name" : {
"type" : "string",
"example" : null
},
"description" : {
"type" : "string",
"example" : null
},
"type" : {
"type" : "string",
"example" : null,
"enum" : [ "ROOT", "FOLDER", "VIEW" ]
},
"componentType" : {
"type" : "string",
"example" : null,
"enum" : [ "COVERAGE_VIEW", "TREE_VIEW", "READING_VIEW", "TABULAR_VIEW" ]
},
"fieldItems" : {
"type" : "object",
"additionalProperties" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"public" : {
"type" : "boolean",
"example" : null
}
},
"example" : null
},
"TreeItemDto" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"isFolder" : {
"type" : "boolean",
"example" : null
},
"jiraIssueId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"jiraIssueKey" : {
"type" : "string",
"example" : null
},
"parentId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"position" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"hasChildren" : {
"type" : "boolean",
"example" : null
},
"path" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"treeProjectId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"error" : {
"type" : "string",
"example" : null
},
"siblingId" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"example" : null
},
"UpdateTreeItemRequestDto" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"isFolder" : {
"type" : "boolean",
"example" : null
},
"jiraIssueId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"jiraIssueKey" : {
"type" : "string",
"example" : null
},
"isExternal" : {
"type" : "boolean",
"example" : null
},
"items" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/TreeItemDto"
}
}
},
"example" : null
},
"UpdateTreeItemResponseDto" : {
"type" : "object",
"properties" : {
"values" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/TreeItemDto"
}
}
},
"example" : null
},
"RestApiErrorMessage" : {
"type" : "object",
"properties" : {
"error" : {
"type" : "string",
"example" : null
},
"traceId" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"ReqIFFileProject" : {
"type" : "object",
"properties" : {
"fileId" : {
"type" : "string",
"example" : null
},
"fileName" : {
"type" : "string",
"example" : null
},
"projectKey" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"IssueRequestDto" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"example" : null
},
"isLink" : {
"type" : "boolean",
"example" : null
},
"linkTypeId" : {
"type" : "string",
"example" : null
},
"isLinkOutward" : {
"type" : "boolean",
"example" : null
},
"targetItemId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"jql" : {
"type" : "string",
"example" : null
},
"filter" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"isChildRequirement" : {
"type" : "boolean",
"example" : null
},
"issueIdList" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
}
},
"example" : null
},
"ExistingIssueStatisticsDto" : {
"type" : "object",
"properties" : {
"selectedIssuesCount" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"newIssuesCount" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"issuesInTreeCount" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
},
"example" : null
},
"ReuseRequestDto" : {
"required" : [ "itemIdList", "targetId" ],
"type" : "object",
"properties" : {
"targetId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"itemIdList" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"filter" : {
"$ref" : "#/components/schemas/TreeSearchRequestDto"
},
"isCopy" : {
"type" : "boolean",
"example" : null
},
"createAttachment" : {
"type" : "boolean",
"example" : null
},
"linkIssue" : {
"type" : "boolean",
"example" : null
},
"linkTypeId" : {
"type" : "string",
"example" : null
},
"isLinkOutward" : {
"type" : "boolean",
"example" : null
}
},
"example" : null
},
"WordExportDto" : {
"required" : [ "itemOrIssueId", "scope", "templateId" ],
"type" : "object",
"properties" : {
"templateId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"itemOrIssueId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"scope" : {
"type" : "string",
"example" : null,
"enum" : [ "TREE_VIEW", "JIRA_DETAIL_VIEW" ]
},
"filter" : {
"$ref" : "#/components/schemas/TreeSearchRequestDto"
}
},
"example" : null
},
"BaselineSearchDto" : {
"type" : "object",
"properties" : {
"query" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"BaselineTreeItemSearchRequestDto" : {
"required" : [ "fromBaselineId", "toBaselineId" ],
"type" : "object",
"properties" : {
"fromBaselineId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"toBaselineId" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"example" : null
},
"BaselineTreeItemDto" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"projectId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"sourceProjectId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"parentId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"issueId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"path" : {
"type" : "string",
"example" : null
},
"hasChild" : {
"type" : "boolean",
"example" : null
},
"baselineId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"issueKey" : {
"type" : "string",
"example" : null
},
"deleted" : {
"type" : "boolean",
"example" : null
},
"issueRevision" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"toIssueRevision" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"example" : null
},
"BaselineTreeItemListDto" : {
"type" : "object",
"properties" : {
"startAt" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"values" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/BaselineTreeItemDto"
}
}
},
"example" : null
},
"ActiveProjectDto" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"key" : {
"type" : "string",
"readOnly" : true,
"example" : null
},
"name" : {
"type" : "string",
"readOnly" : true,
"example" : null
},
"enabled" : {
"type" : "boolean",
"example" : null
},
"icon" : {
"type" : "string",
"readOnly" : true,
"example" : null
},
"isActive" : {
"type" : "boolean",
"readOnly" : true,
"example" : null
}
},
"example" : null
},
"UpsertConfigurationRequestDto" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "object",
"example" : null
}
},
"example" : null
},
"SearchRequestDto" : {
"type" : "object",
"properties" : {
"treeProjectId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"treeProjectKey" : {
"type" : "string",
"example" : null
},
"jql" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"PaginatedSearchItemResponseDto" : {
"type" : "object",
"properties" : {
"startAt" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"isLast" : {
"type" : "boolean",
"example" : null
},
"values" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/SearchTreeItemDto"
}
}
},
"example" : null
},
"SearchTreeItemDto" : {
"type" : "object",
"properties" : {
"jiraIssueId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"items" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/TreeItemChildrenDto"
}
}
},
"example" : null
},
"TreeItemChildrenDto" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"isFolder" : {
"type" : "boolean",
"example" : null
},
"jiraIssueId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"jiraIssueKey" : {
"type" : "string",
"example" : null
},
"parentId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"position" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"hasChildren" : {
"type" : "boolean",
"example" : null
},
"path" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"treeProjectId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"error" : {
"type" : "string",
"example" : null
},
"siblingId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"children" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/TreeItemDto"
}
}
},
"example" : null
},
"VersionDto" : {
"type" : "object",
"properties" : {
"version" : {
"type" : "string",
"example" : null
},
"buildNumber" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"CoverageFilterBase" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"example" : null
},
"fields" : {
"type" : "string",
"example" : null
},
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"type" : {
"type" : "string",
"example" : null,
"enum" : [ "ROOT", "FOLDER", "VIEW", "TRACEABILITY_ROOT", "TRACEABILITY_FOLDER", "TRACEABILITY_VIEW" ]
},
"scope" : {
"type" : "boolean",
"example" : null
},
"isPublic" : {
"type" : "boolean",
"example" : null
}
},
"example" : null
},
"CoverageFilterListDto" : {
"type" : "object",
"properties" : {
"startAt" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"values" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/CoverageFilterBase"
}
}
},
"example" : null
},
"ScreenTabField" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : null
},
"name" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"ScreenTabFieldSearch" : {
"type" : "object",
"properties" : {
"values" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ScreenTabField"
}
},
"screenTabs" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ScreenableTab"
}
}
},
"example" : null
},
"ScreenableTab" : {
"type" : "object",
"properties" : {
"tabId" : {
"type" : "string",
"example" : null
},
"tabName" : {
"type" : "string",
"example" : null
},
"values" : {
"uniqueItems" : true,
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ScreenTabField"
}
}
},
"example" : null
},
"ScreenTab" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"name" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"ScreenTabSearch" : {
"type" : "object",
"properties" : {
"screenId" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"values" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ScreenTab"
}
}
},
"example" : null
},
"AggregateProgress" : {
"type" : "object",
"properties" : {
"progress" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
},
"example" : null
},
"Attachment" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"self" : {
"type" : "string",
"example" : null
},
"filename" : {
"type" : "string",
"example" : null
},
"author" : {
"$ref" : "#/components/schemas/User"
},
"created" : {
"type" : "string",
"example" : null
},
"size" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"mimeType" : {
"type" : "string",
"example" : null
},
"properties" : {
"type" : "object",
"example" : null
},
"content" : {
"type" : "string",
"example" : null
},
"thumbnail" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"AvatarUrls" : {
"type" : "object",
"properties" : {
"48x48" : {
"type" : "string",
"example" : null
},
"24x24" : {
"type" : "string",
"example" : null
},
"16x16" : {
"type" : "string",
"example" : null
},
"32x32" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"Changelog" : {
"type" : "object",
"properties" : {
"startAt" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"histories" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/History"
}
}
},
"example" : null
},
"Comment" : {
"type" : "object",
"properties" : {
"self" : {
"type" : "string",
"example" : null
},
"id" : {
"type" : "string",
"example" : null
},
"author" : {
"$ref" : "#/components/schemas/User"
},
"updateAuthor" : {
"$ref" : "#/components/schemas/User"
},
"body" : {
"type" : "object",
"example" : null
},
"created" : {
"type" : "string",
"example" : null
},
"updated" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"Comments" : {
"type" : "object",
"properties" : {
"comments" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Comment"
}
},
"maxResults" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"startAt" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
},
"example" : null
},
"Component" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : null
},
"name" : {
"type" : "string",
"example" : null
},
"description" : {
"type" : "string",
"example" : null
},
"assigneeType" : {
"type" : "string",
"example" : null
},
"project" : {
"type" : "string",
"example" : null
},
"assignee" : {
"$ref" : "#/components/schemas/User"
}
},
"example" : null
},
"Fields" : {
"type" : "object",
"properties" : {
"statuscategorychangedate" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"issuetype" : {
"$ref" : "#/components/schemas/IssueType"
},
"timespent" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"project" : {
"$ref" : "#/components/schemas/Project"
},
"fixVersions" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Version"
}
},
"aggregatetimespent" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"resolution" : {
"$ref" : "#/components/schemas/Resolution"
},
"resolutiondate" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"workratio" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"watches" : {
"$ref" : "#/components/schemas/Watches"
},
"lastViewed" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"issuerestriction" : {
"$ref" : "#/components/schemas/IssueRestriction"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"priority" : {
"$ref" : "#/components/schemas/Priority"
},
"labels" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"timeestimate" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"aggregatetimeoriginalestimate" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"versions" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Version"
}
},
"issuelinks" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/IssueLinkDto"
}
},
"assignee" : {
"$ref" : "#/components/schemas/User"
},
"updated" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"status" : {
"$ref" : "#/components/schemas/Status"
},
"components" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Component"
}
},
"timeoriginalestimate" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"description" : {
"type" : "object",
"example" : null
},
"timetracking" : {
"$ref" : "#/components/schemas/TimeTracking"
},
"security" : {
"$ref" : "#/components/schemas/IdAndName"
},
"aggregatetimeestimate" : {
"type" : "integer",
"format" : "int64",
"example" : null
},
"attachment" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Attachment"
}
},
"summary" : {
"type" : "string",
"example" : null
},
"creator" : {
"$ref" : "#/components/schemas/User"
},
"subtasks" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Issue"
}
},
"reporter" : {
"$ref" : "#/components/schemas/User"
},
"environment" : {
"type" : "object",
"example" : null
},
"duedate" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"progress" : {
"$ref" : "#/components/schemas/Progress"
},
"comment" : {
"$ref" : "#/components/schemas/Comments"
},
"votes" : {
"$ref" : "#/components/schemas/Votes"
},
"worklog" : {
"$ref" : "#/components/schemas/Worklog"
},
"user" : {
"$ref" : "#/components/schemas/User"
},
"aggregateprogress" : {
"$ref" : "#/components/schemas/AggregateProgress"
},
"parent" : {
"$ref" : "#/components/schemas/Issue"
}
},
"example" : null
},
"History" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : null
},
"author" : {
"$ref" : "#/components/schemas/User"
},
"created" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"items" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "object",
"example" : null
}
}
},
"example" : null
},
"IdAndName" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : null
},
"name" : {
"type" : "string",
"example" : null
}
},
"example" : null
},
"Issue" : {
"type" : "object",
"properties" : {
"expand" : {
"type" : "string",
"example" : null
},
"id" : {
"type" : "string",
"example" : null
},
"self" : {
"type" : "string",
"example" : null
},
"key" : {
"type" : "string",
"example" : null
},
"infields" : "path",{
"description$ref" : "Jira project key",#/components/schemas/Fields"
"required": true},
"schemarenderedFields" : {
"type" : "stringobject",
},"additionalProperties" : {
"exampletype" : "TESTobject",
}, "example" : null
{ "name": "idOrJiraIssueKey"},
"inexample" : "path",null
},
"description": "The tree item id or jira issue key (Use -1 to get from root folder)","schema" : {
"type" : "requiredobject": true,
"schemaadditionalProperties" : {
"type$ref" : "string#/components/schemas/Schema"
},
"example" : "TEST-100"null
},
"names" : {
"nametype" : "startAtobject",
"inadditionalProperties" : "query", {
"descriptiontype" : "Start offset of the resulting items",
string",
"example" : null
"required": false},
"schemaexample" : null
{ },
"type": "integerchangelog", : {
"format$ref" : "int32",#/components/schemas/Changelog"
}
"default": 0 },
"example" : }null
},
}, "IssueLinkDto" : {
{ "type" : "object",
"name": "maxResultsproperties", : {
"inoutwardIssue" : "query",{
"description$ref" : "Max number of resulting items (Maximum of 100)",
#/components/schemas/LinkedIssue"
},
"requiredinwardIssue" : true,{
"schema$ref" : {"#/components/schemas/LinkedIssue"
},
"type" : "integer",
{
"format$ref" : "int32",
#/components/schemas/IssueLinkType"
}
"default": 50, },
"maximumexample" : 100
null
},
"IssueLinkType" : {
} "type" : ]"object",
"responsesproperties" : {
"200id" : {
"descriptiontype" : "Successfullystring",
retrieved tree structure of tree item id or issue key provided. Only"example" the: immediatenull
children will be included in the response.\n\n_Tip: Use the \"hasChildren\" property to identify which objects must be recursed to get the complete tree structure._", },
"name" : {
"contenttype" : {
"string",
"application/jsonexample" : {null
},
"schema": { "inward" : {
"$reftype" : "#/components/schemas/TreeItemDto"string",
"example" : null
}, },
"examplesoutward" : {
"type" : "string",
"Structure to recurse"example" : {null
}
},
"description": "If some of the \"children\" returned has \"hasChildren\example" set: null
to true, further retrieval can be},
done to complete your tree structure data.",
"IssueRestriction" : {
"type" : "object",
"valueproperties" : {
"issuerestrictions" : {
"startAt$ref" : 0,"#/components/schemas/IssueRestrictions"
},
"maxResultsshouldDisplay" : 50, {
"type" : "boolean",
"totalexample" : null
2, }
},
"isLastexample" : true,null
},
"IssueRestrictions" : {
"valuestype" : ["object",
"example" : null
},
{"IssueType" : {
"type" : "object",
"idproperties" : 625, {
"self" : {
"jiraIssueIdtype" : 12195"string",
"example" : null
"position": 78},
"id" : {
"hasChildrentype" : true"string",
"example" : null
"isFolder": true},
"description" : {
"pathtype" : ["string",
"example" : null
546},
"iconUrl" : {
"type" : "string",
625 "example" : null
]},
"name" : {
"childrentype" : ["string",
"example" : null
},
{ "subtask" : {
"type" : "boolean",
"id": 951, "example" : null
},
"jiraIssueIdavatarId" : 13526,{
"type" : "integer",
"format" : "parentIdint32": 52654,
"example" : null
"position": 1,},
"entityId" : {
"type" : "string",
"hasChildren": true, "example" : null
},
"isFolderhierarchyLevel" : false,{
"type" : "integer",
"format" : "pathint32":,
[ "example" : null
}
546 },
"example" : null
},
"LinkedIssue" : {
625, "type" : "object",
"properties" : {
"self" : {
951 "type" : "string",
"example" : null
] },
"key" : {
}, "type" : "string",
"example" : null
{ },
"id" : {
"type" : "idstring": 952,
"example" : null
"jiraIssueId": 13526},
"fields" : {
"parentId": 52654,"$ref" : "#/components/schemas/Fields"
}
},
"positionexample" : 1,null
},
"Priority" : {
"type" : "object",
"hasChildren": false, "properties" : {
"self" : {
"isFoldertype" : false"string",
"example" : null
},
"path": [ "iconUrl" : {
"type" : "string",
546, "example" : null
},
"name" : {
625, "type" : "string",
"example" : null
952 },
"id" : {
"type" : "string",
] "example" : null
}
} },
"example" : null
},
] "Progress" : {
"type" : "object",
}"properties" : {
"progress" : {
] "type" : "integer",
"format" }: "int32",
"example" : null
}, },
"total"Structure to skip recursion": {
"descriptiontype" : "If all the \"children\" returned has \"hasChildren\" all set to false, there's nothing else in the structure to retrieve.integer",
"format" : "int32",
"example" : null
"value": { }
},
"startAtexample" : 0,null
},
"Project" : {
"maxResultstype" : 50"object",
"properties" : {
"totalself" : 2,{
"type" : "string",
"isLastexample" : true,null
},
"valuesid" : [{
"type" : "string",
{ "example" : null
},
"idkey" : 625,
{
"jiraIssueId": 12195"type" : "string",
"example" : null
"position": 78},
"name" : {
"hasChildrentype" : true"string",
"example" : null
"isFolder": true},
"description" : {
"pathtype" : ["string",
"example" : null
546},
"projectTypeKey" : {
"type" : "string",
625 "example" : null
},
], "simplified" : {
"type" : "childrenboolean":,
[ "example" : null
},
{ "avatarUrls" : {
"$ref" : "#/components/schemas/AvatarUrls"
"id": 951, },
"lead" : {
"$ref" : "jiraIssueId": 13526,#/components/schemas/User"
},
"issueTypes" : {
"parentIdtype" : 52654"array",
"example" : null,
"items" : {
"position": 1, "$ref" : "#/components/schemas/IssueType"
}
"hasChildren": false, }
},
"example" : null
"isFolder": false, },
"Resolution" : {
"type" : "object",
"pathproperties" : [{
"self" : {
"type" : "string",
546, "example" : null
},
"id" 625,: {
"type" : "string",
"example" : null
951 },
"name" : {
] "type" : "string",
"example" : null
}, },
"description" : {
{"type" : "string",
"example" : null
}
"id": 952, },
"example" : null
},
"jiraIssueIdSchema" : 13526,{
"type" : "object",
"properties" : {
"parentIdtype" : 52654,{
"type" : "string",
"positionexample" : 1,null
},
"items" : {
"hasChildren": false, "type" : "string",
"example" : null
"isFolder": false},
"system" : {
"type" : "string",
"path": [ "example" : null
},
"custom" 546,: {
"type" : "string",
"example" : null
625, },
"customId" : {
952 "type" : "integer",
"format" : "int32",
] "example" : null
},
"configuration" : {
} "type" : "object",
"example" ]: null
}
},
} "example" : null
},
"Status" : ]{
"type" : "object",
"properties" }: {
"self" : {
}, "type" : "string",
"Structure with errors in return"example" : null
{ },
"description" : {
"Some item(s) may not be returned successfully due to user browse permissions or"type" issue: security."string",
"example" : null
},
"value": { "iconUrl" : {
"startAttype" : 0"string",
"example" : null
"maxResults": 3},
"name" : {
"totaltype" : 100"string",
"example" : null
"isLast": false},
"id" : {
"valuestype" : ["string",
"example" : null
{ },
"statusCategory" : {
"error$ref" : "User does not have permission to browse this issue.""#/components/schemas/StatusCategory"
}
},
}, "example" : null
},
"StatusCategory" : {
{ "type" : "object",
"properties" : {
"idself" : 625,{
"type" : "string",
"jiraIssueIdexample" : 12195,null
},
"positionid" : 78,{
"type" : "integer",
"hasChildrenformat" : true"int32",
"example" : null
"isFolder": true},
"key" : {
"pathtype" : ["string",
"example" : null
546},
"colorName" : {
"type" : "string",
625 "example" : null
]},
"name" : {
"childrentype" : ["string",
"example" : null
}
{ },
"example" : null
},
"idTimeTracking" : 951,{
"type" : "object",
"properties" : {
"jiraIssueIdoriginalEstimate" : 13526,{
"type" : "string",
"example" : null
"parentId": 52654, },
"remainingEstimate" : {
"positiontype" : 1"string",
"example" : null
},
"hasChildrentimeSpent" : {
true, "type" : "string",
"example" : null
"isFolder": false, },
"originalEstimateSeconds" : {
"pathtype" : ["integer",
"format" : "int64",
"example" : null
546, },
"remainingEstimateSeconds" : {
625, "type" : "integer",
"format" : "int64",
"example" : 951null
},
"timeSpentSeconds" : {
] "type" : "integer",
"format" : "int64",
} "example" : null
}
] },
"example" : null
},
}, "TreeItemListDto" : {
"type" : "object",
"properties" : {
"startAt" : {
"errortype" : "integer"User,
does not have permission to browse this issue." "format" : "int32",
"example" : null
} },
"maxResults" : {
] "type" : "integer",
} "format" : "int32",
}"example" : null
},
} "total" : {
} "type" : "integer",
} "format" : }"int32",
"400example" : {null
"description": "Request validation error.",
},
"contentschema" : {
"type" : "application/json": {
object",
"schemaadditionalProperties" : {
"$ref" : "#/components/schemas/RestApiErrorMessageSchema"
},
"example" : null
"example": { },
"errorvalues" : "maxResults{
should be of type Integer." "type" : "array",
} "example" : null,
} "items" : {
} "$ref" },: "#/components/schemas/TreeItemProjection"
"401":}
{ }
"description": "Authentication failed.", },
"contentexample" : {null
},
"application/jsonTreeItemProjection" : {
"type" : "object",
"schemaproperties" : {
"id" : {
"$reftype" : "#/components/schemas/ErrorJson"integer",
"format" }: "int64",
"example" : "{\n null
\"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}" },
"path" : {
"type" : }"string",
}"example" : null
},
"403projectId" : {
"descriptiontype" : "Userinteger",
has no permission to view project or project is not active"format" in: R4J."int64",
"contentexample" : {null
},
"application/json": { "issueId" : {
"schema": { "type" : "integer",
"$refformat" : "#/components/schemas/RestApiErrorMessage"int64",
"example" : null
}, },
"exampleschildOrder" : {
"type" : "string",
"No project permission": { "example" : null
},
"valueissue" : {
"$ref" : "#/components/schemas/Issue"
},
"errorsourceProjectId" : {
"You don't have permission to view the project." "type" : "integer",
"format" }: "int64",
"example" : null
}, },
"hasChild"Project not active": {
"type" : "boolean",
"valueexample" : null
{ }
},
"errorexample" : null
"Project is not active." },
"User" : {
}"type" : "object",
"properties" : {
} "self" : {
}
"type" : "string",
}"example" : null
},
"accountId" : {
}, "404type" : {"string",
"descriptionexample" : null
"Id or Issue Key does not exist.", },
"contentavatarUrls" : {
"$ref" : "application/json": {#/components/schemas/AvatarUrls"
},
"schema": { "displayName" : {
"$reftype" : "#/components/schemas/RestApiErrorMessage"string",
"example" : null
}, },
"exampleactive" : {
"type" : "boolean",
"errorexample" : null
"Id or Issue Key does not exist." },
"timeZone" : {
} "type" : "string",
} "example" : }null
},
"500accountType" : {
"descriptiontype" : "Server has encountered an error it doesn't know how to handle.",string",
"example" : null
}
"content": { },
"application/jsonexample" : {null
},
"schemaVersion" : {
"type" : "object",
"$refproperties" : "#/components/schemas/ErrorMessage"{
"id" : {
}, "type" : "string",
"example": "{\n \"error\": \"Unknown error has occurred.\"\n}"example" : null
},
} "name" : {
} }"type" : "string",
} "example" }: null
}, "/rest/api/1/tree/search": { },
"post": { "description" : {
"tags": [ "type" : "Treestring",
], "example" : null
"summary": "Search for existing item(s) in any tree via JQL", },
"descriptionproject" : {
"Search for existing item(s) in any tree based on a valid JQL"type" query: provided.","string",
"operationIdexample" : "searchItems", null
},
"parameters": [ "releaseDate" : {
"nametype" : "startAtstring",
"inexample" : "query", null
},
"description": "Start offset of the resulting items","archived" : {
"requiredtype" : false"boolean",
"schemaexample" : null
{ },
"type": "integerreleased", : {
"formattype" : "int32boolean",
"defaultexample" : 0
null
}
},
"example" : {null
},
"name": "maxResultsVotes", : {
"intype" : "queryobject",
"properties" : {
"description": "Max number of resulting items (Maximum of 100)", "self" : {
"requiredtype" : false"string",
"schemaexample" : null
{ },
"type": "integervotes", : {
"formattype" : "int32integer",
"format" : "defaultint32": 50,
"maximumexample" : 100
null
},
}"hasVoted" : {
], "type" : "requestBodyboolean":,
{ "descriptionexample" : "Importantnull
for request body parameters:\n- The Object.treeProjectId and Object.treeProjectKey is the activated R4J}
project tree you want to search issues from.\n\n\n- If none of the tree project identifiers are provided, all activated R4J project trees will be searched.\n\n\n- If specifying the activated R4J poject tree you want to search, only one of the identifiers (treeProjectId or treeProjectKey) must be provided per Object.",
},
"example" : null
},
"Watches" : {
"type" : "object",
"contentproperties" : {
"application/jsonself" : {
"schema": {
type" : "string",
"$ref": "#/components/schemas/SearchRequestDtoexample" : null
},
"examplewatchCount" : {
"type" : "treeProjectIdinteger": 10000,
"treeProjectKeyformat" : "TESTint32",
"jqlexample" : "projectnull
= TEST" },
} "isWatching" : {
} "type" : "boolean",
}, "requiredexample" : truenull
}, }
"responses": { },
"200example" : null
{ },
"descriptionWorklog" : "Successfully{
searched item(s) based on JQL query provided.", "type" : "object",
"contentproperties" : {
"application/json""startAt" : {
"type" : "schema": {
integer",
"$refformat" : "#/components/schemas/PaginatedResponseDto"int32",
"example" : null
}, },
"examplesmaxResults" : {
"type" : "integer",
"Issue located in one tree": { "format" : "int32",
"valueexample" : {null
},
"startAttotal" : 0,{
"type" : "integer",
"maxResultsformat" : 50"int32",
"example" : null
"isLast": true, },
"worklogs" : {
"values": [ "type" : "array",
"example" : null,
{ "items" : {
"jiraIssueIdtype" : 10000"object",
"example" : null
"items": [ }
}
},
{ "example" : null
},
"FieldConfigurationSearch" : {
"type" : "idobject": 2,
"properties" : {
"maxResults" : {
"path": [ "type" : "integer",
"format" : "int32",
1, "example" : null
},
"startAt" : {
2 "type" : "integer",
"format" : "int32",
], "example" : null
},
"treeProjectIdtotal" : 10000,{
"type" : "integer",
"format" : "isFolderint32": true,
"example" : null
},
"position": 1, "isLast" : {
"type" : "boolean",
"hasChildren": true "example" : null
},
"values" : }{
"type" : "array",
] "example" : null,
"items" : {
} "$ref" : "#/components/schemas/FieldDto"
]}
}
},
"example" : null
},
"FieldDto" : {
"type"Issue located in multiple trees": {: "object",
"properties" : {
"valueid" : {
"type" : "string",
"startAtexample" : 0,null
},
"maxResultsisHidden" : 50,{
"type" : "boolean",
"isLastexample" : true,null
},
"valuesisRequired" : [{
"type" : "boolean",
{ "example" : null
},
"jiraIssueIdrenderer" : 10000,{
"type" : "string",
"itemsexample" : [null
}
},
{"example" : null
},
"DetailPathDto" : {
"type" : "idobject": 22,
"properties" : {
"itemIdPath" : {
"path": [ "type" : "array",
"example" : null,
13, "items" : {
"type" : "integer",
22 "format" : "int64",
"example" : null
], }
},
"treeProjectIdissueIdList" : 10000,
{
"type" : "array",
"isFolderexample" : falsenull,
"items" : {
"positiontype" : 5"integer",
"format" : "int64",
"hasChildrenexample" : null
true }
}
},
"example" : null
},
"BaselineIssueDto" : {
{ "type" : "object",
"properties" : {
"idexpand" : 86,{
"type" : "string",
"pathexample" : [null
},
"id" : {
82, "type" : "string",
"example" : null
28},
"self" : {
"type" 62: "string",
"example" : null
},
86 "key" : {
"type" : "string",
], "example" : null
},
"treeProjectIdissueRevision" : 10025,{
"type" : "integer",
"format" : "isFolderint64": false,
"example" : null
"position": 15},
"deleted" : {
"type" : "boolean",
"hasChildren": false "example" : null
},
} "fields" : {
"$ref" : "#/components/schemas/Fields"
] },
"schema" : {
} "type" : "object",
"additionalProperties" : ]{
"$ref" : "#/components/schemas/Schema"
} },
} "example" : null
},
"changelog" : {
} "$ref" }: "#/components/schemas/Changelog"
},
"400renderedFields" : {
"descriptiontype" : "Request validation error.object",
"contentadditionalProperties" : {
"application/jsontype": {
"schema": {
: "object",
"$refexample" : "#/components/schemas/RestApiErrorMessage"
null
},
"example" : null
"examples": { },
"names"Multiple identifiers provided": {
"type" : "object",
"value": { "additionalProperties" : {
"errortype" : "Youstring",
should specify either tree project id or key only." "example" : null
},
"example" : null
}, },
"toIssueRevision"No identifiers provided": {
"type" : "integer",
"valueformat" : {"int64",
"example" : null
"error": "Tree project id}
or key must not be empty." },
"example" : null
},
"BaselineIssueListDto" : {
"type" : }"object",
"properties" : {
"JQL is empty"startAt" : {
"type" : "integer",
"value": { "format" : "int32",
"errorexample" : "JQLnull
must not be empty." },
"maxResults" : {
} "type" : "integer",
}, "format" : "int32",
"example"Invalid JQL": {null
},
"valuetotal" : {
"type" : "integer",
"errorformat" : "int32"Invalid,
JQL provided." "example" : null
} },
"values" : {
} "type" : "array",
} "example" : null,
} "items" : {
} }, "$ref" : "#/components/schemas/BaselineIssueDto"
"401": { }
"description": "Authentication failed."},
"contentschema" : {
"type" : "application/jsonobject":,
{ "schemaadditionalProperties" : {
"$ref" : "#/components/schemas/ErrorJsonSchema"
},
"example" : "{\n null
\"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": null,\n \"timeStamp\": \"Tue Nov 16 09:53:46 UTC 2021\",\n \"trace\": null\n}" },
"names" : {
"type" : }"object",
}"additionalProperties" : {
}, "type" : "403string":,
{ "descriptionexample" : "Usernull
has no permission to view project or project is not active in R4J."},
"contentexample" : null
{ }
"application/json": { },
"example" : null
"schema": { },
"RevisionBaselineCountResponseDto" : {
"$reftype" : "#/components/schemas/RestApiErrorMessage"object",
"properties" : {
}, "issueRevision" : {
"examplestype" : { "integer",
"format" : "int64",
"No project permission"example" : {null
},
"valuecount" : {
"type" : "integer",
"errorformat" : "You don't have permission to view the project."
"int64",
"example" : null
}
},
"example" : null
},
"ProjectSearch" : {
"type"Project not: active"object":,
{ "properties" : {
"valuemaxResults" : {
"type" : "integer",
"errorformat" : "Project is not active."int32",
"example" : null
} },
"startAt" : {
} "type" : "integer",
} "format" : "int32",
} "example" : }null
},
"404total" : {
"descriptiontype" : "Project does not exist.integer",
"contentformat" : {
"int32",
"application/jsonexample" : {null
},
"schema": { "isLast" : {
"$reftype" : "#/components/schemas/RestApiErrorMessage"boolean",
"example" : null
}, },
"examplesvalues" : {
"type" : "array",
"Project not found": { "example" : null,
"valueitems" : {
"$ref" : "#/components/schemas/Project"
"error": "Could not find project with key TEST."}
}
},
"example" : null
},
} "CustomFieldContextOption" : {
"type" : }"object",
"properties" : {
} "disabled" : {
} "type" : }"boolean",
"500example" : {null
},
"description": "Server has encountered an error it doesn't know how"id" to handle.",: {
"contenttype" : {"string",
"application/jsonexample" : {null
},
"schema": { "optionId" : {
"$reftype" : "#/components/schemas/ErrorMessage"string",
"example" : null
}, },
"example": "{\n \"error\value" : \"Unknown{
error has occurred.\"\n}" "type" : "string",
} "example" : null
} }
}
},
} },
"componentsexample" : {null
"schemas": { },
"UpdateRequestDtoCustomFieldContextOptionResponseDto" : {
"type" : "object",
"properties" : {
"idstartAt" : {
"type" : "integer",
"format" : "int64"
},
"isFolder": {int32",
"typeexample" : "boolean"null
},
"jiraIssueIdmaxResults" : {
"type" : "integer",
"format" : "int64"
int32",
}, "jiraIssueKeyexample": {
"type": "string"null
},
"itemstotal" : {
"type" : "arrayinteger",
"itemsformat" : {"int32",
"typeexample" : "object"null
},
} "isLast" : }{
}
"type" : "boolean",
}, "UpdateResponseDtoexample" : null
{ "type": "object", },
"propertiesvalues" : {
"valuestype" : {"array",
"typeexample" : "array"null,
"items" : {
"type$ref" : "object#/components/schemas/CustomFieldContextOption"
}
}
},
"example" : null
},
"RemovedItemsDtoCustomFieldContextProjectMapping" : {
"type" : "object",
"properties" : {
"totalItemsRemovedcontextId" : {
"type" : "integerstring",
"formatexample" : "int32"null
},
"projectId" }: {
}, "SearchRequestDtotype" : { "string",
"typeexample" : "object",null
"properties": { },
"treeProjectIdisGlobalContext" : {
"type" : "integerboolean",
"formatexample" : "int64"null
},
},
"treeProjectKeyexample" : { null
},
"CustomFieldContextProjectMappingResponseDto" : {
"type" : "stringobject",
"properties" : },{
"jqlstartAt" : {
"type" : "stringinteger",
} "format" : "int32",
} }, "example" : null
"PaginatedResponseDto": { },
"type": "object", "propertiesmaxResults" : {
"startAttype" : {"integer",
"typeformat" : "integerint32",
"formatexample" : "int32"null
},
"maxResultstotal" : {
"type" : "integer",
"typeformat" : "integerint32",
"formatexample" : "int32"null
},
"totalisLast" : {
"type" : "integerboolean",
"formatexample" : "int32"null
},
"isLastvalues" : {
"type" : "booleanarray"
,
}, "values": {"example" : null,
"typeitems" : "array", {
"items$ref" : {"#/components/schemas/CustomFieldContextProjectMapping"
"type": "object"}
}
},
} "example" : }null
},
"TreeItemDtoPaginatedDto" : {
"type" : "object",
"properties" : {
"idstartAt" : {
"type" : "integer",
"format" : "int64""int32",
"example" : null
},
"isFoldermaxResults" : {
"type" : "boolean"
"integer",
"format" : "int32",
"example" : null
},
"jiraIssueIdtotal" : {
"type" : "integer",
"format" : "int32",
"int64example" : null
},
"jiraIssueKeyvalues" : {
"type" : "stringarray",
"example" : }null,
"parentIditems" : {
"type" : "integerobject",
"formatexample" : null
"int64" },
}
"position": { },
"typeexample" : "integer",
null
},
"PaginatedTreeItemResponseDto" : {
"formattype" : "int64object",
"properties" : },{
"hasChildrenstartAt" : {
"type" : "booleaninteger",
} "format" : "int32",
"pathexample" : { null
},
"typemaxResults" : "array",{
"itemstype" : {
"integer",
"typeformat" : "integerint32",
"formatexample" : "int64"null
},
} "total" : {
}, "treeProjectIdtype" : {"integer",
"typeformat" : "integerint32",
"formatexample" : "int64"null
},
"childrenisLast" : {
"type" : "arrayboolean",
"itemsexample" : {null
},
"$ref": "#/components/schemas/TreeItemDto" "values" : {
} "type" : "array",
}, "errorexample" : {null,
"typeitems" : "string" {
} "$ref" : "#/components/schemas/TreeItemDto"
} },
"ErrorMessage": { }
"type": "object" },
"propertiesexample" : {null
},
"errorLicenseStatusDto" : {
"type" : "stringobject",
"properties" : },{
"errorsstatus" : {
"type" : "arraystring",
"items": {
"type": "string"example" : null
}
},
} "example" : }null
},
"RestApiErrorMessageRemovedItemsDto" : {
"type" : "object",
"properties" : {
"errortotalItemsRemoved" : {
"type" : "stringinteger",
"format" : }"int32",
"traceIdexample" : {null
}
"type": "string" },
} "example" : null
} },
"ErrorJson" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "integer",
"format" : "int32",
"example" : null
},
"error" : {
"type" : "string",
"example" : null
},
"message" : {
"type" : "string",
"example" : null
},
"timeStamp" : {
"type" : "string",
"example" : null
},
"trace" : {
"type" : "string",
"example" : null
}
},
"example" : null
}
}
}
} |
Page Comparison
Manage space
Manage content
Integrations