Skip to content

Instantly share code, notes, and snippets.

@rastaman

rastaman/jira-api-wo-local-definitions.json

Created June 14, 2017 15:44
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save rastaman/30bd532aa7071c662703c0af0472303d to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save rastaman/30bd532aa7071c662703c0af0472303d to your computer and use it in GitHub Desktop.
Download ZIP
Raw
jira-api-wo-local-definitions.json
{
"basePath": "/jira/rest/",
"paths": {
"api/2/settings/columns": {
"get": {
"produces": ["application/json"],
"operationId": "getIssueNavigatorDefaultColumns",
"description": "Returns the default system columns for issue navigator. Admin permission will be required.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-column-item#",
"title": "List of Column Item",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Column Item",
"type": "object",
"properties": {
"label": {"type": "string"},
"value": {"type": "string"}
}
}
},
"description": "\n column configuration\n"
},
"500": {"description": "\n column configuration\n"},
"403": {"description": "\n column configuration\n"}
}
},
"put": {
"produces": ["application/json"],
"operationId": "setIssueNavigatorDefaultColumns",
"description": "Sets the default system columns for issue navigator. Admin permission will be required.",
"responses": {
"200": {"description": "\n javax.ws.rs.core.Response containing basic message and http return code\n"},
"500": {"description": "\n javax.ws.rs.core.Response containing basic message and http return code\n"}
}
}
},
"api/2/screens/{screenId}/tabs/{tabId}/fields/{id}": {
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "id",
"type": "string",
"required": true
}
],
"delete": {
"produces": ["application/json"],
"operationId": "removeField",
"description": "Removes field from given tab",
"responses": {
"201": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
}
}
},
"api/2/projectvalidate/validProjectKey": {"get": {
"produces": ["application/json"],
"operationId": "getValidProjectKey",
"description": "Validates the project key and generated a valid project key if the supplied key is invalid.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"examples": {"application/json": "\"VPNE\""},
"description": "\n a String containing a valid project key.\n"
}},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n the project key\n",
"type": "string"
}]
}},
"api/2/field/{fieldKey}/option": {
"post": {
"produces": ["application/json"],
"operationId": "createOption",
"description": "Creates an option for a select list issue field, for a given field key. The Id will be automatically assigned. Only JIRA administrators or the add-ons that provided the field may use this method.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-field-option#",
"additionalProperties": false,
"title": "Issue Field Option",
"type": "object",
"properties": {
"id": {"type": "integer"},
"value": {"type": "string"},
"config": {
"additionalProperties": false,
"title": "Issue Field Option Config",
"type": "object",
"properties": {
"scope": {
"additionalProperties": false,
"title": "Issue Field Option Scope",
"type": "object",
"properties": {
"projects2": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Scope",
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
},
"id": {"type": "integer"}
},
"required": ["id"]
}
},
"projects": {
"type": "array",
"items": {"type": "integer"}
},
"global": {
"additionalProperties": false,
"title": "Global Scope",
"type": "object",
"properties": {"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}}
}
}
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}
}
},
"properties": {
"title": "Object Node",
"type": "object"
}
}
},
"examples": {"application/json": "{\"value\":\"Team\n 1\",\"properties\":{\"leader\":{\"name\":\"Leader\n Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The\n team's\n description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"},
"description": "\n The created select list issue field option.\n"
},
"400": {"description": "\n The created select list issue field option.\n"},
"403": {"description": "\n The created select list issue field option.\n"},
"404": {"description": "\n The created select list issue field option.\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-field-option#",
"additionalProperties": false,
"title": "Issue Field Option",
"type": "object",
"properties": {
"id": {"type": "integer"},
"value": {"type": "string"},
"config": {
"additionalProperties": false,
"title": "Issue Field Option Config",
"type": "object",
"properties": {
"scope": {
"additionalProperties": false,
"title": "Issue Field Option Scope",
"type": "object",
"properties": {
"projects2": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Scope",
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
},
"id": {"type": "integer"}
},
"required": ["id"]
}
},
"projects": {
"type": "array",
"items": {"type": "integer"}
},
"global": {
"additionalProperties": false,
"title": "Global Scope",
"type": "object",
"properties": {"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}}
}
}
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}
}
},
"properties": {
"title": "Object Node",
"type": "object"
}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllOptions",
"description": "<p> Returns all options defined for a select list issue field, for a given field key. Only JIRA administrators or the add-ons that provided the field may use this method.\n <p> The list of options will be ordered by the option Id and <a href=\"#pagination\">paginated<\/a>.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/page-of-issue-field-option#",
"additionalProperties": false,
"title": "Page of Issue Field Option",
"type": "object",
"properties": {
"total": {"type": "integer"},
"isLast": {"type": "boolean"},
"nextPage": {
"format": "uri",
"type": "string"
},
"maxResults": {"type": "integer"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Field Option",
"type": "object",
"properties": {
"id": {"type": "integer"},
"value": {"type": "string"},
"config": {
"additionalProperties": false,
"title": "Issue Field Option Config",
"type": "object",
"properties": {
"scope": {
"additionalProperties": false,
"title": "Issue Field Option Scope",
"type": "object",
"properties": {
"projects2": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Scope",
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
},
"id": {"type": "integer"}
},
"required": ["id"]
}
},
"projects": {
"type": "array",
"items": {"type": "integer"}
},
"global": {
"additionalProperties": false,
"title": "Global Scope",
"type": "object",
"properties": {"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}}
}
}
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}
}
},
"properties": {
"title": "Object Node",
"type": "object"
}
}
}
},
"self": {
"format": "uri",
"type": "string"
},
"startAt": {"type": "integer"}
},
"required": [
"maxResults",
"startAt"
]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/field/fieldKey/option?startAt=0&maxResults=1\",\"nextPage\":\"http://www.example.com/jira/rest/api/2/field/fieldKey/option?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team\n 1\",\"properties\":{\"leader\":{\"name\":\"Leader\n Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The\n team's\n description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}]}"},
"description": "\n A page containing the options for a given field.\n"
},
"403": {"description": "\n A page containing the options for a given field.\n"},
"404": {"description": "\n A page containing the options for a given field.\n"}
},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n The starting index of the returned objects. Base index: 0.\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n The maximum number of items to return per page. Default: 50.\n",
"type": "integer"
}
]
},
"parameters": [{
"in": "path",
"name": "fieldKey",
"type": "string",
"required": true
}]
},
"api/2/projectvalidate/validProjectName": {"get": {
"produces": ["application/json"],
"operationId": "getValidProjectName",
"description": "Validates a project name.\n\n If the name is invalid, an attempt is made to produce a valid name\n based on the supplied one. If no such valid name can be found, an\n empty string is returned.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"examples": {"application/json": "\"Valid Project Name\n Example\""},
"description": "\n a String containing a valid project name.\n"
}},
"parameters": [{
"in": "query",
"name": "name",
"description": "\n the project name\n",
"type": "string"
}]
}},
"api/2/dashboard/{dashboardId}/items/{itemId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the dashboard item identified by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"description": "\n the dashboard item from which keys will be returned.\n",
"type": "string",
"required": true
},
{
"in": "path",
"name": "dashboardId",
"type": "string",
"required": true
}
]
},
"api/2/issue/{issueIdOrKey}/attachments": {
"post": {
"produces": ["application/json"],
"operationId": "addAttachment",
"description": "Add one or more attachments to an issue.\n <p>\n This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client\n libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components\n library provides a\n <a href=\"http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html\">MultiPartEntity<\/a>\n that makes it simple to submit a multipart POST.\n <p>\n In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection\n on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be\n blocked.\n <p>\n The name of the multipart/form-data parameter that contains attachments must be \"file\"\n <p>\n A simple example to upload a file called \"myfile.txt\" to issue REST-123:\n <pre>curl -D- -u admin:admin -X POST -H \"X-Atlassian-Token: no-check\" -F \"[email protected]\" http://myhost/rest/api/2/issue/TEST-123/attachments<\/pre>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-attachment#",
"title": "List of Attachment",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Attachment",
"type": "object",
"properties": {
"thumbnail": {"type": "string"},
"filename": {"type": "string"},
"size": {"type": "integer"},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"created": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "integer"},
"mimeType": {"type": "string"},
"properties": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"content": {"type": "string"}
},
"required": [
"id",
"size"
]
}
},
"examples": {"application/json": "\n [{\"id\":10001,\"self\":\"http://www.example.com/jira/rest/api/2.0/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:50.772+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"http://www.example.com/jira/attachments/10000\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10000\"},{\"id\":0,\"self\":\"http://www.example.com/jira/rest/api/2.0/attachments/10001\",\"filename\":\"dbeuglog.txt\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:50.772+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"http://www.example.com/jira/attachments/10001\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10002\"}]"},
"description": "\n a JSON representation of the attachments added.\n"
},
"403": {"description": "\n a JSON representation of the attachments added.\n"},
"404": {"description": "\n a JSON representation of the attachments added.\n"}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n the issue that you want to add the attachments to\n",
"type": "string",
"required": true
}]
},
"api/2/universal_avatar/type/{type}/owner/{owningObjectId}": {
"get": {
"produces": ["application/json"],
"operationId": "getAvatars",
"responses": {"": {}}
},
"parameters": [
{
"in": "path",
"name": "type",
"type": "string",
"required": true
},
{
"in": "path",
"name": "owningObjectId",
"type": "string",
"required": true
}
]
},
"api/2/project/{projectKeyOrId}/securitylevel": {
"get": {
"produces": ["application/json"],
"operationId": "getSecurityLevelsForProject",
"description": "Returns all security levels for the project that the current logged in user has access to.\n If the user does not have the Set Issue Security permission, the list will be empty.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-list-level#",
"additionalProperties": false,
"title": "Security List Level",
"type": "object",
"properties": {"levels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"levels\":[{\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/100000\",\"id\":\"100000\",\"description\":\"security\n description\",\"name\":\"securityLevelName\"},{\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/100001\",\"id\":\"100001\",\"description\":\"another\n security\n description\",\"name\":\"secret\"}]}"},
"description": "\n list of security levels\n"
},
"404": {"description": "\n list of security levels\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"description": "\n - key or id of project to list the security levels for\n",
"type": "string",
"required": true
}]
},
"api/2/project/{projectKeyOrId}/permissionscheme": {
"get": {
"produces": ["application/json"],
"operationId": "getAssignedPermissionScheme",
"description": "Gets a permission scheme assigned with a project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\"}"},
"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"
},
"401": {"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"},
"403": {"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"},
"404": {"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"description": "\n key or id of the project\n",
"type": "string",
"required": true
}],
"put": {
"produces": ["application/json"],
"operationId": "assignPermissionScheme",
"description": "Assigns a permission scheme with a project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\"}"},
"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"
},
"401": {"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"},
"403": {"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"},
"404": {"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/id#",
"additionalProperties": false,
"title": "Id",
"type": "object",
"properties": {"id": {"type": "integer"}}
},
"in": "body"
},
{
"in": "query",
"name": "expand",
"type": "string"
}
]
}
},
"api/2/securitylevel/{id}": {
"get": {
"produces": ["application/json"],
"operationId": "getIssuesecuritylevel",
"description": "Returns a full representation of the security level that has the given id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-level#",
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only\n the reporter and internal staff can see this\n issue.\",\"name\":\"Reporter Only\"}"},
"description": "\n a full representation of the issue security level with the given id\n"
},
"404": {"description": "\n a full representation of the issue security level with the given id\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n a String containing an issue security level id\n",
"type": "string",
"required": true
}]
},
"api/2/screens/{screenId}/tabs/{tabId}/fields": {
"post": {
"produces": ["application/json"],
"operationId": "addField",
"description": "Adds field to the given tab.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-field#",
"additionalProperties": false,
"title": "Screenable Field",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"id\":\"summary\",\"name\":\"Summary\"}"},
"description": "\n no content\n"
},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/add-field#",
"additionalProperties": false,
"title": "Add Field",
"type": "object",
"properties": {"fieldId": {"type": "string"}}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllFields",
"description": "Gets all fields for a given tab",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-screenable-tab#",
"title": "List of Screenable Tab",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"description": "\n a response containing all fields for given tab\n"
},
"400": {"description": "\n a response containing all fields for given tab\n"},
"401": {"description": "\n a response containing all fields for given tab\n"}
},
"parameters": [{
"in": "query",
"name": "projectKey",
"description": "\n the key of the project; this parameter is optional\n",
"type": "string"
}]
},
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
}
]
},
"api/2/application-properties": {"get": {
"produces": ["application/json"],
"operationId": "getProperty",
"description": "Returns an application property.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/property#",
"additionalProperties": false,
"title": "Property",
"type": "object",
"properties": {
"allowedValues": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"value": {"type": "string"},
"key": {"type": "string"},
"desc": {"type": "string"},
"example": {"type": "string"}
}
},
"examples": {"application/json": "\n [{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"JIRA\n home\n directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE\n -\",\"name\":\"The prefix added to the Summary field\n of cloned\n issues\",\"type\":\"string\",\"defaultValue\":\"CLONE\n -\"}]"},
"description": "\n an application property.\n"
},
"404": {"description": "\n an application property.\n"}
},
"parameters": [
{
"in": "query",
"name": "key",
"description": "\n a String containing the property key\n",
"type": "string"
},
{
"in": "query",
"name": "permissionLevel",
"description": "\n when fetching a list specifies the permission level of all items in the list\n see {@link com.atlassian.jira.bc.admin.ApplicationPropertiesService.EditPermissionLevel}\n",
"type": "string"
},
{
"in": "query",
"name": "keyFilter",
"description": "\n when fetching a list allows the list to be filtered by the property's start of key\n e.g. \"jira.lf.*\" whould fetch only those permissions that are editable and whose keys start with\n \"jira.lf.\". This is a regex.\n",
"type": "string"
}
]
}},
"api/2/worklog/list": {"post": {
"produces": ["application/json"],
"operationId": "getWorklogsForIds",
"description": "Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result.\n The returns set of worklogs is limited to 1000 elements.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-worklog#",
"title": "List of Worklog",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"started": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {
"format": "uri",
"type": "string"
},
"comment": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"comment\":\"I did some\n work\n here.\",\"updated\":\"2017-05-22T07:28:50.833+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2017-05-22T07:28:50.833+0000\",\"timeSpent\":\"3h\n 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}"},
"description": "\n a set of worklogs for given ids.\n"
},
"400": {"description": "\n a set of worklogs for given ids.\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-ids-request#",
"additionalProperties": false,
"title": "Worklog Ids Request",
"type": "object",
"properties": {"ids": {
"type": "array",
"items": {"type": "integer"}
}}
},
"in": "body",
"name": "worklogIdsRequest"
},
{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}
]
}},
"api/2/version": {"post": {
"produces": ["application/json"],
"operationId": "createVersion",
"description": "Create a version via POST.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/version#",
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"expand": {"type": "string"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
},
"examples": {"application/json": "{\"description\":\"An excellent\n version\",\"name\":\"New Version\n 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"userReleaseDate\":\"6/Jul/2010\",\"project\":\"PXA\",\"projectId\":10000}"}
},
"403": {},
"404": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/version#",
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {}
}
}
},
"name": {"type": "string"},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
},
"in": "body",
"name": "version"
}]
}},
"api/2/settings/baseUrl": {"put": {
"produces": ["application/json"],
"operationId": "setBaseURL",
"description": "Sets the base URL that is configured for this JIRA instance.",
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"in": "body"
}]
}},
"api/2/workflowscheme": {"post": {
"produces": ["application/json"],
"operationId": "createScheme",
"description": "Create a new workflow scheme.\n <p/>\n The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/workflow-scheme#",
"additionalProperties": false,
"title": "Workflow Scheme",
"type": "object",
"properties": {
"originalDefaultWorkflow": {"type": "string"},
"description": {"type": "string"},
"issueTypes": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}},
"additionalProperties": false,
"type": "object"
},
"originalIssueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"defaultWorkflow": {"type": "string"},
"updateDraftIfNeeded": {"type": "boolean"},
"draft": {"type": "boolean"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"lastModifiedUser": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"id": {"type": "integer"},
"lastModified": {"type": "string"},
"issueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}
}
},
"examples": {"application/json": "{\"id\":101010,\"name\":\"Workflow Scheme\n One\",\"description\":\"Workflow Scheme One\n Description\",\"defaultWorkflow\":\"DefaultWorkflowName\",\"issueTypeMappings\":{\"IsueTypeId2\":\"WorkflowName\",\"IsueTypeId\":\"WorkflowName\"},\"draft\":false,\"self\":\"http://www.example.com/jira/rest/api/2/workflowscheme/101010\"}"}
},
"401": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/workflow-scheme#",
"additionalProperties": false,
"title": "Workflow Scheme",
"type": "object",
"properties": {
"originalIssueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"defaultWorkflow": {"type": "string"},
"updateDraftIfNeeded": {"type": "boolean"},
"draft": {"type": "boolean"},
"name": {"type": "string"},
"originalDefaultWorkflow": {"type": "string"},
"description": {"type": "string"},
"lastModifiedUser": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"id": {"type": "integer"},
"lastModified": {"type": "string"},
"issueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"issueTypes": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}},
"additionalProperties": false,
"type": "object"
}
}
},
"in": "body"
}]
}},
"api/2/user": {
"post": {
"produces": ["application/json"],
"operationId": "createUser",
"description": "Create user. By default created user will not be notified with email.\n If password field is not set then password will be randomly generated.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie\",\"key\":\"charlie\",\"name\":\"charlie\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Charlie\n of Atlassian\"}"}
},
"400": {},
"401": {},
"500": {},
"403": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user-write#",
"additionalProperties": false,
"title": "User Write",
"type": "object",
"properties": {
"applicationKeys": {
"type": "array",
"items": {"type": "string"}
},
"notification": {"type": "string"},
"password": {"type": "string"},
"emailAddress": {"type": "string"},
"displayName": {"type": "string"},
"name": {"type": "string"},
"key": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getUser",
"description": "Returns a user. This resource cannot be accessed anonymously.\n <p>\n The resource accepts the <code>expand<\/code> param that is used to include, hidden by default, parts of response. This can be used to include:\n <ul>\n <li><code>groups<\/code> - all groups, including nested groups, to which user belongs<\/li>\n <li><code>applicationRoles<\/code> - application roles defines to which application user has access<\/li>\n <\/ul>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[{\"name\":\"jira-user\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-user\"},{\"name\":\"jira-admin\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin\"},{\"name\":\"important\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=important\"}]},\"applicationRoles\":{\"size\":1,\"items\":[]},\"expand\":\"groups,applicationRoles\"}"}
},
"401": {},
"404": {}
},
"parameters": [
{
"in": "query",
"name": "username",
"description": "\n the username\n",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "\n user key\n",
"type": "string"
}
]
},
"delete": {
"produces": ["application/json"],
"operationId": "removeUser",
"description": "Removes user.",
"responses": {
"400": {},
"401": {},
"204": {},
"403": {},
"404": {}
},
"parameters": [
{
"in": "query",
"name": "username",
"description": "\n the username\n",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "\n user key\n",
"type": "string"
}
]
},
"put": {
"produces": ["application/json"],
"operationId": "updateUser",
"description": "Modify user. The \"value\" fields present will override the existing value.\n Fields skipped in request will not be changed.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie\",\"key\":\"charlie\",\"name\":\"charlie\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Charlie\n of Atlassian\"}"},
"description": "\n a user\n"
},
"400": {"description": "\n a user\n"},
"401": {"description": "\n a user\n"},
"403": {"description": "\n a user\n"},
"404": {"description": "\n a user\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user-write#",
"additionalProperties": false,
"title": "User Write",
"type": "object",
"properties": {
"applicationKeys": {
"type": "array",
"items": {"type": "string"}
},
"notification": {"type": "string"},
"password": {"type": "string"},
"emailAddress": {"type": "string"},
"displayName": {"type": "string"},
"name": {"type": "string"},
"key": {"type": "string"}
}
},
"in": "body"
},
{
"in": "query",
"name": "username",
"description": "\n the username\n",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "\n user key\n",
"type": "string"
}
]
}
},
"api/2/configuration/timetracking": {
"get": {
"produces": ["application/json"],
"operationId": "getSelectedTimeTrackingImplementation",
"description": "Returns the currently selected time-tracking implementation",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/time-tracking-implementation#",
"additionalProperties": false,
"title": "Time Tracking Implementation",
"type": "object",
"properties": {
"name": {"type": "string"},
"key": {"type": "string"},
"url": {"type": "string"}
}
},
"examples": {"application/json": "{\"key\":\"JIRA\",\"name\":\"JIRA time\n tracking\",\"url\":\"/example/config/url\"}"}
},
"401": {},
"204": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/time-tracking-implementation#",
"additionalProperties": false,
"title": "Time Tracking Implementation",
"type": "object",
"properties": {
"name": {"type": "string"},
"key": {"type": "string"},
"url": {"type": "string"}
}
}},
"403": {}
}
},
"delete": {
"produces": ["application/json"],
"operationId": "disableTimeTracking",
"description": "Disables time tracking",
"responses": {
"401": {},
"204": {},
"403": {}
}
},
"put": {
"produces": ["application/json"],
"operationId": "selectTimeTrackingImplementation",
"description": "Selects a time tracking implementation",
"responses": {
"400": {},
"401": {},
"204": {},
"403": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/time-tracking-implementation#",
"additionalProperties": false,
"title": "Time Tracking Implementation",
"type": "object",
"properties": {
"name": {"type": "string"},
"key": {"type": "string"},
"url": {"type": "string"}
}
},
"in": "body"
}]
}
},
"api/2/screens/addToDefault/{fieldId}": {
"post": {
"produces": ["application/json"],
"operationId": "addFieldToDefaultScreen",
"description": "Adds field or custom field to the default tab",
"responses": {
"201": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
}
},
"parameters": [{
"in": "path",
"name": "fieldId",
"description": "\n id of field / custom field\n",
"type": "string",
"required": true
}]
},
"api/2/filter": {"post": {
"produces": ["application/json"],
"operationId": "createFilter",
"description": "Creates a new filter, and returns newly created filter.\n Currently sets permissions just using the users default sharing permissions",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/filter#",
"additionalProperties": false,
"title": "Filter",
"type": "object",
"properties": {
"owner": {"$ref": "#/definitions/user"},
"sharedUsers": {
"additionalProperties": false,
"title": "User Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/user"}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"subscriptions": {
"additionalProperties": false,
"title": "Filter Subscription Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Subscription",
"type": "object",
"properties": {
"id": {"type": "integer"},
"user": {"$ref": "#/definitions/user"},
"group": {"$ref": "#/definitions/group"}
}
}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"jql": {"type": "string"},
"name": {"type": "string"},
"viewUrl": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"searchUrl": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"sharePermissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Permission",
"type": "object",
"properties": {
"role": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"project": {
"additionalProperties": false,
"title": "Project",
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"realAssignee": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"}
},
"required": ["isAssigneeTypeValid"]
}
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"roles": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"description": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"url": {"type": "string"},
"issueTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"expand": {"type": "string"},
"versions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"expand": {"type": "string"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
}
},
"projectCategory": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectKeys": {
"type": "array",
"items": {"type": "string"}
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"email": {"type": "string"}
}
},
"id": {"type": "integer"},
"type": {"type": "string"},
"group": {"$ref": "#/definitions/group"}
}
}
},
"favourite": {"type": "boolean"}
},
"required": ["favourite"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/filter/10000\",\"id\":\"10000\",\"name\":\"All\n Open Bugs\",\"description\":\"Lists all open\n bugs\",\"owner\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F. User\",\"active\":false},\"jql\":\"type = Bug and\n resolution is\n empty\",\"viewUrl\":\"http://www.example.com/jira/issues/?filter=10000\",\"searchUrl\":\"http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"},
"description": "\n a {@link FilterBean}\n"
},
"400": {"description": "\n a {@link FilterBean}\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/filter#",
"additionalProperties": false,
"title": "Filter",
"type": "object",
"properties": {
"owner": {"$ref": "#/definitions/user"},
"sharedUsers": {
"additionalProperties": false,
"title": "User Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/user"}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"subscriptions": {
"additionalProperties": false,
"title": "Filter Subscription Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Subscription",
"type": "object",
"properties": {
"id": {"type": "integer"},
"user": {"$ref": "#/definitions/user"},
"group": {"$ref": "#/definitions/group"}
}
}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"jql": {"type": "string"},
"name": {"type": "string"},
"viewUrl": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"searchUrl": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"sharePermissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Permission",
"type": "object",
"properties": {
"role": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"project": {
"additionalProperties": false,
"title": "Project",
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"realAssignee": {"$ref": "#/definitions/user"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"},
"lead": {"$ref": "#/definitions/user"}
},
"required": ["isAssigneeTypeValid"]
}
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"roles": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"description": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"url": {"type": "string"},
"issueTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"versions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {}
}
}
},
"name": {"type": "string"},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
}
},
"projectCategory": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"name": {"type": "string"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectKeys": {
"type": "array",
"items": {"type": "string"}
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"email": {"type": "string"}
}
},
"id": {"type": "integer"},
"type": {"type": "string"},
"group": {"$ref": "#/definitions/group"}
}
}
},
"favourite": {"type": "boolean"}
},
"required": ["favourite"]
},
"in": "body",
"name": "filter"
},
{
"in": "query",
"name": "expand",
"description": "\n the parameters to expand\n",
"type": "string"
}
]
}},
"api/2/project/{projectIdOrKey}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the project identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectIdOrKey",
"description": "\n the project from which keys will be returned.\n",
"type": "string",
"required": true
}]
},
"api/2/issue": {"post": {
"produces": ["application/json"],
"operationId": "createIssue",
"description": "Creates an issue or a sub-task from a JSON representation.\n <p/>\n The fields that can be set on create, in either the fields parameter or the update parameter can be determined\n using the <b>/rest/api/2/issue/createmeta<\/b> resource.\n If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field\n validation error will occur if it is submitted.\n <p/>\n Creating a sub-task is similar to creating a regular issue, with two important differences:\n <ul>\n <li>the <code>issueType<\/code> field must correspond to a sub-task issue type (you can use\n <code>/issue/createmeta<\/code> to discover sub-task issue types), and<\/li>\n <li>you must provide a <code>parent<\/code> field in the issue create request containing the id or key of the\n parent issue.<\/li>\n <\/ul>\n\n The <code>updateHistory<\/code> param adds the project that this issue is created in, to the current user's project history,\n if set to true (by default, the project history is not updated).\n You can view the project history in the JIRA application, via the Projects dropdown.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-create-response#",
"additionalProperties": false,
"title": "Issue Create Response",
"type": "object",
"properties": {
"self": {"type": "string"},
"id": {"type": "string"},
"key": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"id\":\"10000\",\"key\":\"TST-24\",\"self\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}"},
"description": "\n an com.atlassian.jira.rest.api.issue.IssueCreateResponse\n"
},
"400": {
"examples": {"application/json": "{\"errorMessages\":[\"Field 'priority' is\n required\"],\"errors\":{}}"},
"description": "\n an com.atlassian.jira.rest.api.issue.IssueCreateResponse\n"
}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-update#",
"additionalProperties": false,
"title": "Issue Update",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"update": {
"patternProperties": {".+": {
"type": "array",
"items": {
"title": "Field Operation",
"type": "object"
}
}},
"additionalProperties": false,
"type": "object"
},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"transition": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"hasScreen": {"type": "boolean"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Field Meta",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"hasDefaultValue": {"type": "boolean"},
"allowedValues": {
"type": "array",
"items": {}
},
"operations": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {},
"name": {"type": "string"},
"autoCompleteUrl": {"type": "string"},
"required": {"type": "boolean"},
"key": {"type": "string"}
},
"required": ["required"]
}},
"additionalProperties": false,
"type": "object"
}
}
},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"in": "body"
},
{
"in": "query",
"name": "updateHistory",
"description": "\n if true then the user's project history is updated\n",
"type": "boolean"
}
]
}},
"api/2/auditing/record": {"get": {
"produces": ["application/json"],
"operationId": "getRecords",
"description": "Returns auditing records filtered using provided parameters",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/audit-record#",
"additionalProperties": false,
"title": "Audit Record",
"type": "object",
"properties": {
"summary": {"type": "string"},
"changedValues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Changed Value",
"type": "object",
"properties": {
"changedTo": {"type": "string"},
"fieldName": {"type": "string"},
"changedFrom": {"type": "string"}
}
}
},
"objectItem": {"$ref": "#/definitions/associated-item"},
"created": {"type": "string"},
"authorKey": {"type": "string"},
"eventSource": {"type": "string"},
"description": {"type": "string"},
"associatedItems": {
"type": "array",
"items": {"$ref": "#/definitions/associated-item"}
},
"id": {"type": "integer"},
"category": {"type": "string"},
"remoteAddress": {"type": "string"}
}
},
"examples": {"application/json": "{\"id\":1,\"summary\":\"User\n created\",\"remoteAddress\":\"192.168.1.1\",\"authorKey\":\"administrator\",\"created\":\"2014-03-19T18:45:42.967+0000\",\"category\":\"user\n management\",\"eventSource\":\"JIRA Connect\n Plugin\",\"description\":\"Optional\n description\",\"objectItem\":{\"id\":\"user\",\"name\":\"user\",\"typeName\":\"USER\",\"parentId\":\"1\",\"parentName\":\"JIRA\n Internal\n Directory\"},\"changedValues\":[{\"fieldName\":\"email\",\"changedFrom\":\"[email protected]\",\"changedTo\":\"[email protected]\"}],\"associatedItems\":[{\"id\":\"jira-software-users\",\"name\":\"jira-software-users\",\"typeName\":\"GROUP\",\"parentId\":\"1\",\"parentName\":\"JIRA\n Internal Directory\"}]}"},
"description": "\n auditing records with all associated objects\n"
},
"400": {"description": "\n auditing records with all associated objects\n"},
"403": {"description": "\n auditing records with all associated objects\n"}
},
"parameters": [
{
"in": "query",
"name": "offset",
"description": "\n - the number of record from which search starts\n",
"type": "integer"
},
{
"in": "query",
"name": "limit",
"description": "\n - maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000)\n",
"type": "integer"
},
{
"in": "query",
"name": "filter",
"description": "\n - text query; each record that will be returned must contain the provided text in one of its fields\n",
"type": "string"
},
{
"in": "query",
"name": "from",
"description": "\n - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty\n only records that where created in the same moment or after the 'from' timestamp will be provided in response\n",
"type": "string"
},
{
"in": "query",
"name": "to",
"description": "\n - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty\n only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response\n",
"type": "string"
}
]
}},
"auth/1/session": {
"post": {
"produces": ["application/json"],
"operationId": "login",
"description": "Creates a new session for a user in JIRA. Once a session has been successfully created it can be used to access\n any of JIRA's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.\n <p>\n Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource\n may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user).",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/auth-success#",
"additionalProperties": false,
"title": "Auth Success",
"type": "object",
"properties": {
"session": {
"additionalProperties": false,
"title": "Session Info",
"type": "object",
"properties": {
"name": {"type": "string"},
"value": {"type": "string"}
}
},
"loginInfo": {
"additionalProperties": false,
"title": "Login Info",
"type": "object",
"properties": {
"failedLoginCount": {"type": "integer"},
"lastFailedLoginTime": {"type": "string"},
"loginCount": {"type": "integer"},
"previousLoginTime": {"type": "string"}
}
}
}
},
"examples": {"application/json": "\n {\"session\":{\"name\":\"seraph.rememberme.cookie\",\"value\":\"12345678901234567890\"}}"},
"description": "\n an AuthSuccess entity\n"
},
"401": {"description": "\n an AuthSuccess entity\n"},
"403": {"description": "\n an AuthSuccess entity\n"},
"409": {"description": "\n an AuthSuccess entity\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/auth-params#",
"additionalProperties": false,
"title": "Auth Params",
"type": "object",
"properties": {
"password": {"type": "string"},
"username": {"type": "string"}
}
},
"in": "body",
"name": "session"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "currentUser",
"description": "Returns information about the currently authenticated user. If the caller is not authenticated they will get a\n 401 Unauthorized status code.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/current-user#",
"additionalProperties": false,
"title": "Current User",
"type": "object",
"properties": {
"loginInfo": {
"additionalProperties": false,
"title": "Login Info",
"type": "object",
"properties": {
"failedLoginCount": {"type": "integer"},
"lastFailedLoginTime": {"type": "string"},
"loginCount": {"type": "integer"},
"previousLoginTime": {"type": "string"}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2.0/user/fred\",\"name\":\"fred\"}"},
"description": "\n JSON containing information about the current user\n"
},
"401": {"description": "\n JSON containing information about the current user\n"}
}
},
"delete": {
"produces": ["application/json"],
"operationId": "logout",
"description": "Logs the current user out of JIRA, destroying the existing session, if any.",
"responses": {
"401": {"description": "\n 401 if the called is not authenticated. NO_CONTENT if the successful.\n"},
"204": {"description": "\n 401 if the called is not authenticated. NO_CONTENT if the successful.\n"}
}
}
},
"api/2/attachment/{id}/expand/raw": {
"get": {
"produces": ["application/json"],
"operationId": "expandForMachines",
"description": "Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment-archive-impl#",
"additionalProperties": false,
"title": "Attachment Archive Impl",
"type": "object",
"properties": {
"totalEntryCount": {"type": "integer"},
"entries": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Attachment Archive Entry",
"type": "object",
"properties": {
"entryIndex": {"type": "integer"},
"size": {"type": "integer"},
"name": {"type": "string"},
"mediaType": {"type": "string"},
"abbreviatedName": {"type": "string"}
},
"required": [
"entryIndex",
"size"
]
}
}
},
"required": ["totalEntryCount"]
},
"examples": {"application/json": "\n {\"entries\":[{\"entryIndex\":0,\"name\":\"Allegro\n from Duet in C\n Major.mp3\",\"size\":1430174,\"mediaType\":\"audio/mpeg\"},{\"entryIndex\":1,\"name\":\"lrm.rtf\",\"size\":331,\"mediaType\":\"text/rtf\"}],\"totalEntryCount\":24}"},
"description": "\n A response\n"
},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"},
"409": {"description": "\n A response\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n the id of the attachment to expand.\n",
"type": "string",
"required": true
}]
},
"api/2/licenseValidator": {"post": {
"produces": ["application/json"],
"operationId": "validate",
"responses": {"": {}},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"in": "body"
}]
}},
"api/2/issue/{issueIdOrKey}/comment": {
"post": {
"produces": ["application/json"],
"operationId": "addComment",
"description": "Adds a new comment to an issue.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment#",
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {"type": "string"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"body\":\"Lorem ipsum\n dolor sit amet, consectetur adipiscing elit.\n Pellentesque eget venenatis elit. Duis eu justo\n eget augue iaculis fermentum. Sed semper quam\n laoreet nisi egestas at posuere augue\n semper.\",\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:49.752+0000\",\"updated\":\"2017-05-22T07:28:49.752+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}"},
"description": "\n the added comment\n"
},
"400": {"description": "\n the added comment\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment#",
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"in": "body"
},
{
"in": "query",
"name": "expand",
"description": "\n optional flags: renderedBody (provides body rendered in HTML)\n",
"type": "string"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getComments",
"description": "Returns all comments for an issue.\n <p>\n Results can be ordered by the \"created\" field which means the date a comment was added.\n <\/p>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comments-with-pagination#",
"additionalProperties": false,
"title": "Comments With Pagination",
"type": "object",
"properties": {
"total": {"type": "integer"},
"comments": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {"type": "string"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"maxResults": {"type": "integer"},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"startAt\":0,\"maxResults\":1,\"total\":1,\"comments\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"body\":\"Lorem ipsum\n dolor sit amet, consectetur adipiscing elit.\n Pellentesque eget venenatis elit. Duis eu justo\n eget augue iaculis fermentum. Sed semper quam\n laoreet nisi egestas at posuere augue\n semper.\",\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:49.752+0000\",\"updated\":\"2017-05-22T07:28:49.752+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}]}"},
"description": "\n all comments for the issue\n"
},
"404": {"description": "\n all comments for the issue\n"}
},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n the page offset, if not specified then defaults to 0\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n how many results on the page should be included. Defaults to 50.\n",
"type": "integer"
},
{
"in": "query",
"name": "orderBy",
"description": "\n ordering of the results.\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n optional flags: renderedBody (provides body rendered in HTML)\n",
"type": "string"
}
]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n to get comments for\n",
"type": "string",
"required": true
}]
},
"api/2/projectCategory": {
"post": {
"produces": ["application/json"],
"operationId": "createProjectCategory",
"description": "Create a project category via POST.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-category#",
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10100\",\"id\":\"10100\",\"name\":\"CREATED\",\"description\":\"Created\n Project Category\"}"}
},
"401": {},
"403": {},
"409": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-category#",
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllProjectCategories",
"description": "Returns all project categories",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-project-category#",
"title": "List of Project Category",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First\n Project\n Category\"},{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10001\",\"id\":\"10001\",\"name\":\"SECOND\",\"description\":\"Second\n Project Category\"}]"},
"description": "\n all project categories\n"
},
"500": {"description": "\n all project categories\n"}
}
}
},
"api/2/statuscategory": {"get": {
"produces": ["application/json"],
"operationId": "getStatusCategories",
"description": "Returns a list of all status categories",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-status-category#",
"title": "List of Status Category",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In\n Progress\"},{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}]"},
"description": "\n a full representation of the StatusCategory\n"
},
"404": {"description": "\n a full representation of the StatusCategory\n"}
}
}},
"api/2/workflow": {"get": {
"produces": ["application/json"],
"operationId": "getAllWorkflows",
"description": "Returns all workflows.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/workflow#",
"additionalProperties": false,
"title": "Workflow",
"type": "object",
"properties": {
"isDefault": {"type": "boolean"},
"lastModifiedDate": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"lastModifiedUser": {"type": "string"},
"steps": {"type": "integer"}
},
"required": ["isDefault"]
},
"description": "\n all workflows.\n"
},
"401": {"description": "\n all workflows.\n"}
},
"parameters": [{
"in": "query",
"name": "workflowName",
"description": "\n optional field where if it is set it will return the given workflow name.\n",
"type": "string"
}]
}},
"api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/move": {
"post": {
"produces": ["application/json"],
"operationId": "moveField",
"description": "Moves field on the given tab",
"responses": {
"201": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/move-field#",
"additionalProperties": false,
"title": "Move Field",
"type": "object",
"properties": {
"after": {
"format": "uri",
"type": "string"
},
"position": {
"type": "string",
"enum": [
"Earlier",
"Later",
"First",
"Last"
]
}
}
},
"in": "body"
}]
},
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "id",
"type": "string",
"required": true
}
]
},
"api/2/issue/{issueIdOrKey}/worklog/{worklogId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the worklog identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [
{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
},
{
"in": "path",
"name": "worklogId",
"description": "\n the worklog from which keys will be returned.\n",
"type": "string",
"required": true
}
]
},
"api/2/applicationrole": {"get": {
"produces": ["application/json"],
"operationId": "getAll",
"description": "Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the\n collection of ApplicationRoles.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-application-role#",
"title": "List of Application Role",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Application Role",
"type": "object",
"properties": {
"numberOfSeats": {"type": "integer"},
"userCount": {"type": "integer"},
"userCountDescription": {"type": "string"},
"defaultGroups": {
"type": "array",
"items": {"type": "string"}
},
"hasUnlimitedSeats": {"type": "boolean"},
"name": {"type": "string"},
"groups": {
"type": "array",
"items": {"type": "string"}
},
"remainingSeats": {"type": "integer"},
"key": {"type": "string"},
"selectedByDefault": {"type": "boolean"},
"defined": {"type": "boolean"},
"platform": {"type": "boolean"}
}
}
},
"examples": {"application/json": "\n [{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"name\":\"JIRA\n Software\",\"defaultGroups\":[\"jira-software-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5\n developers\",\"hasUnlimitedSeats\":false,\"platform\":false},{\"key\":\"jira-core\",\"groups\":[\"jira-core-users\"],\"name\":\"JIRA\n Core\",\"defaultGroups\":[\"jira-core-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":1,\"remainingSeats\":1,\"userCount\":0,\"userCountDescription\":\"0\n users\",\"hasUnlimitedSeats\":false,\"platform\":true}]"},
"description": "\n all ApplicationRoles in the system.\n"
},
"401": {"description": "\n all ApplicationRoles in the system.\n"},
"403": {"description": "\n all ApplicationRoles in the system.\n"}
}
}},
"api/2/issuesecurityschemes": {"get": {
"produces": ["application/json"],
"operationId": "getIssueSecuritySchemes",
"description": "Returns all issue security schemes that are defined.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-schemes#",
"additionalProperties": false,
"title": "Security Schemes",
"type": "object",
"properties": {"issueSecuritySchemes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Scheme",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"defaultSecurityLevelId": {"type": "integer"},
"id": {"type": "integer"},
"levels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
}
}
}
}}
},
"examples": {"application/json": "\n {\"issueSecuritySchemes\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issuesecurityschemes/1000\",\"id\":1000,\"name\":\"Default\n Issue Security Scheme\",\"description\":\"Description\n for the default issue security\n scheme\",\"defaultSecurityLevelId\":10021}]}"},
"description": "\n an object containing a collection of issue security schemes\n"
},
"401": {"description": "\n an object containing a collection of issue security schemes\n"},
"403": {"description": "\n an object containing a collection of issue security schemes\n"}
}
}},
"api/2/universal_avatar/type/{type}/owner/{entityId}": {
"post": {
"produces": ["application/json"],
"operationId": "storeAvatar",
"description": "Creates an avatar for a given entity, for the given entity ID and type of entity. For example, you can create an\n avatar for an issue type, given the issue type Id. Uploading an avatar is supported for different types of entities\n across the JIRA products. However, it is supported for the \"project\" and \"issuetype\" entity types for all JIRA products.\n The uploaded image will be cropped according to the crop parameters listed below. If no crop parameters are specified,\n the image will be cropped to a square. The square will originate at the top left of the image and the length of\n each side will be set to the smaller of the height or width of the image.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/avatar#",
"additionalProperties": false,
"title": "Avatar",
"type": "object",
"properties": {
"owner": {"type": "string"},
"isDeletable": {"type": "boolean"},
"urls": {
"patternProperties": {"\\d\\dx\\d\\d": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"isSystemAvatar": {"type": "boolean"},
"isSelected": {"type": "boolean"},
"id": {"type": "string"},
"selected": {"type": "boolean"}
},
"required": [
"isSystemAvatar",
"isSelected",
"isDeletable",
"selected"
]
},
"examples": {"application/json": "\n {\"id\":\"1000\",\"owner\":\"fred\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"http://localhost:8090/jira/secure/useravatar?size=xsmall&avatarId=10040\",\"24x24\":\"http://localhost:8090/jira/secure/useravatar?size=small&avatarId=10040\",\"32x32\":\"http://localhost:8090/jira/secure/useravatar?size=medium&avatarId=10040\",\"48x48\":\"http://localhost:8090/jira/secure/useravatar?avatarId=10040\"},\"selected\":false}"}
},
"400": {},
"401": {},
"403": {},
"404": {}
},
"parameters": [
{
"in": "query",
"name": "x",
"description": "\n (optional) The X coordinate of the top-left corner of the crop region. Default: 0.\n",
"type": "integer"
},
{
"in": "query",
"name": "y",
"description": "\n (optional) The Y coordinate of the top-left corner of the crop region. Default: 0.\n",
"type": "integer"
},
{
"in": "query",
"name": "size",
"description": "\n (optional) The length of each side of the crop region. The crop region can only be a square.\n If omitted and the top-left corner is at (0,0), this defaults to either the height or width\n of the image, whichever is smaller.\n",
"type": "integer"
}
]
},
"parameters": [
{
"in": "path",
"name": "entityId",
"description": "\n The Id of the entity that you want to update the avatar of.\n",
"type": "string",
"required": true
},
{
"in": "path",
"name": "type",
"description": "\n The type of the entity that you want to update the avatar of. Valid values: project, issuetype.\n",
"type": "string",
"required": true
}
]
},
"api/2/project/type": {"get": {
"produces": ["application/json"],
"operationId": "getAllProjectTypes",
"description": "Returns all the project types defined on the JIRA instance, not taking into account whether\n the license to use those project types is valid or not.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-project-type#",
"title": "List of Project Type",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Type",
"type": "object",
"properties": {
"descriptionI18nKey": {"type": "string"},
"color": {"type": "string"},
"icon": {"type": "string"},
"key": {"type": "string"},
"formattedKey": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"Project\n type for business\n projects\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"Project\n type for software\n projects\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]"},
"description": "\n All project types defined on the JIRA instance.\n"
}}
}},
"api/2/issue/{issueIdOrKey}/worklog": {
"post": {
"produces": ["application/json"],
"operationId": "addWorklog",
"description": "Adds a new worklog entry to an issue.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog#",
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"started": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {
"format": "uri",
"type": "string"
},
"comment": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"description": "\n the added worklog\n"
},
"400": {"description": "\n the added worklog\n"},
"403": {"description": "\n the added worklog\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog#",
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"comment": {"type": "string"},
"started": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"in": "body",
"name": "worklog"
},
{
"in": "query",
"name": "adjustEstimate",
"description": "\n (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are\n <ul>\n <li>\"new\" - sets the estimate to a specific value<\/li>\n <li>\"leave\"- leaves the estimate as is<\/li>\n <li>\"manual\" - specify a specific amount to increase remaining estimate by<\/li>\n <li>\"auto\"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog<\/li> <\/ul>\n",
"type": "string"
},
{
"in": "query",
"name": "newEstimate",
"description": "\n (required when \"new\" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. \"2d\"\n",
"type": "string"
},
{
"in": "query",
"name": "reduceBy",
"description": "\n (required when \"manual\" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. \"2d\"\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getIssueWorklog",
"description": "Returns all work logs for an issue. <br/>\n <strong>Note:<\/strong> Work logs won't be returned if the Log work field is hidden for the project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-with-pagination#",
"additionalProperties": false,
"title": "Worklog With Pagination",
"type": "object",
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"startAt": {"type": "integer"},
"worklogs": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"started": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {
"format": "uri",
"type": "string"
},
"comment": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
}
}
},
"examples": {"application/json": "\n {\"startAt\":0,\"maxResults\":1,\"total\":1,\"worklogs\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"comment\":\"I did some\n work\n here.\",\"updated\":\"2017-05-22T07:28:50.833+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2017-05-22T07:28:50.833+0000\",\"timeSpent\":\"3h\n 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]}"},
"description": "\n All worklogs for the issue\n"
},
"404": {"description": "\n All worklogs for the issue\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n a string containing the issue id or key the worklog will be added to\n",
"type": "string",
"required": true
}]
},
"api/2/issue/{issueIdOrKey}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the issue identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n the issue from which keys will be returned.\n",
"type": "string",
"required": true
}]
},
"api/2/dashboard": {"get": {
"produces": ["application/json"],
"operationId": "list",
"description": "Returns a list of all dashboards, optionally filtering them.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/dashboards#",
"additionalProperties": false,
"title": "Dashboards",
"type": "object",
"properties": {
"next": {"type": "string"},
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"prev": {"type": "string"},
"dashboards": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Dashboard",
"type": "object",
"properties": {
"view": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"}
}
}
},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"startAt\":10,\"maxResults\":10,\"total\":143,\"prev\":\"http://www.example.com/jira/rest/api/2/dashboard?startAt=0\",\"next\":\"http://www.example.com/jira/rest/api/2/dashboard?startAt=10\",\"dashboards\":[{\"id\":\"10000\",\"self\":\"http://www.example.com/jira/rest/api/2/dashboard/10000\",\"name\":\"System\n Dashboard\",\"view\":\"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=10000\"},{\"id\":\"20000\",\"self\":\"http://www.example.com/jira/rest/api/2/dashboard/20000\",\"name\":\"Build\n Engineering\",\"view\":\"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=20000\"}]}"},
"description": "\n a list of Dashboards\n"
}},
"parameters": [
{
"in": "query",
"name": "filter",
"description": "\n an optional filter that is applied to the list of dashboards. Valid values include\n <code>\"favourite\"<\/code> for returning only favourite dashboards, and <code>\"my\"<\/code> for returning\n dashboards that are owned by the calling user.\n",
"type": "string"
},
{
"in": "query",
"name": "startAt",
"description": "\n the index of the first dashboard to return (0-based). must be 0 or a multiple of\n <code>maxResults<\/code>\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n a hint as to the the maximum number of dashboards to return in each call. Note that the\n JIRA server reserves the right to impose a <code>maxResults<\/code> limit that is lower than the value that a\n client provides, dues to lack or resources or any other condition. When this happens, your results will be\n truncated. Callers should always check the returned <code>maxResults<\/code> to determine the value that is\n effectively being used.\n",
"type": "integer"
}
]
}},
"api/2/task/{taskId}/cancel": {
"post": {
"produces": ["application/json"],
"operationId": "requestCancel",
"description": "Requests that the task that corresponds to the given task id is cancelled.",
"responses": {
"202": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/response#",
"title": "Response",
"type": "object"
}},
"401": {},
"403": {},
"404": {}
}
},
"parameters": [{
"in": "path",
"name": "taskId",
"type": "string",
"required": true
}]
},
"api/2/search": {
"post": {
"produces": ["application/json"],
"operationId": "searchUsingSearchRequest",
"description": "Performs a search using JQL.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/search-results#",
"additionalProperties": false,
"title": "Search Results",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"warningMessages": {
"type": "array",
"items": {"type": "string"}
},
"expand": {"type": "string"},
"total": {"type": "integer"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"maxResults": {"type": "integer"},
"issues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"editmeta": {
"additionalProperties": false,
"title": "Edit Meta",
"type": "object",
"properties": {"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}}
},
"fieldsToInclude": {
"title": "Included Fields",
"type": "object"
},
"changelog": {
"additionalProperties": false,
"title": "Changelog",
"type": "object",
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"histories": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"transitions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"hasScreen": {"type": "boolean"},
"expand": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}
}
}
},
"renderedFields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"expand": {"type": "string"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"operations": {
"additionalProperties": false,
"title": "Opsbar",
"type": "object",
"properties": {"linkGroups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
}}
},
"versionedRepresentations": {
"patternProperties": {".+": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"key": {"type": "string"},
"properties": {
"additionalProperties": false,
"title": "Properties",
"type": "object",
"properties": {"properties": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10001\",\"self\":\"http://www.example.com/jira/rest/api/2/issue/10001\",\"key\":\"HSP-1\"}],\"warningMessages\":[\"The\n value 'splat' does not exist for the field\n 'Foo'.\"]}"},
"description": "\n a SearchResultsBean\n"
},
"400": {"description": "\n a SearchResultsBean\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/search-request#",
"additionalProperties": false,
"title": "Search Request",
"type": "object",
"properties": {
"jql": {"type": "string"},
"maxResults": {"type": "integer"},
"validateQuery": {"type": "string"},
"fieldsByKeys": {"type": "boolean"},
"fields": {
"type": "array",
"items": {"type": "string"}
},
"startAt": {"type": "integer"},
"properties": {
"type": "array",
"items": {"type": "string"}
}
},
"required": ["fieldsByKeys"]
},
"in": "body",
"name": "searchRequestBean"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "search",
"description": "Searches for issues using JQL.\n <p>\n <b>Sorting<\/b>:\n the <code>jql<\/code> parameter is a full <a href=\"http://confluence.atlassian.com/display/JIRA/Advanced+Searching\">JQL<\/a>\n expression which can include an <code>ORDER BY<\/code> clause.\n\n <p>\n <b>Fields<\/b>:\n The <code>fields<\/code> param (which can be specified multiple times) gives a comma-separated list of fields\n to include in the response. This can be used to retrieve a subset of fields.\n A particular field can be excluded by prefixing it with a minus.\n\n <p>\n By default, only navigable (<code>*navigable<\/code>) fields are returned in this search resource. Note: the default is different\n in the get-issue resource -- the default there all fields (<code>*all<\/code>).\n <ul>\n <li><code>*all<\/code> - include all fields<\/li>\n <li><code>*navigable<\/code> - include just navigable fields<\/li>\n <li><code>summary,comment<\/code> - include just the summary and comments<\/li>\n <li><code>-description<\/code> - include navigable fields except the description (the default is <code>*navigable<\/code> for search)<\/li>\n <li><code>*all,-comment<\/code> - include everything except comments<\/li>\n <\/ul>\n\n <p>\n <b>Properties<\/b>:\n The <code>properties<\/code> param is similar to <code>fields<\/code> and specifies a comma-separated list of issue\n properties to include. Unlike <code>fields<\/code>, properties are not included by default.\n It is also not allowed to request all properties.\n The number of different properties that may be requested in one query is limited to 5.\n\n <ul>\n <li><code>prop1,prop1<\/code> - include <code>prop1<\/code> and <code>prop2<\/code> properties <\/li>\n <\/ul>\n\n <p>\n\n <b>Query Validation<\/b>:\n The <code>validateQuery<\/code> param offers control over whether to validate and how strictly to treat the validation.\n <ul>\n <li><code>strict<\/code> - Strict validation: if any errors are found then a 400 will be returned with a list of all\n errors (and warnings).<\/li>\n <li><code>warn<\/code> - we validate, but all errors are demoted to warnings.<\/li>\n <li><code>none<\/code> - no validation is run.<\/li>\n <li><code>true<\/code> - <em>deprecated<\/em>. A legacy synonym for \"strict\".<\/li>\n <li><code>false<\/code> - <em>deprecated<\/em>. For legacy reasons this acts like \"warn\".<\/li>\n <\/ul>\n The default value is \"strict\". Note that this setting only effects semantic validation of the given JQL. If the JQL\n is syntactically invalid, we will not even be able to parse it and a 400 will be raised no matter what validateQuery value is given.\n\n\n <p><b>GET vs POST<\/b>:\n If the JQL query is too large to be encoded as a query param you should instead\n POST to this resource.\n\n <p>\n <b>Expanding Issues in the Search Result:<\/b>\n It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed\n in to this resources.\n\n <p>\n For instance, to expand the &quot;changelog&quot; for all the issues on the search result, it is neccesary to\n specify &quot;changelog&quot; as one of the values to expand.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/search-results#",
"additionalProperties": false,
"title": "Search Results",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"warningMessages": {
"type": "array",
"items": {"type": "string"}
},
"expand": {"type": "string"},
"total": {"type": "integer"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"maxResults": {"type": "integer"},
"issues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"editmeta": {
"additionalProperties": false,
"title": "Edit Meta",
"type": "object",
"properties": {"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}}
},
"fieldsToInclude": {
"title": "Included Fields",
"type": "object"
},
"changelog": {
"additionalProperties": false,
"title": "Changelog",
"type": "object",
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"histories": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"transitions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"hasScreen": {"type": "boolean"},
"expand": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}
}
}
},
"renderedFields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"expand": {"type": "string"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"operations": {
"additionalProperties": false,
"title": "Opsbar",
"type": "object",
"properties": {"linkGroups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
}}
},
"versionedRepresentations": {
"patternProperties": {".+": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"key": {"type": "string"},
"properties": {
"additionalProperties": false,
"title": "Properties",
"type": "object",
"properties": {"properties": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10001\",\"self\":\"http://www.example.com/jira/rest/api/2/issue/10001\",\"key\":\"HSP-1\"}],\"warningMessages\":[\"The\n value 'splat' does not exist for the field\n 'Foo'.\"]}"},
"description": "\n a SearchResultsBean\n"
},
"400": {"description": "\n a SearchResultsBean\n"}
},
"parameters": [
{
"in": "query",
"name": "jql",
"description": "\n a JQL query string\n",
"type": "string"
},
{
"in": "query",
"name": "startAt",
"description": "\n the index of the first issue to return (0-based)\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n the maximum number of issues to return (defaults to 50). The maximum allowable value is\n dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this\n number, your search results will be truncated.\n",
"type": "integer"
},
{
"in": "query",
"name": "validateQuery",
"description": "\n Whether to validate the JQL query and how strictly to treat the validation results.\n Supported values: \"strict\", \"warn\", \"none\" + legacy synonyms \"true\" and \"false\"\n",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "\n the list of fields to return for each issue. By default, all navigable fields are returned.\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n A comma-separated list of the parameters to expand.\n",
"type": "string"
},
{
"in": "query",
"name": "properties",
"description": "\n the list of properties to return for each issue. By default no properties are returned.\n",
"type": "string"
},
{
"in": "query",
"name": "fieldsByKeys",
"description": "\n if true then fields in issues will be referenced by keys instead of ids\n",
"type": "boolean"
}
]
}
},
"api/2/project/{projectKeyOrId}/issuesecuritylevelscheme": {
"get": {
"produces": ["application/json"],
"operationId": "getIssueSecurityScheme",
"description": "Returns the issue security scheme for project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-scheme#",
"additionalProperties": false,
"title": "Security Scheme",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"defaultSecurityLevelId": {"type": "integer"},
"id": {"type": "integer"},
"levels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issuesecurityschemes/1000\",\"id\":1000,\"name\":\"Default\n Issue Security Scheme\",\"description\":\"Description\n for the default issue security\n scheme\",\"defaultSecurityLevelId\":10021,\"levels\":[{\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only\n the reporter and internal staff can see this\n issue.\",\"name\":\"Reporter Only\"}]}"},
"description": "\n an object containing an issue security scheme.\n"
},
"401": {"description": "\n an object containing an issue security scheme.\n"},
"403": {"description": "\n an object containing an issue security scheme.\n"},
"404": {"description": "\n an object containing an issue security scheme.\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"type": "string",
"required": true
}]
},
"api/2/issuetype": {
"post": {
"produces": ["application/json"],
"operationId": "createIssueType",
"description": "Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue\n type scheme.",
"responses": {
"201": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-type#",
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}},
"400": {},
"401": {},
"403": {},
"409": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-type-create#",
"additionalProperties": false,
"title": "Issue Type Create",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"type": {
"type": "string",
"enum": [
"subtask",
"standard"
]
}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getIssueAllTypes",
"description": "Returns a list of all issue types visible to the user",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-issue-type#",
"title": "List of Issue Type",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"examples": {"application/json": "\n [{\"self\":\"http://localhost:8090/jira/rest/api/2.0/issueType/3\",\"id\":\"3\",\"description\":\"A\n task that needs to be\n done.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/issuetypes/task.png\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://localhost:8090/jira/rest/api/2.0/issueType/1\",\"id\":\"1\",\"description\":\"A\n problem with the\n software.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/issuetypes/bug.png\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002}]"},
"description": "\n a list of issue types\n"
}}
}
},
"api/2/screens/{screenId}/tabs/{tabId}": {
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
}
],
"delete": {
"produces": ["application/json"],
"operationId": "deleteTab",
"description": "Deletes tab to give screen",
"responses": {
"201": {"description": "\n A response containing no content\n"},
"400": {"description": "\n A response containing no content\n"},
"401": {"description": "\n A response containing no content\n"}
}
},
"put": {
"produces": ["application/json"],
"operationId": "renameTab",
"description": "Renames tab on given screen",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "{\"id\":10000,\"name\":\"Fields\n Tab\"}"},
"description": "\n a response containing renamed tab\n"
},
"400": {"description": "\n a response containing renamed tab\n"},
"401": {"description": "\n a response containing renamed tab\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"in": "body"
}]
}
},
"api/2/attachment/meta": {"get": {
"produces": ["application/json"],
"operationId": "getAttachmentMeta",
"description": "Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size\n allowed.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment-meta#",
"additionalProperties": false,
"title": "Attachment Meta",
"type": "object",
"properties": {
"uploadLimit": {"type": "integer"},
"enabled": {"type": "boolean"}
},
"required": ["enabled"]
},
"examples": {"application/json": "\n {\"enabled\":true,\"uploadLimit\":1000000}"},
"description": "\n a JSON representation of the enable attachment capabilities\n"
}}
}},
"api/2/field": {
"post": {
"produces": ["application/json"],
"operationId": "createCustomField",
"description": "Creates a custom field using a definition (object encapsulating custom field data)",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/field#",
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"examples": {"application/json": "{\"id\":\"customfield_10101\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}}"},
"description": "\n Response with information about created field\n"
},
"400": {"description": "\n Response with information about created field\n"},
"500": {"description": "\n Response with information about created field\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/custom-field-definition#",
"additionalProperties": false,
"title": "Custom Field Definition",
"type": "object",
"properties": {
"searcherKey": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"type": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getFields",
"description": "Returns a list of all fields, both System and Custom",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-field#",
"title": "List of Field",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
}
},
"examples": {"application/json": "\n [{\"id\":\"description\",\"name\":\"Description\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"description\"],\"schema\":{\"type\":\"string\",\"system\":\"description\"}},{\"id\":\"summary\",\"key\":\"summary\",\"name\":\"Summary\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"summary\"],\"schema\":{\"type\":\"string\",\"system\":\"summary\"}}]"},
"description": "\n a response containing all fields as short Field Meta Beans\n"
}}
}
},
"api/2/project/{projectKeyOrId}/notificationscheme": {
"get": {
"produces": ["application/json"],
"operationId": "getNotificationScheme",
"description": "Gets a notification scheme associated with the project.\n Follow the documentation of /notificationscheme/{id} resource for all details about returned value.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/notification-scheme#",
"additionalProperties": false,
"title": "Notification Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"},
"notificationSchemeEvents": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Notification Scheme Event",
"type": "object",
"properties": {
"event": {"$ref": "#/definitions/notification-event"},
"notifications": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/custom-field-value-notification"},
{"$ref": "#/definitions/email-notification"},
{"$ref": "#/definitions/group-notification"},
{"$ref": "#/definitions/project-role-notification"},
{"$ref": "#/definitions/role-notification"},
{"$ref": "#/definitions/user-notification"}
],
"title": "Notification",
"type": "object"
}
}
}
}
}
}
},
"examples": {"application/json": "\n {\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://example.com/jira/rest/api/2/notificationscheme/10010\",\"name\":\"notification\n scheme\n name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom\n event\",\"description\":\"Custom event which is\n published together with issue created\n event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}"},
"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"
},
"401": {"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"},
"403": {"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"},
"404": {"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"description": "\n key or id of the project\n",
"type": "string",
"required": true
}]
},
"api/2/role": {
"post": {
"produces": ["application/json"],
"operationId": "createProjectRole",
"description": "Creates a new ProjectRole to be available in JIRA.\n The created role does not have any default actors assigned.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-role#",
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\"}"},
"description": "\n Returns full details of the created role\n"
},
"400": {"description": "\n Returns full details of the created role\n"},
"401": {"description": "\n Returns full details of the created role\n"},
"403": {"description": "\n Returns full details of the created role\n"},
"409": {"description": "\n Returns full details of the created role\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/create-update-role-request#",
"additionalProperties": false,
"title": "Create Update Role Request",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getProjectRoles",
"description": "Get all the ProjectRoles available in JIRA. Currently this list is global.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-role#",
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\"}"},
"description": "\n Returns full details of the roles available in JIRA.\n"
},
"401": {"description": "\n Returns full details of the roles available in JIRA.\n"},
"403": {"description": "\n Returns full details of the roles available in JIRA.\n"}
}
}
},
"api/2//userProperties": {
"post": {
"produces": ["application/json"],
"operationId": "setProperty",
"responses": {"": {}},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/property#",
"additionalProperties": false,
"title": "Property",
"type": "object",
"properties": {
"value": {"type": "string"},
"key": {"type": "string"},
"status": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getProperty",
"responses": {"": {}},
"parameters": [{
"in": "query",
"name": "key",
"type": "string"
}]
},
"delete": {
"produces": ["application/json"],
"operationId": "deleteProperty",
"responses": {"": {}},
"parameters": [{
"in": "query",
"name": "key",
"type": "string"
}]
}
},
"api/2/attachment/{id}/expand/human": {
"get": {
"produces": ["application/json"],
"operationId": "expandForHumans",
"description": "Tries to expand an attachment. Output is human-readable and subject to change.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/human-readable-archive#",
"additionalProperties": false,
"title": "Human Readable Archive",
"type": "object",
"properties": {
"totalEntryCount": {"type": "integer"},
"entries": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Human Readable Archive Entry",
"type": "object",
"properties": {
"path": {"type": "string"},
"size": {"type": "string"},
"index": {"type": "integer"},
"mediaType": {"type": "string"},
"label": {"type": "string"}
},
"required": ["index"]
}
},
"name": {"type": "string"},
"mediaType": {"type": "string"},
"id": {"type": "integer"}
},
"required": [
"id",
"totalEntryCount"
]
},
"examples": {"application/json": "\n {\"id\":7237823,\"name\":\"images.zip\",\"entries\":[{\"path\":\"MG00N067.JPG\",\"index\":0,\"size\":\"119\n kB\",\"mediaType\":\"image/jpeg\",\"label\":\"MG00N067.JPG\"},{\"path\":\"Allegro\n from Duet in C\n Major.mp3\",\"index\":1,\"size\":\"1.36\n MB\",\"mediaType\":\"audio/mpeg\",\"label\":\"Allegro\n from Duet in C\n Major.mp3\"},{\"path\":\"long/path/thanks/to/lots/of/subdirectories/inside/making/it/quite/hard/to/reach/the/leaf.txt\",\"index\":2,\"size\":\"0.0\n k\",\"mediaType\":\"text/plain\",\"label\":\"long/path/thanks/to/.../reach/the/leaf.txt\"}],\"totalEntryCount\":39,\"mediaType\":\"application/zip\"}"},
"description": "\n A response\n"
},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"},
"409": {"description": "\n A response\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n the id of the attachment to expand.\n",
"type": "string",
"required": true
}]
},
"api/2/worklog/deleted": {"get": {
"produces": ["application/json"],
"operationId": "getIdsOfWorklogsDeletedSince",
"description": "Returns worklogs id and delete time of worklogs that was deleted since given time.\n The returns set of worklogs is limited to 1000 elements.\n This API will not return worklogs deleted during last minute.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-changed-since#",
"additionalProperties": false,
"title": "Worklog Changed Since",
"type": "object",
"properties": {
"nextPage": {
"format": "uri",
"type": "string"
},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog Change",
"type": "object",
"properties": {
"updatedTime": {"type": "integer"},
"worklogId": {"type": "integer"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"isLastPage": {"type": "boolean"},
"self": {
"format": "uri",
"type": "string"
},
"until": {"type": "integer"},
"since": {"type": "integer"}
},
"required": ["isLastPage"]
},
"examples": {"application/json": "\n {\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://www.example.com/jira/worklog/updated/updated/deleted?since=1438013671136&since=1438013693136&since=1438013671136\",\"nextPage\":\"http://www.example.com/jira/worklog/updated/updated/deleted/deleted?since=1438013671136&since=1438013693136&since=1438013671136&since=1438013693136\",\"lastPage\":true}"},
"description": "\n a set of worklogs id and delete time.\n"
}},
"parameters": [{
"in": "query",
"name": "since",
"description": "\n a date time in unix timestamp format since when deleted worklogs will be returned.\n",
"type": "integer"
}]
}},
"api/2/issueLink": {"post": {
"produces": ["application/json"],
"operationId": "linkIssues",
"description": "Creates an issue link between two issues.\n The user requires the link issue permission for the issue which will be linked to another issue.\n The specified link type in the request is used to create the link and will create a link from the first issue\n to the second issue using the outward description. It also create a link from the second issue to the first issue using the\n inward description of the issue link type.\n It will add the supplied comment to the first issue. The comment can have a restriction who can view it.\n If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment.\n The user who creates the issue link needs to belong to the specified group or have the specified role.",
"responses": {
"201": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"400": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"401": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"500": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"404": {"description": "\n a response indicating if the issue link was created successfully.\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/link-issue-request#",
"additionalProperties": false,
"title": "Link Issue Request",
"type": "object",
"properties": {
"outwardIssue": {"$ref": "#/definitions/issue-ref"},
"comment": {
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"inwardIssue": {"$ref": "#/definitions/issue-ref"},
"type": {
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"outward": {"type": "string"}
}
}
}
},
"in": "body"
}]
}},
"api/2/priority": {"get": {
"produces": ["application/json"],
"operationId": "getPriorities",
"description": "Returns a list of all issue priorities.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-priority#",
"title": "List of Priority",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Priority",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major\n loss of\n function.\",\"iconUrl\":\"http://www.example.com/jira/images/icons/priorities/major.png\",\"name\":\"Major\"},{\"self\":\"http://www.example.com/jira/rest/api/2/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very\n little\n impact.\",\"iconUrl\":\"http://www.example.com/jira/images/icons/priorities/trivial.png\",\"name\":\"Trivial\"}]"},
"description": "\n a list of Jira Priorities\n"
}}
}},
"api/2/group": {
"post": {
"produces": ["application/json"],
"operationId": "createGroup",
"description": "Creates a group by given group parameter\n <p>\n Returns REST representation for the requested group.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/group#",
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"users": {
"additionalProperties": false,
"title": "Paged List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
}
}
},
"examples": {"application/json": "\n {\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\",\"users\":{\"size\":1,\"items\":[{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false}],\"max-results\":50,\"start-index\":0,\"end-index\":0},\"expand\":\"users\"}"},
"description": "\n REST representation of a group\n"
},
"400": {"description": "\n REST representation of a group\n"},
"401": {"description": "\n REST representation of a group\n"},
"403": {"description": "\n REST representation of a group\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/add-group#",
"additionalProperties": false,
"title": "Add Group",
"type": "object",
"properties": {"name": {"type": "string"}}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getGroup",
"description": "Returns REST representation for the requested group. Allows to get list of active users belonging to the\n specified group and its subgroups if \"users\" expand option is provided. You can page through users list by using\n indexes in expand param. For example to get users from index 10 to index 15 use \"users[10:15]\" expand value. This\n will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.\n <p>\n This resource is deprecated, please use group/member API instead.",
"responses": {"": {}},
"parameters": [
{
"in": "query",
"name": "groupname",
"description": "\n A name of requested group.\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n List of fields to expand. Currently only available expand is \"users\".\n",
"type": "string"
}
]
},
"delete": {
"produces": ["application/json"],
"operationId": "removeGroup",
"description": "Deletes a group by given group parameter.\n <p>\n Returns no content",
"responses": {
"200": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"},
"403": {"description": "\n no content\n"},
"404": {"description": "\n no content\n"}
},
"parameters": [
{
"in": "query",
"name": "groupname",
"description": "\n (mandatory) The name of the group to delete.\n",
"type": "string"
},
{
"in": "query",
"name": "swapGroup",
"description": "\n If you delete a group and content is restricted to that group, the content will be hidden from all users. \n To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.\n",
"type": "string"
}
]
}
},
"api/2/component": {"post": {
"produces": ["application/json"],
"operationId": "createComponent",
"description": "Create a component via POST.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/component#",
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"realAssignee": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"}
},
"required": ["isAssigneeTypeValid"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/component/10000\",\"id\":\"10000\",\"name\":\"Component\n 1\",\"description\":\"This is a JIRA\n component\",\"lead\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}"}
},
"401": {},
"403": {},
"404": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/component#",
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"realAssignee": {"$ref": "#/definitions/user"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"},
"lead": {"$ref": "#/definitions/user"}
},
"required": ["isAssigneeTypeValid"]
},
"in": "body",
"name": "component"
}]
}},
"api/2/reindex/request": {"post": {
"produces": ["application/json"],
"operationId": "processRequests",
"description": "Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests\n that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through\n other REST calls.",
"responses": {"200": {
"schema": {
"type": "array",
"items": {"type": "integer"}
},
"description": "\n JSON array containing the IDs of the reindex requests that are being processed.\n"
}}
}},
"api/2/reindex": {
"post": {
"produces": ["application/json"],
"operationId": "reindex",
"description": "Kicks off a reindex. Need Admin permissions to perform this reindex.\n <p>\n Note that some versions of JIRA may no longer require manual reindexing.\n In this case, this resource will no-op: a 200 OK response code will returned along with \"progress details\" that\n indicate the work is complete (progress=100%). Subsequent GETs will return 404 to indicate no actua reindex has\n taken place.\n <p>\n In the case that an index is actually triggered, this call will be asynchronous: it will return 202 immediately\n and then the caller can call GET on the resource to track progress of the task.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/reindex#",
"additionalProperties": false,
"title": "Reindex",
"type": "object",
"properties": {
"currentProgress": {"type": "integer"},
"currentSubTask": {"type": "string"},
"finishTime": {"type": "string"},
"progressUrl": {"type": "string"},
"submittedTime": {"type": "string"},
"success": {"type": "boolean"},
"startTime": {"type": "string"},
"type": {
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND",
"BACKGROUND_PREFFERED",
"BACKGROUND_PREFERRED"
]
}
},
"required": ["success"]
},
"examples": {"application/json": "\n {\"progressUrl\":\"/secure/admin/jira/IndexProgress.jspa?taskId=10000\",\"currentProgress\":50,\"currentSubTask\":\"Currently\n reindexing Change\n History\",\"type\":\"FOREGROUND\",\"submittedTime\":\"2017-05-22T07:28:49.664+0000\",\"startTime\":\"2017-05-22T07:28:49.664+0000\",\"finishTime\":\"2017-05-22T07:28:49.664+0000\",\"success\":false}"},
"description": "\n Response that provides a redirect to the GET.\n"
},
"202": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/reindex#",
"additionalProperties": false,
"title": "Reindex",
"type": "object",
"properties": {
"currentProgress": {"type": "integer"},
"currentSubTask": {"type": "string"},
"finishTime": {"type": "string"},
"progressUrl": {"type": "string"},
"submittedTime": {"type": "string"},
"success": {"type": "boolean"},
"startTime": {"type": "string"},
"type": {
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND",
"BACKGROUND_PREFFERED",
"BACKGROUND_PREFERRED"
]
}
},
"required": ["success"]
},
"examples": {"application/json": "\n {\"progressUrl\":\"/secure/admin/jira/IndexProgress.jspa?taskId=10000\",\"currentProgress\":50,\"currentSubTask\":\"Currently\n reindexing Change\n History\",\"type\":\"FOREGROUND\",\"submittedTime\":\"2017-05-22T07:28:49.664+0000\",\"startTime\":\"2017-05-22T07:28:49.664+0000\",\"finishTime\":\"2017-05-22T07:28:49.664+0000\",\"success\":false}"},
"description": "\n Response that provides a redirect to the GET.\n"
}
},
"parameters": [
{
"in": "query",
"name": "type",
"description": "\n Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED.\n",
"type": "string"
},
{
"in": "query",
"name": "indexComments",
"description": "\n Indicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed.\n",
"type": "boolean"
},
{
"in": "query",
"name": "indexChangeHistory",
"description": "\n Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.\n",
"type": "boolean"
},
{
"in": "query",
"name": "indexWorklogs",
"description": "\n Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.\n",
"type": "boolean"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getReindexInfo",
"description": "Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.\n If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404\n indicating that no reindex has taken place.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/reindex#",
"additionalProperties": false,
"title": "Reindex",
"type": "object",
"properties": {
"currentProgress": {"type": "integer"},
"currentSubTask": {"type": "string"},
"finishTime": {"type": "string"},
"progressUrl": {"type": "string"},
"submittedTime": {"type": "string"},
"success": {"type": "boolean"},
"startTime": {"type": "string"},
"type": {
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND",
"BACKGROUND_PREFFERED",
"BACKGROUND_PREFERRED"
]
}
},
"required": ["success"]
},
"examples": {"application/json": "\n {\"progressUrl\":\"/secure/admin/jira/IndexProgress.jspa?taskId=10000\",\"currentProgress\":50,\"currentSubTask\":\"Currently\n reindexing Change\n History\",\"type\":\"FOREGROUND\",\"submittedTime\":\"2017-05-22T07:28:49.664+0000\",\"startTime\":\"2017-05-22T07:28:49.664+0000\",\"finishTime\":\"2017-05-22T07:28:49.664+0000\",\"success\":false}"}
},
"404": {}
},
"parameters": [{
"in": "query",
"name": "taskId",
"description": "\n the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and\n returns information on the active reindex task, or the last task to run if no reindex is taking place. . If there is no\n reindexing task with that id then a 404 is returned.\n",
"type": "integer"
}]
}
},
"api/2/permissions": {"get": {
"produces": ["application/json"],
"operationId": "getAllPermissions",
"description": "Returns all permissions that are present in the JIRA instance - Global, Project and the global ones added by plugins",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permissions#",
"additionalProperties": false,
"title": "Permissions",
"type": "object",
"properties": {"permissions": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Permission",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"type": {
"type": "string",
"enum": [
"GLOBAL",
"PROJECT"
]
},
"key": {"type": "string"}
}
}},
"additionalProperties": false,
"type": "object"
}}
},
"examples": {"application/json": "\n {\"permissions\":{\"BULK_CHANGE\":{\"key\":\"BULK_CHANGE\",\"name\":\"Bulk\n Change\",\"type\":\"GLOBAL\",\"description\":\"Ability\n to modify a collection of issues at once. For\n example, resolve multiple issues in one\n step.\"}}}"},
"description": "\n all permissions\n"
},
"401": {"description": "\n all permissions\n"},
"403": {"description": "\n all permissions\n"}
}
}},
"api/2/status": {"get": {
"produces": ["application/json"],
"operationId": "getStatuses",
"description": "Returns a list of all statuses",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-status#",
"title": "List of Status",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://localhost:8090/jira/rest/api/2.0/status/10000\",\"description\":\"The\n issue is currently being worked\n on.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/progress.gif\",\"name\":\"In\n Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In\n Progress\"}},{\"self\":\"http://localhost:8090/jira/rest/api/2.0/status/5\",\"description\":\"The\n issue is\n closed.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}}]"},
"description": "\n a full representation of the Status\n"
},
"404": {"description": "\n a full representation of the Status\n"}
}
}},
"api/2/customFieldOption/{id}": {
"get": {
"produces": ["application/json"],
"operationId": "getCustomFieldOption",
"description": "Returns a full representation of the Custom Field Option that has the given id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/custom-field-option#",
"additionalProperties": false,
"title": "Custom Field Option",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"value": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://localhost:8090/jira/rest/api/2.0/customFieldOption/3\",\"value\":\"Blue\"}"},
"description": "\n a full representation of the Custom Field Option with the given id\n"
},
"404": {"description": "\n a full representation of the Custom Field Option with the given id\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n a String containing an Custom Field Option id\n",
"type": "string",
"required": true
}]
},
"api/2/screens/{screenId}/tabs": {
"post": {
"produces": ["application/json"],
"operationId": "addTab",
"description": "Creates tab for given screen",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "{\"id\":10000,\"name\":\"Fields\n Tab\"}"},
"description": "\n a response containing newly created tab\n"
},
"400": {"description": "\n a response containing newly created tab\n"},
"401": {"description": "\n a response containing newly created tab\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllTabs",
"description": "Returns a list of all tabs for the given screen",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-screenable-tab#",
"title": "List of Screenable Tab",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"description": "\n a response containing all tabs for screen\n"
},
"400": {"description": "\n a response containing all tabs for screen\n"},
"401": {"description": "\n a response containing all tabs for screen\n"}
},
"parameters": [{
"in": "query",
"name": "projectKey",
"description": "\n the key of the project; this parameter is optional\n",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
}]
},
"api/2/resolution": {"get": {
"produces": ["application/json"],
"operationId": "getResolutions",
"description": "Returns a list of all resolutions.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-resolution#",
"title": "List of Resolution",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Resolution",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/resolution/1\",\"description\":\"A\n fix for this issue is checked into the tree and\n tested.\",\"iconUrl\":\"http://www.example.com/jira/images/icons/statuses/resolved.png\",\"name\":\"Fixed\"},{\"self\":\"http://www.example.com/jira/rest/api/2/resolution/3\",\"description\":\"This\n is what it is supposed to do.\",\"name\":\"Works as\n designed\"}]"},
"description": "\n a list of JIRA issue resolutions\n"
}}
}},
"api/2/attachment/{id}": {
"get": {
"produces": ["application/json"],
"operationId": "getAttachment",
"description": "Returns the meta-data for an attachment, including the URI of the actual attached file.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment#",
"additionalProperties": false,
"title": "Attachment",
"type": "object",
"properties": {
"thumbnail": {"type": "string"},
"filename": {"type": "string"},
"size": {"type": "integer"},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"created": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "integer"},
"mimeType": {"type": "string"},
"properties": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"content": {"type": "string"}
},
"required": [
"id",
"size"
]
},
"examples": {"application/json": "\n {\"id\":10001,\"self\":\"http://www.example.com/jira/rest/api/2.0/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:50.772+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"http://www.example.com/jira/attachments/10000\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10000\"}"},
"description": "\n A response\n"
},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n id of the attachment to remove\n",
"type": "string",
"required": true
}],
"delete": {
"produces": ["application/json"],
"operationId": "removeAttachment",
"description": "Remove an attachment from an issue.",
"responses": {
"204": {"description": "\n A response\n"},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"}
}
}
},
"api/2/myself": {"get": {
"produces": ["application/json"],
"operationId": "getUser",
"description": "Returns currently logged user. This resource cannot be accessed anonymously.\n <p>\n The resource accepts the <code>expand<\/code> param that is used to include, hidden by default, parts of response. This can be used to include:\n <ul>\n <li><code>groups<\/code> - all groups, including nested groups, to which user belongs<\/li>\n <li><code>applicationRoles<\/code> - application roles defines to which application user has access<\/li>\n <\/ul>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[{\"name\":\"jira-user\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-user\"},{\"name\":\"jira-admin\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin\"},{\"name\":\"important\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=important\"}]},\"applicationRoles\":{\"size\":1,\"items\":[]},\"expand\":\"groups,applicationRoles\"}"}
},
"401": {}
}
}},
"api/2/project/{projectIdOrKey}/role": {
"get": {
"produces": ["application/json"],
"operationId": "getProjectRoles",
"description": "Returns all roles in the given project Id or key, with links to full details on each role.",
"responses": {
"200": {
"schema": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"examples": {"application/json": "\n {\"Administrators\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10002\",\"Users\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10001\",\"Developers\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10000\"}"},
"description": "\n list of roles and URIs to full details\n"
},
"404": {"description": "\n list of roles and URIs to full details\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectIdOrKey",
"description": "\n the project id or project key\n",
"type": "string",
"required": true
}]
},
"api/2/comment/{commentId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the comment identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [{
"in": "path",
"name": "commentId",
"description": "\n the comment from which keys will be returned.\n",
"type": "string",
"required": true
}]
},
"api/2/notificationscheme": {"get": {
"produces": ["application/json"],
"operationId": "getNotificationSchemes",
"description": "Returns a <a href=\"#pagination\">paginated<\/a> list of notification schemes. In order to access notification scheme, the calling user is\n required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains\n a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response.\n The list is ordered by the scheme's name.\n Follow the documentation of /notificationscheme/{id} resource for all details about returned value.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/page-of-notification-scheme#",
"additionalProperties": false,
"title": "Page of Notification Scheme",
"type": "object",
"properties": {
"total": {"type": "integer"},
"isLast": {"type": "boolean"},
"nextPage": {
"format": "uri",
"type": "string"
},
"maxResults": {"type": "integer"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Notification Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"},
"notificationSchemeEvents": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Notification Scheme Event",
"type": "object",
"properties": {
"event": {"$ref": "#/definitions/notification-event"},
"notifications": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/custom-field-value-notification"},
{"$ref": "#/definitions/email-notification"},
{"$ref": "#/definitions/group-notification"},
{"$ref": "#/definitions/project-role-notification"},
{"$ref": "#/definitions/role-notification"},
{"$ref": "#/definitions/user-notification"}
],
"title": "Notification",
"type": "object"
}
}
}
}
}
}
}
},
"self": {
"format": "uri",
"type": "string"
},
"startAt": {"type": "integer"}
},
"required": [
"maxResults",
"startAt"
]
},
"examples": {"application/json": "\n {\"maxResults\":6,\"startAt\":1,\"total\":5,\"isLast\":false,\"values\":[{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://example.com/jira/rest/api/2/notificationscheme/10010\",\"name\":\"notification\n scheme\n name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom\n event\",\"description\":\"Custom event which is\n published together with issue created\n event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}]}"},
"description": "\n a paginated list of notification schemes to which the calling user has permissions.\n"
}},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n the index of the first notification scheme to return (0 based).\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n the maximum number of notification schemes to return (max 50).\n",
"type": "integer"
},
{
"in": "query",
"name": "expand",
"type": "string"
}
]
}},
"api/2/avatar/{type}/system": {
"get": {
"produces": ["application/json"],
"operationId": "getAllSystemAvatars",
"description": "Returns all system avatars of the given type.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/system-avatars#",
"additionalProperties": false,
"title": "System Avatars",
"type": "object",
"properties": {"system": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Avatar",
"type": "object",
"properties": {
"owner": {"type": "string"},
"isDeletable": {"type": "boolean"},
"urls": {
"patternProperties": {"\\d\\dx\\d\\d": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"isSystemAvatar": {"type": "boolean"},
"isSelected": {"type": "boolean"},
"id": {"type": "string"},
"selected": {"type": "boolean"}
},
"required": [
"isSystemAvatar",
"isSelected",
"isDeletable",
"selected"
]
}
}}
},
"examples": {"application/json": "\n {\"system\":[{\"id\":\"1000\",\"owner\":\"fred\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"http://localhost:8090/jira/secure/useravatar?size=xsmall&avatarId=10040\",\"24x24\":\"http://localhost:8090/jira/secure/useravatar?size=small&avatarId=10040\",\"32x32\":\"http://localhost:8090/jira/secure/useravatar?size=medium&avatarId=10040\",\"48x48\":\"http://localhost:8090/jira/secure/useravatar?avatarId=10040\"},\"selected\":false}]}"},
"description": "\n all system avatars of the given type.\n"
},
"500": {"description": "\n all system avatars of the given type.\n"}
}
},
"parameters": [{
"in": "path",
"name": "type",
"description": "\n the avatar type\n",
"type": "string",
"required": true
}]
},
"api/2/user/properties/": {"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the user identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
},
"parameters": [
{
"in": "query",
"name": "userKey",
"description": "\n key of the user whose properties are to be returned\n",
"type": "string"
},
{
"in": "query",
"name": "username",
"description": "\n username of the user whose properties are to be returned\n",
"type": "string"
}
]
}},
"api/2/project": {
"post": {
"produces": ["application/json"],
"operationId": "createProject",
"description": "Creates a new project.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-identity#",
"additionalProperties": false,
"title": "Project Identity",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "integer"},
"key": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://example/jira/rest/api/2/project/10042\",\"id\":10010,\"key\":\"EX\"}"},
"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"
},
"400": {"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"},
"401": {"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"},
"403": {"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-input#",
"additionalProperties": false,
"title": "Project Input",
"type": "object",
"properties": {
"notificationScheme": {"type": "integer"},
"description": {"type": "string"},
"lead": {"type": "string"},
"url": {"type": "string"},
"projectTemplateKey": {"type": "string"},
"avatarId": {"type": "integer"},
"issueSecurityScheme": {"type": "integer"},
"name": {"type": "string"},
"permissionScheme": {"type": "integer"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"categoryId": {"type": "integer"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllProjects",
"description": "Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the\n list of projects that are visible when using anonymous access.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-project#",
"title": "List of Project",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project",
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"realAssignee": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"}
},
"required": ["isAssigneeTypeValid"]
}
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"roles": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"description": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"url": {"type": "string"},
"issueTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"expand": {"type": "string"},
"versions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"expand": {"type": "string"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
}
},
"projectCategory": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectKeys": {
"type": "array",
"items": {"type": "string"}
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"email": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First\n Project\n Category\"}},{\"self\":\"http://www.example.com/jira/rest/api/2/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"http://www.example.com/jira/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First\n Project Category\"}}]"},
"description": "\n all projects for which the user has the BROWSE project permission. If no user is logged in,\n it returns all projects, which are visible when using anonymous access.\n"
}},
"parameters": [
{
"in": "query",
"name": "expand",
"description": "\n the parameters to expand\n",
"type": "string"
},
{
"in": "query",
"name": "recent",
"description": "\n if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20).\n",
"type": "integer"
}
]
}
},
"api/2/groups/picker": {"get": {
"produces": ["application/json"],
"operationId": "findGroups",
"description": "Returns groups with substrings matching a given query. This is mainly for use with\n the group picker, so the returned groups contain html to be used as picker suggestions.\n The groups are also wrapped in a single response object that also contains a header for\n use in the picker, specifically <i>Showing X of Y matching groups<\/i>.\n <p>\n The number of groups returned is limited by the system property \"jira.ajax.autocomplete.limit\"\n <p>\n The groups will be unique and sorted.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/group-suggestions#",
"additionalProperties": false,
"title": "Group Suggestions",
"type": "object",
"properties": {
"total": {"type": "integer"},
"header": {"type": "string"},
"groups": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Suggestion",
"type": "object",
"properties": {
"name": {"type": "string"},
"html": {"type": "string"},
"labels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Label",
"type": "object",
"properties": {
"text": {"type": "string"},
"title": {"type": "string"},
"type": {
"type": "string",
"enum": [
"ADMIN",
"SINGLE",
"MULTIPLE"
]
}
}
}
}
}
}
}
}
},
"examples": {"application/json": "{\"header\":\"Showing 20 of 25 matching\n groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"<b>j<\/b>dog-developers\"},{\"name\":\"juvenal-bot\",\"html\":\"<b>j<\/b>uvenal-bot\"}]}"},
"description": "\n a collection of matching groups\n"
}},
"parameters": [
{
"in": "query",
"name": "query",
"description": "\n a String to match groups agains\n",
"type": "string"
},
{
"in": "query",
"name": "exclude",
"type": "string"
},
{
"in": "query",
"name": "maxResults",
"type": "integer"
},
{
"in": "query",
"name": "userName",
"type": "string"
}
]
}},
"api/2/permissionscheme": {
"post": {
"produces": ["application/json"],
"operationId": "createPermissionScheme",
"description": "Create a new permission scheme.\n This method can create schemes with a defined permission set, or without.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-developers\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"},
"description": "\n a newly created scheme\n"
},
"401": {"description": "\n a newly created scheme\n"},
"403": {"description": "\n a newly created scheme\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"parameter": {"type": "string"},
"type": {"type": "string"}
}
},
"permission": {"type": "string"}
}
}
},
"name": {"type": "string"},
"description": {"type": "string"}
}
},
"in": "body"
},
{
"in": "query",
"name": "expand",
"type": "string"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getPermissionSchemes",
"description": "Returns a list of all permission schemes.\n <p>\n By default only shortened beans are returned. If you want to include permissions of all the schemes,\n then specify the <b>permissions<\/b> expand parameter. Permissions will be included also if you specify\n any other expand parameter.\n <\/p>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-schemes#",
"additionalProperties": false,
"title": "Permission Schemes",
"type": "object",
"properties": {"permissionSchemes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
}
}}
},
"examples": {"application/json": "\n {\"permissionSchemes\":[{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\"}]}"},
"description": "\n a list of all permission schemes.\n"
},
"401": {"description": "\n a list of all permission schemes.\n"},
"403": {"description": "\n a list of all permission schemes.\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"type": "string"
}]
}
},
"api/2/projectvalidate/key": {"get": {
"produces": ["application/json"],
"operationId": "getProject",
"description": "Validates a project key.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/error-collection#",
"additionalProperties": false,
"title": "Error Collection",
"type": "object",
"properties": {
"errorMessages": {
"type": "array",
"items": {"type": "string"}
},
"errors": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"status": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"errorMessages\":[],\"errors\":{\"projectKey\":\"A\n project with that project key already\n exists.\"}}"},
"description": "\n an ErrorCollection containing any errors. If the project key is valid, the ErrorCollection will be empty.\n"
}},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n the project key\n",
"type": "string"
}]
}},
"api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}": {
"parameters": [
{
"in": "path",
"name": "id",
"description": "\n database id for avatar\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "type",
"description": "\n Project id or project key\n",
"type": "string",
"required": true
},
{
"in": "path",
"name": "owningObjectId",
"type": "string",
"required": true
}
],
"delete": {
"produces": ["application/json"],
"operationId": "deleteAvatar",
"description": "Deletes avatar",
"responses": {"": {}}
}
},
"api/2/issueLinkType": {
"post": {
"produces": ["application/json"],
"operationId": "createIssueLinkType",
"description": "Create a new issue link type.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-link-type#",
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"outward": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated\n by\",\"outward\":\"Duplicates\",\"self\":\"http://www.example.com/jira/rest/api/2//issueLinkType/1000\"}"}
},
"404": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-link-type#",
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"outward": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getIssueLinkTypes",
"description": "Returns a list of available issue link types, if issue linking is enabled.\n Each issue link type has an id, a name and a label for the outward and inward link relationship.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-link-types#",
"additionalProperties": false,
"title": "Issue Link Types",
"type": "object",
"properties": {"issueLinkTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"outward": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"issueLinkTypes\":[{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated\n by\",\"outward\":\"Duplicates\",\"self\":\"http://www.example.com/jira/rest/api/2//issueLinkType/1000\"},{\"id\":\"1010\",\"name\":\"Blocks\",\"inward\":\"Blocked\n by\",\"outward\":\"Blocks\",\"self\":\"http://www.example.com/jira/rest/api/2//issueLinkType/1010\"}]}"},
"description": "\n a list of available issue link types.\n"
},
"404": {"description": "\n a list of available issue link types.\n"}
}
}
},
"api/2/worklog/updated": {"get": {
"produces": ["application/json"],
"operationId": "getIdsOfWorklogsModifiedSince",
"description": "Returns worklogs id and update time of worklogs that was updated since given time.\n The returns set of worklogs is limited to 1000 elements.\n This API will not return worklogs updated during last minute.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-changed-since#",
"additionalProperties": false,
"title": "Worklog Changed Since",
"type": "object",
"properties": {
"nextPage": {
"format": "uri",
"type": "string"
},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog Change",
"type": "object",
"properties": {
"updatedTime": {"type": "integer"},
"worklogId": {"type": "integer"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"isLastPage": {"type": "boolean"},
"self": {
"format": "uri",
"type": "string"
},
"until": {"type": "integer"},
"since": {"type": "integer"}
},
"required": ["isLastPage"]
},
"examples": {"application/json": "\n {\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://www.example.com/jira/worklog/updated?since=1438013671136\",\"nextPage\":\"http://www.example.com/jira/worklog/updated/updated?since=1438013671136&since=1438013693136\",\"lastPage\":true}"},
"description": "\n a set of worklogs id and update time.\n"
}},
"parameters": [
{
"in": "query",
"name": "since",
"description": "\n a date time in unix timestamp format since when updated worklogs will be returned.\n",
"type": "integer"
},
{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}
]
}},
"api/2/screens/{screenId}/tabs/{tabId}/move/{pos}": {
"post": {
"produces": ["application/json"],
"operationId": "moveTab",
"description": "Moves tab position",
"responses": {
"201": {"description": "\n A response containing no content\n"},
"400": {"description": "\n A response containing no content\n"},
"401": {"description": "\n A response containing no content\n"}
}
},
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "pos",
"description": "\n position of tab\n",
"type": "integer",
"required": true
}
]
},
"api/2/screens/{screenId}/availableFields": {
"get": {
"produces": ["application/json"],
"operationId": "getFieldsToAdd",
"description": "Gets available fields for screen. i.e ones that haven't already been added.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-screenable-tab#",
"title": "List of Screenable Tab",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"description": "\n a response containing available fields\n"
},
"400": {"description": "\n a response containing available fields\n"},
"401": {"description": "\n a response containing available fields\n"}
}
},
"parameters": [{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
}]
},
"api/2/issuetype/{issueTypeId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertyKeys",
"description": "Returns the keys of all properties for the issue type identified by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean\n"}
}
},
"parameters": [{
"in": "path",
"name": "issueTypeId",
"description": "\n the issue type from which the keys will be returned\n",
"type": "string",
"required": true
}]
},
"api/2/issue/{issueIdOrKey}/changelog": {
"get": {
"produces": ["application/json"],
"operationId": "getChangeLogs",
"description": "Returns all changelogs for an issue, sorted by date, starting from the latest.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/page-of-change-history#",
"additionalProperties": false,
"title": "Page of Change History",
"type": "object",
"properties": {
"total": {"type": "integer"},
"isLast": {"type": "boolean"},
"nextPage": {
"format": "uri",
"type": "string"
},
"maxResults": {"type": "integer"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"self": {
"format": "uri",
"type": "string"
},
"startAt": {"type": "integer"}
},
"required": [
"maxResults",
"startAt"
]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issue/TT-1/changelog?startAt=2&maxResults=2\",\"nextPage\":\"http://www.example.com/jira/rest/api/2/issue/TT-1/changelog?&startAt=4&maxResults=2\",\"maxResults\":2,\"startAt\":2,\"total\":5,\"isLast\":false,\"values\":[{\"id\":\"10001\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:50.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"from\":null,\"fromString\":\"\",\"to\":null,\"toString\":\"label-1\"}]},{\"id\":\"10002\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:51.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"from\":null,\"fromString\":\"label-1\",\"to\":null,\"toString\":\"label-1\n label-2\"}]}]}"},
"description": "\n all changelogs for the issue\n"
},
"404": {"description": "\n all changelogs for the issue\n"}
},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n the page offset, if not specified then defaults to 0\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n how many results on the page should be included. Defaults to 100 and any number that bigger than 100 will be limited to that value.\n",
"type": "integer"
}
]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n to get changelogs for\n",
"type": "string",
"required": true
}]
},
"api/2/mypermissions": {"get": {
"produces": ["application/json"],
"operationId": "getPermissions",
"description": "Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for\n (<code>projectKey<\/code> OR <code>projectId<\/code> OR <code>issueKey<\/code> OR <code>issueId<\/code>)\n <p>When no context supplied the project related permissions will return true if the user has that permission in ANY project.<\/p>\n <p>If a project context is provided, project related permissions will return true if the user has the permissions in the specified project.\n For permissions that are determined using issue data (e.g Current Assignee), true will be returned if the user meets the permission criteria in ANY issue in that project.<\/p>\n <p>If an issue context is provided, it will return whether or not the user has each permission in that specific issue.<\/p>\n <p>The above means that for issue-level permissions (EDIT_ISSUE for example), hasPermission may be true when no context is provided, or when a project context is provided,\n <b>but<\/b> may be false for any given (or all) issues. This would occur (for example) if Reporters were given the EDIT_ISSUE permission. This is because\n any user could be a reporter, except in the context of a concrete issue, where the reporter is known.\n <\/p>\n <p>\n Global permissions will still be returned for all scopes.\n <\/p>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permissions#",
"additionalProperties": false,
"title": "Permissions",
"type": "object",
"properties": {"permissions": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Permission",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"type": {
"type": "string",
"enum": [
"GLOBAL",
"PROJECT"
]
},
"key": {"type": "string"}
}
}},
"additionalProperties": false,
"type": "object"
}}
},
"examples": {"application/json": "\n {\"permissions\":{\"EDIT_ISSUE\":{\"id\":\"12\",\"key\":\"EDIT_ISSUES\",\"name\":\"Edit\n Issues\",\"type\":\"PROJECT\",\"description\":\"Ability\n to edit\n issues.\",\"havePermission\":true}}}"},
"description": "\n all permissions and whether the currently logged in user has them.\n"
},
"400": {"description": "\n all permissions and whether the currently logged in user has them.\n"},
"404": {"description": "\n all permissions and whether the currently logged in user has them.\n"}
},
"parameters": [
{
"in": "query",
"name": "projectKey",
"description": "\n Key of project to scope returned permissions for.\n",
"type": "string"
},
{
"in": "query",
"name": "projectId",
"description": "\n Id of project to scope returned permissions for.\n",
"type": "string"
},
{
"in": "query",
"name": "issueKey",
"description": "\n Key of the issue to scope returned permissions for.\n",
"type": "string"
},
{
"in": "query",
"name": "issueId",
"description": "\n Id of the issue to scope returned permissions for.\n",
"type": "string"
}
]
}},
"api/2/groupuserpicker": {"get": {
"produces": ["application/json"],
"operationId": "findUsersAndGroups",
"description": "Returns a list of users and groups matching query with highlighting. This resource cannot be accessed\n anonymously.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/users-and-groups#",
"additionalProperties": false,
"title": "Users And Groups",
"type": "object",
"properties": {
"groups": {
"additionalProperties": false,
"title": "Group Suggestions",
"type": "object",
"properties": {
"total": {"type": "integer"},
"header": {"type": "string"},
"groups": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Suggestion",
"type": "object",
"properties": {
"name": {"type": "string"},
"html": {"type": "string"},
"labels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Label",
"type": "object",
"properties": {
"text": {"type": "string"},
"title": {"type": "string"},
"type": {
"type": "string",
"enum": [
"ADMIN",
"SINGLE",
"MULTIPLE"
]
}
}
}
}
}
}
}
}
},
"users": {
"additionalProperties": false,
"title": "User Picker Results",
"type": "object",
"properties": {
"total": {"type": "integer"},
"header": {"type": "string"},
"users": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User Picker User",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"html": {"type": "string"},
"key": {"type": "string"}
}
}
}
}
}
}
},
"description": "\n An object containing list of matched user objects, with html representing highlighting.\n"
}},
"parameters": [
{
"in": "query",
"name": "query",
"description": "\n A string used to search username, Name or e-mail address\n",
"type": "string"
},
{
"in": "query",
"name": "maxResults",
"description": "\n the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If\n you specify a value that is higher than this number, your search results will be truncated.\n",
"type": "integer"
},
{
"in": "query",
"name": "showAvatar",
"type": "boolean"
},
{
"in": "query",
"name": "fieldId",
"description": "\n The custom field id, if this request comes from a custom field, such as a user picker. Optional.\n",
"type": "string"
},
{
"in": "query",
"name": "projectId",
"description": "\n The list of project ids to further restrict the search\n This parameter can occur multiple times to pass in multiple project ids.\n Comma separated value is not supported.\n This parameter is only used when fieldId is present.\n",
"type": "string"
},
{
"in": "query",
"name": "issueTypeId",
"description": "\n The list of issue type ids to further restrict the search.\n This parameter can occur multiple times to pass in multiple issue type ids.\n Comma separated value is not supported.\n Special values such as -1 (all standard issue types), -2 (all subtask issue types) are supported.\n This parameter is only used when fieldId is present.\n",
"type": "string"
}
]
}},
"api/2/jql/autocompletedata": {"get": {
"produces": ["application/json"],
"operationId": "getAutoComplete",
"description": "Returns the auto complete data required for JQL searches.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/auto-complete-response#",
"additionalProperties": false,
"title": "Auto Complete Response",
"type": "object",
"properties": {
"visibleFieldNames": {
"type": "array",
"items": {"type": "string"}
},
"visibleFunctionNames": {
"type": "array",
"items": {"type": "string"}
},
"jqlReservedWords": {
"type": "array",
"items": {"type": "string"}
}
}
},
"examples": {"application/json": "\"{\\\"visibleFieldNames\\\":\n [{\\\"value\\\":\\\"affectedVersion\\\",\\\"displayName\\\":\\\"affectedVersion\\\",\\\"auto\\\":\\\"true\\\",\\\"orderable\\\":\\\"true\\\",\\\"searchable\\\":\\\"true\\\",\\\"operators\\\":[\\\"=\\\",\\\"!=\\\",\\\"in\\\",\\\"not\n in\\\",\\\"is\\\",\\\"is\n not\\\",\\\"<\\\",\\\"<=\\\",\\\">\\\",\\\">=\\\"],\\\"types\\\":[\\\"com.atlassian.jira.project.version.Version\\\"]},{\\\"value\\\":\\\"assignee\\\",\\\"displayName\\\":\\\"assignee\\\",\\\"auto\\\":\\\"true\\\",\\\"orderable\\\":\\\"true\\\",\\\"searchable\\\":\\\"true\\\",\\\"operators\\\":[\\\"!=\\\",\\\"was\n not in\\\",\\\"not in\\\",\\\"was not\\\",\\\"is\\\",\\\"was\n in\\\",\\\"was\\\",\\\"=\\\",\\\"in\\\",\\\"changed\\\",\\\"is\n not\\\"],\\\"types\\\":[\\\"com.atlassian.crowd.embedded.api.User\\\"]}],\\\"visibleFunctionNames\\\":\n {\\\"value\\\":\\\"currentLogin()\\\",\\\"displayName\\\":\\\"currentLogin()\\\",\\\"types\\\":[\\\"java.util.Date\\\"]},{\\\"value\\\":\\\"currentUser()\\\",\\\"displayName\\\":\\\"currentUser()\\\",\\\"types\\\":[\\\"com.atlassian.crowd.embedded.api.User\\\"]}],\\\"jqlReservedWords\\\":\n \\\"empty\\\",\\\"and\\\",\\\"or\\\",\\\"in\\\",\\\"distinct\\\"]}\""},
"description": "\n the auto complete data required for JQL searches.\n"
},
"401": {"description": "\n the auto complete data required for JQL searches.\n"},
"500": {"description": "\n the auto complete data required for JQL searches.\n"}
}
}},
"api/2/serverInfo": {"get": {
"produces": ["application/json"],
"operationId": "getServerInfo",
"description": "Returns general information about the current JIRA server.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/server-info#",
"additionalProperties": false,
"title": "Server Info",
"type": "object",
"properties": {
"healthChecks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Health Check Result",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"passed": {"type": "boolean"}
}
}
},
"baseUrl": {"type": "string"},
"deploymentType": {"type": "string"},
"scmInfo": {"type": "string"},
"buildPartnerName": {"type": "string"},
"serverTime": {"type": "string"},
"buildDate": {"type": "string"},
"serverTitle": {"type": "string"},
"version": {"type": "string"},
"buildNumber": {"type": "integer"},
"versionNumbers": {
"type": "array",
"items": {"type": "integer"}
}
}
},
"examples": {"application/json": "\n {\"baseUrl\":\"http://localhost:8080/jira\",\"version\":\"5.0-SNAPSHOT\",\"versionNumbers\":[5,0,0],\"buildNumber\":582,\"buildDate\":\"2017-05-22T07:28:47.399+0000\",\"serverTime\":\"2017-05-22T07:28:47.399+0000\",\"scmInfo\":\"1f51473f5c7b75c1a69a0090f4832cdc5053702a\",\"buildPartnerName\":\"Example\n Partner Co.\",\"serverTitle\":\"My Shiny New JIRA\n Server\"}"},
"description": "\n a Response containing a ServerInfoBean\n"
}},
"parameters": [{
"in": "query",
"name": "doHealthCheck",
"type": "boolean"
}]
}},
"api/2/mypreferences": {
"get": {
"produces": ["application/json"],
"operationId": "getPreference",
"description": "Returns preference of the currently logged in user. Preference key must be provided as input parameter (key).\n The value is returned exactly as it is.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"description": "\n response with value of one preference of currently logged in user.\n"
},
"404": {"description": "\n response with value of one preference of currently logged in user.\n"}
},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n - key of the preference to be returned.\n",
"type": "string"
}]
},
"delete": {
"produces": ["application/json"],
"operationId": "removePreference",
"description": "Removes preference of the currently logged in user. Preference key must be provided as input parameters (key).",
"responses": {
"204": {"description": "\n empty response\n"},
"404": {"description": "\n empty response\n"}
},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n - key of the preference to be removed.\n",
"type": "string"
}]
},
"put": {
"produces": ["application/json"],
"operationId": "setPreference",
"description": "Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value\n must be provided as POST body.",
"responses": {
"204": {"description": "\n empty response\n"},
"404": {"description": "\n empty response\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"in": "body"
},
{
"in": "query",
"name": "key",
"description": "\n - key of the preference to be set.\n",
"type": "string"
}
]
}
},
"api/2/configuration": {"get": {
"produces": ["application/json"],
"operationId": "getConfiguration",
"description": "Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled,\n it also returns the detailed information about time tracking configuration.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/configuration#",
"additionalProperties": false,
"title": "Configuration",
"type": "object",
"properties": {
"unassignedIssuesAllowed": {"type": "boolean"},
"watchingEnabled": {"type": "boolean"},
"timeTrackingEnabled": {"type": "boolean"},
"attachmentsEnabled": {"type": "boolean"},
"subTasksEnabled": {"type": "boolean"},
"issueLinkingEnabled": {"type": "boolean"},
"votingEnabled": {"type": "boolean"},
"timeTrackingConfiguration": {
"additionalProperties": false,
"title": "Time Tracking Configuration",
"type": "object",
"properties": {
"defaultUnit": {
"type": "string",
"enum": [
"minute",
"hour",
"day",
"week"
]
},
"workingHoursPerDay": {"type": "number"},
"workingDaysPerWeek": {"type": "number"},
"timeFormat": {
"type": "string",
"enum": [
"pretty",
"days",
"hours"
]
}
},
"required": [
"workingHoursPerDay",
"workingDaysPerWeek"
]
}
},
"required": [
"votingEnabled",
"watchingEnabled",
"unassignedIssuesAllowed",
"subTasksEnabled",
"issueLinkingEnabled",
"timeTrackingEnabled",
"attachmentsEnabled"
]
},
"examples": {"application/json": "\n {\"votingEnabled\":true,\"watchingEnabled\":true,\"unassignedIssuesAllowed\":false,\"subTasksEnabled\":false,\"issueLinkingEnabled\":true,\"timeTrackingEnabled\":true,\"attachmentsEnabled\":true,\"timeTrackingConfiguration\":{\"workingHoursPerDay\":8.0,\"workingDaysPerWeek\":5.0,\"timeFormat\":\"pretty\",\"defaultUnit\":\"day\"}}"}
},
"401": {}
}
}},
"api/2/task/{taskId}": {
"get": {
"produces": ["application/json"],
"operationId": "getTask",
"description": "Returns a task progress. When the task is finished, it will contain the <strong>result<\/strong>.\n The result may be an arbitrary JSON, its shape is different for each task type. Consult the documentation\n of the method that created the task to know what it is.",
"responses": {
"200": {
"schema": {
"additionalProperties": false,
"title": "Task Progress",
"type": "object",
"properties": {
"submittedBy": {
"description": "Id of the user that submitted the task",
"type": "integer"
},
"description": {
"description": "Description of the task",
"type": "string"
},
"started": {
"description": "The timestamp of when the task was started",
"type": "string"
},
"finished": {
"description": "The timestamp of when the task processing was finished",
"type": "string"
},
"message": {
"description": "Message regarding the current progress",
"type": "string"
},
"result": {"description": "The eventual result, will be available when the task is finished successfully"},
"submitted": {
"description": "The timestamp of when the task was submitted",
"type": "string"
},
"lastUpdate": {
"description": "The timestamp of when the task progress was last updated",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
},
"progress": {
"description": "The progress percentage (from 0 to 100)",
"type": "integer"
},
"id": {"type": "string"},
"elapsedRuntime": {
"description": "How much time did running the task take (so far, this is updated in real time), in milliseconds",
"type": "integer"
},
"status": {
"description": "Current status of the task",
"type": "string",
"enum": [
"ENQUEUED",
"RUNNING",
"COMPLETE",
"FAILED",
"CANCEL_REQUESTED",
"CANCELLED",
"DEAD"
]
}
},
"required": [
"self",
"id",
"status",
"submittedBy",
"progress",
"elapsedRuntime",
"submitted",
"started",
"lastUpdate"
]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/task/1\",\"id\":\"1\",\"description\":\"Task\n description\",\"status\":\"COMPLETE\",\"result\":\"the\n task result, this may be any\n JSON\",\"submittedBy\":10000,\"progress\":100,\"elapsedRuntime\":156,\"submitted\":1495438132073,\"started\":1495438132173,\"finished\":1495438132273,\"lastUpdate\":1495438132273}"}
},
"401": {},
"404": {}
}
},
"parameters": [{
"in": "path",
"name": "taskId",
"type": "string",
"required": true
}]
}
},
"host": "example.com",
"produces": ["application/json"],
"schemes": ["http"],
"definitions": {
"custom-field-value-notification": {
"additionalProperties": false,
"title": "Custom Field Value Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"email-notification": {
"additionalProperties": false,
"title": "Email Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"emailAddress": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"notification-event": {
"additionalProperties": false,
"title": "Notification Event",
"type": "object",
"properties": {
"templateEvent": {"$ref": "#/definitions/notification-event"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"field-meta": {
"additionalProperties": false,
"title": "Field Meta",
"type": "object",
"properties": {
"schema": {"$ref": "#/definitions/json-type"},
"hasDefaultValue": {"type": "boolean"},
"allowedValues": {
"type": "array",
"items": {"type": "string"}
},
"operations": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {},
"name": {"type": "string"},
"autoCompleteUrl": {"type": "string"},
"required": {"type": "boolean"},
"key": {"type": "string"}
},
"required": ["required"]
},
"associated-item": {
"additionalProperties": false,
"title": "Associated Item",
"type": "object",
"properties": {
"parentName": {"type": "string"},
"name": {"type": "string"},
"typeName": {"type": "string"},
"id": {"type": "string"},
"parentId": {"type": "string"}
}
},
"json-type": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"user-notification": {
"additionalProperties": false,
"title": "User Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
}
},
"issue-ref": {
"additionalProperties": false,
"title": "Issue Ref",
"type": "object",
"properties": {
"id": {"type": "string"},
"fields": {
"additionalProperties": false,
"title": "Fields",
"type": "object",
"properties": {
"summary": {"type": "string"},
"issuetype": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
},
"priority": {
"additionalProperties": false,
"title": "Priority",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"}
}
},
"status": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
}
}
},
"key": {"type": "string"}
}
},
"group-notification": {
"additionalProperties": false,
"title": "Group Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"history-metadata-participant": {
"additionalProperties": false,
"title": "History Metadata Participant",
"type": "object",
"properties": {
"avatarUrl": {"type": "string"},
"displayName": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"displayNameKey": {"type": "string"},
"url": {"type": "string"}
}
},
"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"$ref": "#/definitions/group",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
},
"link-group": {
"additionalProperties": false,
"title": "Link Group",
"type": "object",
"properties": {
"header": {"$ref": "#/definitions/simple-link"},
"weight": {"type": "integer"},
"groups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
},
"links": {
"type": "array",
"items": {"$ref": "#/definitions/simple-link"}
},
"id": {"type": "string"},
"styleClass": {"type": "string"}
}
},
"role-notification": {
"additionalProperties": false,
"title": "Role Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"simple-link": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"project-role-notification": {
"additionalProperties": false,
"title": "Project Role Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"swagger": "2.0",
"infos": {
"description": "This documents the current REST API provided by JIRA.",
"title": "JIRA Cloud REST API Reference",
"version": "1000.1010.0"
},
"consumes": ["application/json"]
}
Raw
jira-api.json
{
"basePath": "/jira/rest/",
"paths": {
"api/2/settings/columns": {
"get": {
"produces": ["application/json"],
"operationId": "getIssueNavigatorDefaultColumns",
"description": "Returns the default system columns for issue navigator. Admin permission will be required.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-column-item#",
"title": "List of Column Item",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Column Item",
"type": "object",
"properties": {
"label": {"type": "string"},
"value": {"type": "string"}
}
}
},
"description": "\n column configuration\n"
},
"500": {"description": "\n column configuration\n"},
"403": {"description": "\n column configuration\n"}
}
},
"put": {
"produces": ["application/json"],
"operationId": "setIssueNavigatorDefaultColumns",
"description": "Sets the default system columns for issue navigator. Admin permission will be required.",
"responses": {
"200": {"description": "\n javax.ws.rs.core.Response containing basic message and http return code\n"},
"500": {"description": "\n javax.ws.rs.core.Response containing basic message and http return code\n"}
}
}
},
"api/2/screens/{screenId}/tabs/{tabId}/fields/{id}": {
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "id",
"type": "string",
"required": true
}
],
"delete": {
"produces": ["application/json"],
"operationId": "removeField",
"description": "Removes field from given tab",
"responses": {
"201": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
}
}
},
"api/2/projectvalidate/validProjectKey": {"get": {
"produces": ["application/json"],
"operationId": "getValidProjectKey",
"description": "Validates the project key and generated a valid project key if the supplied key is invalid.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"examples": {"application/json": "\"VPNE\""},
"description": "\n a String containing a valid project key.\n"
}},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n the project key\n",
"type": "string"
}]
}},
"api/2/field/{fieldKey}/option": {
"post": {
"produces": ["application/json"],
"operationId": "createOption",
"description": "Creates an option for a select list issue field, for a given field key. The Id will be automatically assigned. Only JIRA administrators or the add-ons that provided the field may use this method.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-field-option#",
"additionalProperties": false,
"title": "Issue Field Option",
"type": "object",
"properties": {
"id": {"type": "integer"},
"value": {"type": "string"},
"config": {
"additionalProperties": false,
"title": "Issue Field Option Config",
"type": "object",
"properties": {
"scope": {
"additionalProperties": false,
"title": "Issue Field Option Scope",
"type": "object",
"properties": {
"projects2": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Scope",
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
},
"id": {"type": "integer"}
},
"required": ["id"]
}
},
"projects": {
"type": "array",
"items": {"type": "integer"}
},
"global": {
"additionalProperties": false,
"title": "Global Scope",
"type": "object",
"properties": {"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}}
}
}
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}
}
},
"properties": {
"title": "Object Node",
"type": "object"
}
}
},
"examples": {"application/json": "{\"value\":\"Team\n 1\",\"properties\":{\"leader\":{\"name\":\"Leader\n Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The\n team's\n description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}"},
"description": "\n The created select list issue field option.\n"
},
"400": {"description": "\n The created select list issue field option.\n"},
"403": {"description": "\n The created select list issue field option.\n"},
"404": {"description": "\n The created select list issue field option.\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-field-option#",
"additionalProperties": false,
"title": "Issue Field Option",
"type": "object",
"properties": {
"id": {"type": "integer"},
"value": {"type": "string"},
"config": {
"additionalProperties": false,
"title": "Issue Field Option Config",
"type": "object",
"properties": {
"scope": {
"additionalProperties": false,
"title": "Issue Field Option Scope",
"type": "object",
"properties": {
"projects2": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Scope",
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
},
"id": {"type": "integer"}
},
"required": ["id"]
}
},
"projects": {
"type": "array",
"items": {"type": "integer"}
},
"global": {
"additionalProperties": false,
"title": "Global Scope",
"type": "object",
"properties": {"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}}
}
}
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}
}
},
"properties": {
"title": "Object Node",
"type": "object"
}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllOptions",
"description": "<p> Returns all options defined for a select list issue field, for a given field key. Only JIRA administrators or the add-ons that provided the field may use this method.\n <p> The list of options will be ordered by the option Id and <a href=\"#pagination\">paginated<\/a>.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/page-of-issue-field-option#",
"additionalProperties": false,
"title": "Page of Issue Field Option",
"type": "object",
"properties": {
"total": {"type": "integer"},
"isLast": {"type": "boolean"},
"nextPage": {
"format": "uri",
"type": "string"
},
"maxResults": {"type": "integer"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Field Option",
"type": "object",
"properties": {
"id": {"type": "integer"},
"value": {"type": "string"},
"config": {
"additionalProperties": false,
"title": "Issue Field Option Config",
"type": "object",
"properties": {
"scope": {
"additionalProperties": false,
"title": "Issue Field Option Scope",
"type": "object",
"properties": {
"projects2": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Scope",
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
},
"id": {"type": "integer"}
},
"required": ["id"]
}
},
"projects": {
"type": "array",
"items": {"type": "integer"}
},
"global": {
"additionalProperties": false,
"title": "Global Scope",
"type": "object",
"properties": {"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}}
}
}
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"enum": ["notSelectable"]
}
}
}
},
"properties": {
"title": "Object Node",
"type": "object"
}
}
}
},
"self": {
"format": "uri",
"type": "string"
},
"startAt": {"type": "integer"}
},
"required": [
"maxResults",
"startAt"
]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/field/fieldKey/option?startAt=0&maxResults=1\",\"nextPage\":\"http://www.example.com/jira/rest/api/2/field/fieldKey/option?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team\n 1\",\"properties\":{\"leader\":{\"name\":\"Leader\n Name\",\"email\":\"[email protected]\"},\"members\":42,\"description\":\"The\n team's\n description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}]}"},
"description": "\n A page containing the options for a given field.\n"
},
"403": {"description": "\n A page containing the options for a given field.\n"},
"404": {"description": "\n A page containing the options for a given field.\n"}
},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n The starting index of the returned objects. Base index: 0.\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n The maximum number of items to return per page. Default: 50.\n",
"type": "integer"
}
]
},
"parameters": [{
"in": "path",
"name": "fieldKey",
"type": "string",
"required": true
}]
},
"api/2/projectvalidate/validProjectName": {"get": {
"produces": ["application/json"],
"operationId": "getValidProjectName",
"description": "Validates a project name.\n\n If the name is invalid, an attempt is made to produce a valid name\n based on the supplied one. If no such valid name can be found, an\n empty string is returned.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"examples": {"application/json": "\"Valid Project Name\n Example\""},
"description": "\n a String containing a valid project name.\n"
}},
"parameters": [{
"in": "query",
"name": "name",
"description": "\n the project name\n",
"type": "string"
}]
}},
"api/2/dashboard/{dashboardId}/items/{itemId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the dashboard item identified by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [
{
"in": "path",
"name": "itemId",
"description": "\n the dashboard item from which keys will be returned.\n",
"type": "string",
"required": true
},
{
"in": "path",
"name": "dashboardId",
"type": "string",
"required": true
}
]
},
"api/2/issue/{issueIdOrKey}/attachments": {
"post": {
"produces": ["application/json"],
"operationId": "addAttachment",
"description": "Add one or more attachments to an issue.\n <p>\n This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client\n libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components\n library provides a\n <a href=\"http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html\">MultiPartEntity<\/a>\n that makes it simple to submit a multipart POST.\n <p>\n In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection\n on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be\n blocked.\n <p>\n The name of the multipart/form-data parameter that contains attachments must be \"file\"\n <p>\n A simple example to upload a file called \"myfile.txt\" to issue REST-123:\n <pre>curl -D- -u admin:admin -X POST -H \"X-Atlassian-Token: no-check\" -F \"[email protected]\" http://myhost/rest/api/2/issue/TEST-123/attachments<\/pre>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-attachment#",
"title": "List of Attachment",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Attachment",
"type": "object",
"properties": {
"thumbnail": {"type": "string"},
"filename": {"type": "string"},
"size": {"type": "integer"},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"created": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "integer"},
"mimeType": {"type": "string"},
"properties": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"content": {"type": "string"}
},
"required": [
"id",
"size"
]
},
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}}
},
"examples": {"application/json": "\n [{\"id\":10001,\"self\":\"http://www.example.com/jira/rest/api/2.0/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:50.772+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"http://www.example.com/jira/attachments/10000\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10000\"},{\"id\":0,\"self\":\"http://www.example.com/jira/rest/api/2.0/attachments/10001\",\"filename\":\"dbeuglog.txt\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:50.772+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"http://www.example.com/jira/attachments/10001\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10002\"}]"},
"description": "\n a JSON representation of the attachments added.\n"
},
"403": {"description": "\n a JSON representation of the attachments added.\n"},
"404": {"description": "\n a JSON representation of the attachments added.\n"}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n the issue that you want to add the attachments to\n",
"type": "string",
"required": true
}]
},
"api/2/universal_avatar/type/{type}/owner/{owningObjectId}": {
"get": {
"produces": ["application/json"],
"operationId": "getAvatars",
"responses": {"": {}}
},
"parameters": [
{
"in": "path",
"name": "type",
"type": "string",
"required": true
},
{
"in": "path",
"name": "owningObjectId",
"type": "string",
"required": true
}
]
},
"api/2/project/{projectKeyOrId}/securitylevel": {
"get": {
"produces": ["application/json"],
"operationId": "getSecurityLevelsForProject",
"description": "Returns all security levels for the project that the current logged in user has access to.\n If the user does not have the Set Issue Security permission, the list will be empty.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-list-level#",
"additionalProperties": false,
"title": "Security List Level",
"type": "object",
"properties": {"levels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"levels\":[{\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/100000\",\"id\":\"100000\",\"description\":\"security\n description\",\"name\":\"securityLevelName\"},{\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/100001\",\"id\":\"100001\",\"description\":\"another\n security\n description\",\"name\":\"secret\"}]}"},
"description": "\n list of security levels\n"
},
"404": {"description": "\n list of security levels\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"description": "\n - key or id of project to list the security levels for\n",
"type": "string",
"required": true
}]
},
"api/2/project/{projectKeyOrId}/permissionscheme": {
"get": {
"produces": ["application/json"],
"operationId": "getAssignedPermissionScheme",
"description": "Gets a permission scheme assigned with a project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\"}"},
"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"
},
"401": {"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"},
"403": {"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"},
"404": {"description": "\n The associated permission scheme if successful, appropriate error otherwise.\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"description": "\n key or id of the project\n",
"type": "string",
"required": true
}],
"put": {
"produces": ["application/json"],
"operationId": "assignPermissionScheme",
"description": "Assigns a permission scheme with a project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\"}"},
"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"
},
"401": {"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"},
"403": {"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"},
"404": {"description": "\n The newly associated permission scheme if successful, appropriate error otherwise.\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/id#",
"additionalProperties": false,
"title": "Id",
"type": "object",
"properties": {"id": {"type": "integer"}}
},
"in": "body"
},
{
"in": "query",
"name": "expand",
"type": "string"
}
]
}
},
"api/2/securitylevel/{id}": {
"get": {
"produces": ["application/json"],
"operationId": "getIssuesecuritylevel",
"description": "Returns a full representation of the security level that has the given id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-level#",
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only\n the reporter and internal staff can see this\n issue.\",\"name\":\"Reporter Only\"}"},
"description": "\n a full representation of the issue security level with the given id\n"
},
"404": {"description": "\n a full representation of the issue security level with the given id\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n a String containing an issue security level id\n",
"type": "string",
"required": true
}]
},
"api/2/screens/{screenId}/tabs/{tabId}/fields": {
"post": {
"produces": ["application/json"],
"operationId": "addField",
"description": "Adds field to the given tab.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-field#",
"additionalProperties": false,
"title": "Screenable Field",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"id\":\"summary\",\"name\":\"Summary\"}"},
"description": "\n no content\n"
},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/add-field#",
"additionalProperties": false,
"title": "Add Field",
"type": "object",
"properties": {"fieldId": {"type": "string"}}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllFields",
"description": "Gets all fields for a given tab",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-screenable-tab#",
"title": "List of Screenable Tab",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"description": "\n a response containing all fields for given tab\n"
},
"400": {"description": "\n a response containing all fields for given tab\n"},
"401": {"description": "\n a response containing all fields for given tab\n"}
},
"parameters": [{
"in": "query",
"name": "projectKey",
"description": "\n the key of the project; this parameter is optional\n",
"type": "string"
}]
},
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
}
]
},
"api/2/application-properties": {"get": {
"produces": ["application/json"],
"operationId": "getProperty",
"description": "Returns an application property.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/property#",
"additionalProperties": false,
"title": "Property",
"type": "object",
"properties": {
"allowedValues": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"value": {"type": "string"},
"key": {"type": "string"},
"desc": {"type": "string"},
"example": {"type": "string"}
}
},
"examples": {"application/json": "\n [{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"JIRA\n home\n directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE\n -\",\"name\":\"The prefix added to the Summary field\n of cloned\n issues\",\"type\":\"string\",\"defaultValue\":\"CLONE\n -\"}]"},
"description": "\n an application property.\n"
},
"404": {"description": "\n an application property.\n"}
},
"parameters": [
{
"in": "query",
"name": "key",
"description": "\n a String containing the property key\n",
"type": "string"
},
{
"in": "query",
"name": "permissionLevel",
"description": "\n when fetching a list specifies the permission level of all items in the list\n see {@link com.atlassian.jira.bc.admin.ApplicationPropertiesService.EditPermissionLevel}\n",
"type": "string"
},
{
"in": "query",
"name": "keyFilter",
"description": "\n when fetching a list allows the list to be filtered by the property's start of key\n e.g. \"jira.lf.*\" whould fetch only those permissions that are editable and whose keys start with\n \"jira.lf.\". This is a regex.\n",
"type": "string"
}
]
}},
"api/2/worklog/list": {"post": {
"produces": ["application/json"],
"operationId": "getWorklogsForIds",
"description": "Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result.\n The returns set of worklogs is limited to 1000 elements.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-worklog#",
"title": "List of Worklog",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"started": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {
"format": "uri",
"type": "string"
},
"comment": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"comment\":\"I did some\n work\n here.\",\"updated\":\"2017-05-22T07:28:50.833+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2017-05-22T07:28:50.833+0000\",\"timeSpent\":\"3h\n 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}"},
"description": "\n a set of worklogs for given ids.\n"
},
"400": {"description": "\n a set of worklogs for given ids.\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-ids-request#",
"additionalProperties": false,
"title": "Worklog Ids Request",
"type": "object",
"properties": {"ids": {
"type": "array",
"items": {"type": "integer"}
}}
},
"in": "body",
"name": "worklogIdsRequest"
},
{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}
]
}},
"api/2/version": {"post": {
"produces": ["application/json"],
"operationId": "createVersion",
"description": "Create a version via POST.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/version#",
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"expand": {"type": "string"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
},
"examples": {"application/json": "{\"description\":\"An excellent\n version\",\"name\":\"New Version\n 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"userReleaseDate\":\"6/Jul/2010\",\"project\":\"PXA\",\"projectId\":10000}"}
},
"403": {},
"404": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/version#",
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {}
}
}
},
"name": {"type": "string"},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
},
"in": "body",
"name": "version"
}]
}},
"api/2/settings/baseUrl": {"put": {
"produces": ["application/json"],
"operationId": "setBaseURL",
"description": "Sets the base URL that is configured for this JIRA instance.",
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"in": "body"
}]
}},
"api/2/workflowscheme": {"post": {
"produces": ["application/json"],
"operationId": "createScheme",
"description": "Create a new workflow scheme.\n <p/>\n The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/workflow-scheme#",
"additionalProperties": false,
"title": "Workflow Scheme",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}},
"properties": {
"originalDefaultWorkflow": {"type": "string"},
"description": {"type": "string"},
"issueTypes": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}},
"additionalProperties": false,
"type": "object"
},
"originalIssueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"defaultWorkflow": {"type": "string"},
"updateDraftIfNeeded": {"type": "boolean"},
"draft": {"type": "boolean"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"lastModifiedUser": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"id": {"type": "integer"},
"lastModified": {"type": "string"},
"issueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}
}
},
"examples": {"application/json": "{\"id\":101010,\"name\":\"Workflow Scheme\n One\",\"description\":\"Workflow Scheme One\n Description\",\"defaultWorkflow\":\"DefaultWorkflowName\",\"issueTypeMappings\":{\"IsueTypeId2\":\"WorkflowName\",\"IsueTypeId\":\"WorkflowName\"},\"draft\":false,\"self\":\"http://www.example.com/jira/rest/api/2/workflowscheme/101010\"}"}
},
"401": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/workflow-scheme#",
"additionalProperties": false,
"title": "Workflow Scheme",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {"name": {"type": "string"}}
}
}
},
"required": ["size"]
}},
"properties": {
"originalIssueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"defaultWorkflow": {"type": "string"},
"updateDraftIfNeeded": {"type": "boolean"},
"draft": {"type": "boolean"},
"name": {"type": "string"},
"originalDefaultWorkflow": {"type": "string"},
"description": {"type": "string"},
"lastModifiedUser": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"id": {"type": "integer"},
"lastModified": {"type": "string"},
"issueTypeMappings": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"issueTypes": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}},
"additionalProperties": false,
"type": "object"
}
}
},
"in": "body"
}]
}},
"api/2/user": {
"post": {
"produces": ["application/json"],
"operationId": "createUser",
"description": "Create user. By default created user will not be notified with email.\n If password field is not set then password will be randomly generated.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}},
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie\",\"key\":\"charlie\",\"name\":\"charlie\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Charlie\n of Atlassian\"}"}
},
"400": {},
"401": {},
"500": {},
"403": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user-write#",
"additionalProperties": false,
"title": "User Write",
"type": "object",
"properties": {
"applicationKeys": {
"type": "array",
"items": {"type": "string"}
},
"notification": {"type": "string"},
"password": {"type": "string"},
"emailAddress": {"type": "string"},
"displayName": {"type": "string"},
"name": {"type": "string"},
"key": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getUser",
"description": "Returns a user. This resource cannot be accessed anonymously.\n <p>\n The resource accepts the <code>expand<\/code> param that is used to include, hidden by default, parts of response. This can be used to include:\n <ul>\n <li><code>groups<\/code> - all groups, including nested groups, to which user belongs<\/li>\n <li><code>applicationRoles<\/code> - application roles defines to which application user has access<\/li>\n <\/ul>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}},
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[{\"name\":\"jira-user\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-user\"},{\"name\":\"jira-admin\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin\"},{\"name\":\"important\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=important\"}]},\"applicationRoles\":{\"size\":1,\"items\":[]},\"expand\":\"groups,applicationRoles\"}"}
},
"401": {},
"404": {}
},
"parameters": [
{
"in": "query",
"name": "username",
"description": "\n the username\n",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "\n user key\n",
"type": "string"
}
]
},
"delete": {
"produces": ["application/json"],
"operationId": "removeUser",
"description": "Removes user.",
"responses": {
"400": {},
"401": {},
"204": {},
"403": {},
"404": {}
},
"parameters": [
{
"in": "query",
"name": "username",
"description": "\n the username\n",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "\n user key\n",
"type": "string"
}
]
},
"put": {
"produces": ["application/json"],
"operationId": "updateUser",
"description": "Modify user. The \"value\" fields present will override the existing value.\n Fields skipped in request will not be changed.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}},
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jirahttp://www.example.com/jira/rest/api/2/user/charlie\",\"key\":\"charlie\",\"name\":\"charlie\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Charlie\n of Atlassian\"}"},
"description": "\n a user\n"
},
"400": {"description": "\n a user\n"},
"401": {"description": "\n a user\n"},
"403": {"description": "\n a user\n"},
"404": {"description": "\n a user\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user-write#",
"additionalProperties": false,
"title": "User Write",
"type": "object",
"properties": {
"applicationKeys": {
"type": "array",
"items": {"type": "string"}
},
"notification": {"type": "string"},
"password": {"type": "string"},
"emailAddress": {"type": "string"},
"displayName": {"type": "string"},
"name": {"type": "string"},
"key": {"type": "string"}
}
},
"in": "body"
},
{
"in": "query",
"name": "username",
"description": "\n the username\n",
"type": "string"
},
{
"in": "query",
"name": "key",
"description": "\n user key\n",
"type": "string"
}
]
}
},
"api/2/configuration/timetracking": {
"get": {
"produces": ["application/json"],
"operationId": "getSelectedTimeTrackingImplementation",
"description": "Returns the currently selected time-tracking implementation",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/time-tracking-implementation#",
"additionalProperties": false,
"title": "Time Tracking Implementation",
"type": "object",
"properties": {
"name": {"type": "string"},
"key": {"type": "string"},
"url": {"type": "string"}
}
},
"examples": {"application/json": "{\"key\":\"JIRA\",\"name\":\"JIRA time\n tracking\",\"url\":\"/example/config/url\"}"}
},
"401": {},
"204": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/time-tracking-implementation#",
"additionalProperties": false,
"title": "Time Tracking Implementation",
"type": "object",
"properties": {
"name": {"type": "string"},
"key": {"type": "string"},
"url": {"type": "string"}
}
}},
"403": {}
}
},
"delete": {
"produces": ["application/json"],
"operationId": "disableTimeTracking",
"description": "Disables time tracking",
"responses": {
"401": {},
"204": {},
"403": {}
}
},
"put": {
"produces": ["application/json"],
"operationId": "selectTimeTrackingImplementation",
"description": "Selects a time tracking implementation",
"responses": {
"400": {},
"401": {},
"204": {},
"403": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/time-tracking-implementation#",
"additionalProperties": false,
"title": "Time Tracking Implementation",
"type": "object",
"properties": {
"name": {"type": "string"},
"key": {"type": "string"},
"url": {"type": "string"}
}
},
"in": "body"
}]
}
},
"api/2/screens/addToDefault/{fieldId}": {
"post": {
"produces": ["application/json"],
"operationId": "addFieldToDefaultScreen",
"description": "Adds field or custom field to the default tab",
"responses": {
"201": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
}
},
"parameters": [{
"in": "path",
"name": "fieldId",
"description": "\n id of field / custom field\n",
"type": "string",
"required": true
}]
},
"api/2/filter": {"post": {
"produces": ["application/json"],
"operationId": "createFilter",
"description": "Creates a new filter, and returns newly created filter.\n Currently sets permissions just using the users default sharing permissions",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/filter#",
"additionalProperties": false,
"title": "Filter",
"type": "object",
"definitions": {
"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/group"}
}
},
"required": ["size"]
},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"properties": {
"owner": {"$ref": "#/definitions/user"},
"sharedUsers": {
"additionalProperties": false,
"title": "User Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/user"}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"subscriptions": {
"additionalProperties": false,
"title": "Filter Subscription Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Subscription",
"type": "object",
"properties": {
"id": {"type": "integer"},
"user": {"$ref": "#/definitions/user"},
"group": {"$ref": "#/definitions/group"}
}
}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"jql": {"type": "string"},
"name": {"type": "string"},
"viewUrl": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"searchUrl": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"sharePermissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Permission",
"type": "object",
"properties": {
"role": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"project": {
"additionalProperties": false,
"title": "Project",
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"realAssignee": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"}
},
"required": ["isAssigneeTypeValid"]
}
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"roles": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"description": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"url": {"type": "string"},
"issueTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"expand": {"type": "string"},
"versions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"expand": {"type": "string"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
}
},
"projectCategory": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectKeys": {
"type": "array",
"items": {"type": "string"}
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"email": {"type": "string"}
}
},
"id": {"type": "integer"},
"type": {"type": "string"},
"group": {"$ref": "#/definitions/group"}
}
}
},
"favourite": {"type": "boolean"}
},
"required": ["favourite"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/filter/10000\",\"id\":\"10000\",\"name\":\"All\n Open Bugs\",\"description\":\"Lists all open\n bugs\",\"owner\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F. User\",\"active\":false},\"jql\":\"type = Bug and\n resolution is\n empty\",\"viewUrl\":\"http://www.example.com/jira/issues/?filter=10000\",\"searchUrl\":\"http://www.example.com/jira/rest/api/2/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}"},
"description": "\n a {@link FilterBean}\n"
},
"400": {"description": "\n a {@link FilterBean}\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/filter#",
"additionalProperties": false,
"title": "Filter",
"type": "object",
"definitions": {
"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/group"}
}
},
"required": ["size"]
},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {"name": {"type": "string"}}
}
},
"properties": {
"owner": {"$ref": "#/definitions/user"},
"sharedUsers": {
"additionalProperties": false,
"title": "User Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {"$ref": "#/definitions/user"}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"subscriptions": {
"additionalProperties": false,
"title": "Filter Subscription Bean List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Subscription",
"type": "object",
"properties": {
"id": {"type": "integer"},
"user": {"$ref": "#/definitions/user"},
"group": {"$ref": "#/definitions/group"}
}
}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
},
"jql": {"type": "string"},
"name": {"type": "string"},
"viewUrl": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"searchUrl": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"sharePermissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Filter Permission",
"type": "object",
"properties": {
"role": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"project": {
"additionalProperties": false,
"title": "Project",
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"realAssignee": {"$ref": "#/definitions/user"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"},
"lead": {"$ref": "#/definitions/user"}
},
"required": ["isAssigneeTypeValid"]
}
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"roles": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"description": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"url": {"type": "string"},
"issueTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"versions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {}
}
}
},
"name": {"type": "string"},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
}
},
"projectCategory": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"name": {"type": "string"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectKeys": {
"type": "array",
"items": {"type": "string"}
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"email": {"type": "string"}
}
},
"id": {"type": "integer"},
"type": {"type": "string"},
"group": {"$ref": "#/definitions/group"}
}
}
},
"favourite": {"type": "boolean"}
},
"required": ["favourite"]
},
"in": "body",
"name": "filter"
},
{
"in": "query",
"name": "expand",
"description": "\n the parameters to expand\n",
"type": "string"
}
]
}},
"api/2/project/{projectIdOrKey}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the project identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectIdOrKey",
"description": "\n the project from which keys will be returned.\n",
"type": "string",
"required": true
}]
},
"api/2/issue": {"post": {
"produces": ["application/json"],
"operationId": "createIssue",
"description": "Creates an issue or a sub-task from a JSON representation.\n <p/>\n The fields that can be set on create, in either the fields parameter or the update parameter can be determined\n using the <b>/rest/api/2/issue/createmeta<\/b> resource.\n If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field\n validation error will occur if it is submitted.\n <p/>\n Creating a sub-task is similar to creating a regular issue, with two important differences:\n <ul>\n <li>the <code>issueType<\/code> field must correspond to a sub-task issue type (you can use\n <code>/issue/createmeta<\/code> to discover sub-task issue types), and<\/li>\n <li>you must provide a <code>parent<\/code> field in the issue create request containing the id or key of the\n parent issue.<\/li>\n <\/ul>\n\n The <code>updateHistory<\/code> param adds the project that this issue is created in, to the current user's project history,\n if set to true (by default, the project history is not updated).\n You can view the project history in the JIRA application, via the Projects dropdown.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-create-response#",
"additionalProperties": false,
"title": "Issue Create Response",
"type": "object",
"properties": {
"self": {"type": "string"},
"id": {"type": "string"},
"key": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"id\":\"10000\",\"key\":\"TST-24\",\"self\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}"},
"description": "\n an com.atlassian.jira.rest.api.issue.IssueCreateResponse\n"
},
"400": {
"examples": {"application/json": "{\"errorMessages\":[\"Field 'priority' is\n required\"],\"errors\":{}}"},
"description": "\n an com.atlassian.jira.rest.api.issue.IssueCreateResponse\n"
}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-update#",
"additionalProperties": false,
"title": "Issue Update",
"type": "object",
"definitions": {"history-metadata-participant": {
"additionalProperties": false,
"title": "History Metadata Participant",
"type": "object",
"properties": {
"avatarUrl": {"type": "string"},
"displayName": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"displayNameKey": {"type": "string"},
"url": {"type": "string"}
}
}},
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"update": {
"patternProperties": {".+": {
"type": "array",
"items": {
"title": "Field Operation",
"type": "object"
}
}},
"additionalProperties": false,
"type": "object"
},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"transition": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"hasScreen": {"type": "boolean"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Field Meta",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"hasDefaultValue": {"type": "boolean"},
"allowedValues": {
"type": "array",
"items": {}
},
"operations": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {},
"name": {"type": "string"},
"autoCompleteUrl": {"type": "string"},
"required": {"type": "boolean"},
"key": {"type": "string"}
},
"required": ["required"]
}},
"additionalProperties": false,
"type": "object"
}
}
},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"in": "body"
},
{
"in": "query",
"name": "updateHistory",
"description": "\n if true then the user's project history is updated\n",
"type": "boolean"
}
]
}},
"api/2/auditing/record": {"get": {
"produces": ["application/json"],
"operationId": "getRecords",
"description": "Returns auditing records filtered using provided parameters",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/audit-record#",
"additionalProperties": false,
"title": "Audit Record",
"type": "object",
"definitions": {"associated-item": {
"additionalProperties": false,
"title": "Associated Item",
"type": "object",
"properties": {
"parentName": {"type": "string"},
"name": {"type": "string"},
"typeName": {"type": "string"},
"id": {"type": "string"},
"parentId": {"type": "string"}
}
}},
"properties": {
"summary": {"type": "string"},
"changedValues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Changed Value",
"type": "object",
"properties": {
"changedTo": {"type": "string"},
"fieldName": {"type": "string"},
"changedFrom": {"type": "string"}
}
}
},
"objectItem": {"$ref": "#/definitions/associated-item"},
"created": {"type": "string"},
"authorKey": {"type": "string"},
"eventSource": {"type": "string"},
"description": {"type": "string"},
"associatedItems": {
"type": "array",
"items": {"$ref": "#/definitions/associated-item"}
},
"id": {"type": "integer"},
"category": {"type": "string"},
"remoteAddress": {"type": "string"}
}
},
"examples": {"application/json": "{\"id\":1,\"summary\":\"User\n created\",\"remoteAddress\":\"192.168.1.1\",\"authorKey\":\"administrator\",\"created\":\"2014-03-19T18:45:42.967+0000\",\"category\":\"user\n management\",\"eventSource\":\"JIRA Connect\n Plugin\",\"description\":\"Optional\n description\",\"objectItem\":{\"id\":\"user\",\"name\":\"user\",\"typeName\":\"USER\",\"parentId\":\"1\",\"parentName\":\"JIRA\n Internal\n Directory\"},\"changedValues\":[{\"fieldName\":\"email\",\"changedFrom\":\"[email protected]\",\"changedTo\":\"[email protected]\"}],\"associatedItems\":[{\"id\":\"jira-software-users\",\"name\":\"jira-software-users\",\"typeName\":\"GROUP\",\"parentId\":\"1\",\"parentName\":\"JIRA\n Internal Directory\"}]}"},
"description": "\n auditing records with all associated objects\n"
},
"400": {"description": "\n auditing records with all associated objects\n"},
"403": {"description": "\n auditing records with all associated objects\n"}
},
"parameters": [
{
"in": "query",
"name": "offset",
"description": "\n - the number of record from which search starts\n",
"type": "integer"
},
{
"in": "query",
"name": "limit",
"description": "\n - maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000)\n",
"type": "integer"
},
{
"in": "query",
"name": "filter",
"description": "\n - text query; each record that will be returned must contain the provided text in one of its fields\n",
"type": "string"
},
{
"in": "query",
"name": "from",
"description": "\n - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty\n only records that where created in the same moment or after the 'from' timestamp will be provided in response\n",
"type": "string"
},
{
"in": "query",
"name": "to",
"description": "\n - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty\n only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response\n",
"type": "string"
}
]
}},
"auth/1/session": {
"post": {
"produces": ["application/json"],
"operationId": "login",
"description": "Creates a new session for a user in JIRA. Once a session has been successfully created it can be used to access\n any of JIRA's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.\n <p>\n Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource\n may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user).",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/auth-success#",
"additionalProperties": false,
"title": "Auth Success",
"type": "object",
"properties": {
"session": {
"additionalProperties": false,
"title": "Session Info",
"type": "object",
"properties": {
"name": {"type": "string"},
"value": {"type": "string"}
}
},
"loginInfo": {
"additionalProperties": false,
"title": "Login Info",
"type": "object",
"properties": {
"failedLoginCount": {"type": "integer"},
"lastFailedLoginTime": {"type": "string"},
"loginCount": {"type": "integer"},
"previousLoginTime": {"type": "string"}
}
}
}
},
"examples": {"application/json": "\n {\"session\":{\"name\":\"seraph.rememberme.cookie\",\"value\":\"12345678901234567890\"}}"},
"description": "\n an AuthSuccess entity\n"
},
"401": {"description": "\n an AuthSuccess entity\n"},
"403": {"description": "\n an AuthSuccess entity\n"},
"409": {"description": "\n an AuthSuccess entity\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/auth-params#",
"additionalProperties": false,
"title": "Auth Params",
"type": "object",
"properties": {
"password": {"type": "string"},
"username": {"type": "string"}
}
},
"in": "body",
"name": "session"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "currentUser",
"description": "Returns information about the currently authenticated user. If the caller is not authenticated they will get a\n 401 Unauthorized status code.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/current-user#",
"additionalProperties": false,
"title": "Current User",
"type": "object",
"properties": {
"loginInfo": {
"additionalProperties": false,
"title": "Login Info",
"type": "object",
"properties": {
"failedLoginCount": {"type": "integer"},
"lastFailedLoginTime": {"type": "string"},
"loginCount": {"type": "integer"},
"previousLoginTime": {"type": "string"}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2.0/user/fred\",\"name\":\"fred\"}"},
"description": "\n JSON containing information about the current user\n"
},
"401": {"description": "\n JSON containing information about the current user\n"}
}
},
"delete": {
"produces": ["application/json"],
"operationId": "logout",
"description": "Logs the current user out of JIRA, destroying the existing session, if any.",
"responses": {
"401": {"description": "\n 401 if the called is not authenticated. NO_CONTENT if the successful.\n"},
"204": {"description": "\n 401 if the called is not authenticated. NO_CONTENT if the successful.\n"}
}
}
},
"api/2/attachment/{id}/expand/raw": {
"get": {
"produces": ["application/json"],
"operationId": "expandForMachines",
"description": "Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment-archive-impl#",
"additionalProperties": false,
"title": "Attachment Archive Impl",
"type": "object",
"properties": {
"totalEntryCount": {"type": "integer"},
"entries": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Attachment Archive Entry",
"type": "object",
"properties": {
"entryIndex": {"type": "integer"},
"size": {"type": "integer"},
"name": {"type": "string"},
"mediaType": {"type": "string"},
"abbreviatedName": {"type": "string"}
},
"required": [
"entryIndex",
"size"
]
}
}
},
"required": ["totalEntryCount"]
},
"examples": {"application/json": "\n {\"entries\":[{\"entryIndex\":0,\"name\":\"Allegro\n from Duet in C\n Major.mp3\",\"size\":1430174,\"mediaType\":\"audio/mpeg\"},{\"entryIndex\":1,\"name\":\"lrm.rtf\",\"size\":331,\"mediaType\":\"text/rtf\"}],\"totalEntryCount\":24}"},
"description": "\n A response\n"
},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"},
"409": {"description": "\n A response\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n the id of the attachment to expand.\n",
"type": "string",
"required": true
}]
},
"api/2/licenseValidator": {"post": {
"produces": ["application/json"],
"operationId": "validate",
"responses": {"": {}},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"in": "body"
}]
}},
"api/2/issue/{issueIdOrKey}/comment": {
"post": {
"produces": ["application/json"],
"operationId": "addComment",
"description": "Adds a new comment to an issue.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment#",
"additionalProperties": false,
"title": "Comment",
"type": "object",
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}},
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {"type": "string"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"body\":\"Lorem ipsum\n dolor sit amet, consectetur adipiscing elit.\n Pellentesque eget venenatis elit. Duis eu justo\n eget augue iaculis fermentum. Sed semper quam\n laoreet nisi egestas at posuere augue\n semper.\",\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:49.752+0000\",\"updated\":\"2017-05-22T07:28:49.752+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}"},
"description": "\n the added comment\n"
},
"400": {"description": "\n the added comment\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment#",
"additionalProperties": false,
"title": "Comment",
"type": "object",
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}},
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"in": "body"
},
{
"in": "query",
"name": "expand",
"description": "\n optional flags: renderedBody (provides body rendered in HTML)\n",
"type": "string"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getComments",
"description": "Returns all comments for an issue.\n <p>\n Results can be ordered by the \"created\" field which means the date a comment was added.\n <\/p>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comments-with-pagination#",
"additionalProperties": false,
"title": "Comments With Pagination",
"type": "object",
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}},
"properties": {
"total": {"type": "integer"},
"comments": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {"type": "string"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"maxResults": {"type": "integer"},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"startAt\":0,\"maxResults\":1,\"total\":1,\"comments\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"body\":\"Lorem ipsum\n dolor sit amet, consectetur adipiscing elit.\n Pellentesque eget venenatis elit. Duis eu justo\n eget augue iaculis fermentum. Sed semper quam\n laoreet nisi egestas at posuere augue\n semper.\",\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:49.752+0000\",\"updated\":\"2017-05-22T07:28:49.752+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}]}"},
"description": "\n all comments for the issue\n"
},
"404": {"description": "\n all comments for the issue\n"}
},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n the page offset, if not specified then defaults to 0\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n how many results on the page should be included. Defaults to 50.\n",
"type": "integer"
},
{
"in": "query",
"name": "orderBy",
"description": "\n ordering of the results.\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n optional flags: renderedBody (provides body rendered in HTML)\n",
"type": "string"
}
]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n to get comments for\n",
"type": "string",
"required": true
}]
},
"api/2/projectCategory": {
"post": {
"produces": ["application/json"],
"operationId": "createProjectCategory",
"description": "Create a project category via POST.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-category#",
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10100\",\"id\":\"10100\",\"name\":\"CREATED\",\"description\":\"Created\n Project Category\"}"}
},
"401": {},
"403": {},
"409": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-category#",
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllProjectCategories",
"description": "Returns all project categories",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-project-category#",
"title": "List of Project Category",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First\n Project\n Category\"},{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10001\",\"id\":\"10001\",\"name\":\"SECOND\",\"description\":\"Second\n Project Category\"}]"},
"description": "\n all project categories\n"
},
"500": {"description": "\n all project categories\n"}
}
}
},
"api/2/statuscategory": {"get": {
"produces": ["application/json"],
"operationId": "getStatusCategories",
"description": "Returns a list of all status categories",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-status-category#",
"title": "List of Status Category",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In\n Progress\"},{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}]"},
"description": "\n a full representation of the StatusCategory\n"
},
"404": {"description": "\n a full representation of the StatusCategory\n"}
}
}},
"api/2/workflow": {"get": {
"produces": ["application/json"],
"operationId": "getAllWorkflows",
"description": "Returns all workflows.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/workflow#",
"additionalProperties": false,
"title": "Workflow",
"type": "object",
"properties": {
"isDefault": {"type": "boolean"},
"lastModifiedDate": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"lastModifiedUser": {"type": "string"},
"steps": {"type": "integer"}
},
"required": ["isDefault"]
},
"description": "\n all workflows.\n"
},
"401": {"description": "\n all workflows.\n"}
},
"parameters": [{
"in": "query",
"name": "workflowName",
"description": "\n optional field where if it is set it will return the given workflow name.\n",
"type": "string"
}]
}},
"api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/move": {
"post": {
"produces": ["application/json"],
"operationId": "moveField",
"description": "Moves field on the given tab",
"responses": {
"201": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/move-field#",
"additionalProperties": false,
"title": "Move Field",
"type": "object",
"properties": {
"after": {
"format": "uri",
"type": "string"
},
"position": {
"type": "string",
"enum": [
"Earlier",
"Later",
"First",
"Last"
]
}
}
},
"in": "body"
}]
},
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "id",
"type": "string",
"required": true
}
]
},
"api/2/issue/{issueIdOrKey}/worklog/{worklogId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the worklog identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [
{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
},
{
"in": "path",
"name": "worklogId",
"description": "\n the worklog from which keys will be returned.\n",
"type": "string",
"required": true
}
]
},
"api/2/applicationrole": {"get": {
"produces": ["application/json"],
"operationId": "getAll",
"description": "Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the\n collection of ApplicationRoles.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-application-role#",
"title": "List of Application Role",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Application Role",
"type": "object",
"properties": {
"numberOfSeats": {"type": "integer"},
"userCount": {"type": "integer"},
"userCountDescription": {"type": "string"},
"defaultGroups": {
"type": "array",
"items": {"type": "string"}
},
"hasUnlimitedSeats": {"type": "boolean"},
"name": {"type": "string"},
"groups": {
"type": "array",
"items": {"type": "string"}
},
"remainingSeats": {"type": "integer"},
"key": {"type": "string"},
"selectedByDefault": {"type": "boolean"},
"defined": {"type": "boolean"},
"platform": {"type": "boolean"}
}
}
},
"examples": {"application/json": "\n [{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"name\":\"JIRA\n Software\",\"defaultGroups\":[\"jira-software-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5\n developers\",\"hasUnlimitedSeats\":false,\"platform\":false},{\"key\":\"jira-core\",\"groups\":[\"jira-core-users\"],\"name\":\"JIRA\n Core\",\"defaultGroups\":[\"jira-core-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":1,\"remainingSeats\":1,\"userCount\":0,\"userCountDescription\":\"0\n users\",\"hasUnlimitedSeats\":false,\"platform\":true}]"},
"description": "\n all ApplicationRoles in the system.\n"
},
"401": {"description": "\n all ApplicationRoles in the system.\n"},
"403": {"description": "\n all ApplicationRoles in the system.\n"}
}
}},
"api/2/issuesecurityschemes": {"get": {
"produces": ["application/json"],
"operationId": "getIssueSecuritySchemes",
"description": "Returns all issue security schemes that are defined.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-schemes#",
"additionalProperties": false,
"title": "Security Schemes",
"type": "object",
"properties": {"issueSecuritySchemes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Scheme",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"defaultSecurityLevelId": {"type": "integer"},
"id": {"type": "integer"},
"levels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
}
}
}
}}
},
"examples": {"application/json": "\n {\"issueSecuritySchemes\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issuesecurityschemes/1000\",\"id\":1000,\"name\":\"Default\n Issue Security Scheme\",\"description\":\"Description\n for the default issue security\n scheme\",\"defaultSecurityLevelId\":10021}]}"},
"description": "\n an object containing a collection of issue security schemes\n"
},
"401": {"description": "\n an object containing a collection of issue security schemes\n"},
"403": {"description": "\n an object containing a collection of issue security schemes\n"}
}
}},
"api/2/universal_avatar/type/{type}/owner/{entityId}": {
"post": {
"produces": ["application/json"],
"operationId": "storeAvatar",
"description": "Creates an avatar for a given entity, for the given entity ID and type of entity. For example, you can create an\n avatar for an issue type, given the issue type Id. Uploading an avatar is supported for different types of entities\n across the JIRA products. However, it is supported for the \"project\" and \"issuetype\" entity types for all JIRA products.\n The uploaded image will be cropped according to the crop parameters listed below. If no crop parameters are specified,\n the image will be cropped to a square. The square will originate at the top left of the image and the length of\n each side will be set to the smaller of the height or width of the image.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/avatar#",
"additionalProperties": false,
"title": "Avatar",
"type": "object",
"properties": {
"owner": {"type": "string"},
"isDeletable": {"type": "boolean"},
"urls": {
"patternProperties": {"\\d\\dx\\d\\d": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"isSystemAvatar": {"type": "boolean"},
"isSelected": {"type": "boolean"},
"id": {"type": "string"},
"selected": {"type": "boolean"}
},
"required": [
"isSystemAvatar",
"isSelected",
"isDeletable",
"selected"
]
},
"examples": {"application/json": "\n {\"id\":\"1000\",\"owner\":\"fred\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"http://localhost:8090/jira/secure/useravatar?size=xsmall&avatarId=10040\",\"24x24\":\"http://localhost:8090/jira/secure/useravatar?size=small&avatarId=10040\",\"32x32\":\"http://localhost:8090/jira/secure/useravatar?size=medium&avatarId=10040\",\"48x48\":\"http://localhost:8090/jira/secure/useravatar?avatarId=10040\"},\"selected\":false}"}
},
"400": {},
"401": {},
"403": {},
"404": {}
},
"parameters": [
{
"in": "query",
"name": "x",
"description": "\n (optional) The X coordinate of the top-left corner of the crop region. Default: 0.\n",
"type": "integer"
},
{
"in": "query",
"name": "y",
"description": "\n (optional) The Y coordinate of the top-left corner of the crop region. Default: 0.\n",
"type": "integer"
},
{
"in": "query",
"name": "size",
"description": "\n (optional) The length of each side of the crop region. The crop region can only be a square.\n If omitted and the top-left corner is at (0,0), this defaults to either the height or width\n of the image, whichever is smaller.\n",
"type": "integer"
}
]
},
"parameters": [
{
"in": "path",
"name": "entityId",
"description": "\n The Id of the entity that you want to update the avatar of.\n",
"type": "string",
"required": true
},
{
"in": "path",
"name": "type",
"description": "\n The type of the entity that you want to update the avatar of. Valid values: project, issuetype.\n",
"type": "string",
"required": true
}
]
},
"api/2/project/type": {"get": {
"produces": ["application/json"],
"operationId": "getAllProjectTypes",
"description": "Returns all the project types defined on the JIRA instance, not taking into account whether\n the license to use those project types is valid or not.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-project-type#",
"title": "List of Project Type",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project Type",
"type": "object",
"properties": {
"descriptionI18nKey": {"type": "string"},
"color": {"type": "string"},
"icon": {"type": "string"},
"key": {"type": "string"},
"formattedKey": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"Project\n type for business\n projects\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"Project\n type for software\n projects\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]"},
"description": "\n All project types defined on the JIRA instance.\n"
}}
}},
"api/2/issue/{issueIdOrKey}/worklog": {
"post": {
"produces": ["application/json"],
"operationId": "addWorklog",
"description": "Adds a new worklog entry to an issue.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog#",
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}},
"properties": {
"issueId": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"started": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {
"format": "uri",
"type": "string"
},
"comment": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"description": "\n the added worklog\n"
},
"400": {"description": "\n the added worklog\n"},
"403": {"description": "\n the added worklog\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog#",
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}},
"properties": {
"issueId": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"comment": {"type": "string"},
"started": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"in": "body",
"name": "worklog"
},
{
"in": "query",
"name": "adjustEstimate",
"description": "\n (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are\n <ul>\n <li>\"new\" - sets the estimate to a specific value<\/li>\n <li>\"leave\"- leaves the estimate as is<\/li>\n <li>\"manual\" - specify a specific amount to increase remaining estimate by<\/li>\n <li>\"auto\"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog<\/li> <\/ul>\n",
"type": "string"
},
{
"in": "query",
"name": "newEstimate",
"description": "\n (required when \"new\" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. \"2d\"\n",
"type": "string"
},
{
"in": "query",
"name": "reduceBy",
"description": "\n (required when \"manual\" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. \"2d\"\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getIssueWorklog",
"description": "Returns all work logs for an issue. <br/>\n <strong>Note:<\/strong> Work logs won't be returned if the Log work field is hidden for the project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-with-pagination#",
"additionalProperties": false,
"title": "Worklog With Pagination",
"type": "object",
"definitions": {"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}},
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"startAt": {"type": "integer"},
"worklogs": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"timeSpent": {"type": "string"},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"started": {"type": "string"},
"timeSpentSeconds": {"type": "integer"},
"updateAuthor": {"$ref": "#/definitions/user"},
"self": {
"format": "uri",
"type": "string"
},
"comment": {"type": "string"},
"id": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
}
}
},
"examples": {"application/json": "\n {\"startAt\":0,\"maxResults\":1,\"total\":1,\"worklogs\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"updateAuthor\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F. User\",\"active\":false},\"comment\":\"I did some\n work\n here.\",\"updated\":\"2017-05-22T07:28:50.833+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2017-05-22T07:28:50.833+0000\",\"timeSpent\":\"3h\n 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]}"},
"description": "\n All worklogs for the issue\n"
},
"404": {"description": "\n All worklogs for the issue\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n a string containing the issue id or key the worklog will be added to\n",
"type": "string",
"required": true
}]
},
"api/2/issue/{issueIdOrKey}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the issue identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n the issue from which keys will be returned.\n",
"type": "string",
"required": true
}]
},
"api/2/dashboard": {"get": {
"produces": ["application/json"],
"operationId": "list",
"description": "Returns a list of all dashboards, optionally filtering them.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/dashboards#",
"additionalProperties": false,
"title": "Dashboards",
"type": "object",
"properties": {
"next": {"type": "string"},
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"prev": {"type": "string"},
"dashboards": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Dashboard",
"type": "object",
"properties": {
"view": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"}
}
}
},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"startAt\":10,\"maxResults\":10,\"total\":143,\"prev\":\"http://www.example.com/jira/rest/api/2/dashboard?startAt=0\",\"next\":\"http://www.example.com/jira/rest/api/2/dashboard?startAt=10\",\"dashboards\":[{\"id\":\"10000\",\"self\":\"http://www.example.com/jira/rest/api/2/dashboard/10000\",\"name\":\"System\n Dashboard\",\"view\":\"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=10000\"},{\"id\":\"20000\",\"self\":\"http://www.example.com/jira/rest/api/2/dashboard/20000\",\"name\":\"Build\n Engineering\",\"view\":\"http://www.example.com/jira/secure/Dashboard.jspa?selectPageId=20000\"}]}"},
"description": "\n a list of Dashboards\n"
}},
"parameters": [
{
"in": "query",
"name": "filter",
"description": "\n an optional filter that is applied to the list of dashboards. Valid values include\n <code>\"favourite\"<\/code> for returning only favourite dashboards, and <code>\"my\"<\/code> for returning\n dashboards that are owned by the calling user.\n",
"type": "string"
},
{
"in": "query",
"name": "startAt",
"description": "\n the index of the first dashboard to return (0-based). must be 0 or a multiple of\n <code>maxResults<\/code>\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n a hint as to the the maximum number of dashboards to return in each call. Note that the\n JIRA server reserves the right to impose a <code>maxResults<\/code> limit that is lower than the value that a\n client provides, dues to lack or resources or any other condition. When this happens, your results will be\n truncated. Callers should always check the returned <code>maxResults<\/code> to determine the value that is\n effectively being used.\n",
"type": "integer"
}
]
}},
"api/2/task/{taskId}/cancel": {
"post": {
"produces": ["application/json"],
"operationId": "requestCancel",
"description": "Requests that the task that corresponds to the given task id is cancelled.",
"responses": {
"202": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/response#",
"title": "Response",
"type": "object"
}},
"401": {},
"403": {},
"404": {}
}
},
"parameters": [{
"in": "path",
"name": "taskId",
"type": "string",
"required": true
}]
},
"api/2/search": {
"post": {
"produces": ["application/json"],
"operationId": "searchUsingSearchRequest",
"description": "Performs a search using JQL.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/search-results#",
"additionalProperties": false,
"title": "Search Results",
"type": "object",
"definitions": {
"history-metadata-participant": {
"additionalProperties": false,
"title": "History Metadata Participant",
"type": "object",
"properties": {
"avatarUrl": {"type": "string"},
"displayName": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"displayNameKey": {"type": "string"},
"url": {"type": "string"}
}
},
"field-meta": {
"additionalProperties": false,
"title": "Field Meta",
"type": "object",
"properties": {
"schema": {"$ref": "#/definitions/json-type"},
"hasDefaultValue": {"type": "boolean"},
"allowedValues": {
"type": "array",
"items": {}
},
"operations": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {},
"name": {"type": "string"},
"autoCompleteUrl": {"type": "string"},
"required": {"type": "boolean"},
"key": {"type": "string"}
},
"required": ["required"]
},
"link-group": {
"additionalProperties": false,
"title": "Link Group",
"type": "object",
"properties": {
"header": {"$ref": "#/definitions/simple-link"},
"weight": {"type": "integer"},
"groups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
},
"links": {
"type": "array",
"items": {"$ref": "#/definitions/simple-link"}
},
"id": {"type": "string"},
"styleClass": {"type": "string"}
}
},
"json-type": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"simple-link": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"warningMessages": {
"type": "array",
"items": {"type": "string"}
},
"expand": {"type": "string"},
"total": {"type": "integer"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"maxResults": {"type": "integer"},
"issues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"editmeta": {
"additionalProperties": false,
"title": "Edit Meta",
"type": "object",
"properties": {"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}}
},
"fieldsToInclude": {
"title": "Included Fields",
"type": "object"
},
"changelog": {
"additionalProperties": false,
"title": "Changelog",
"type": "object",
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"histories": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"transitions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"hasScreen": {"type": "boolean"},
"expand": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}
}
}
},
"renderedFields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"expand": {"type": "string"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"operations": {
"additionalProperties": false,
"title": "Opsbar",
"type": "object",
"properties": {"linkGroups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
}}
},
"versionedRepresentations": {
"patternProperties": {".+": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"key": {"type": "string"},
"properties": {
"additionalProperties": false,
"title": "Properties",
"type": "object",
"properties": {"properties": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10001\",\"self\":\"http://www.example.com/jira/rest/api/2/issue/10001\",\"key\":\"HSP-1\"}],\"warningMessages\":[\"The\n value 'splat' does not exist for the field\n 'Foo'.\"]}"},
"description": "\n a SearchResultsBean\n"
},
"400": {"description": "\n a SearchResultsBean\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/search-request#",
"additionalProperties": false,
"title": "Search Request",
"type": "object",
"properties": {
"jql": {"type": "string"},
"maxResults": {"type": "integer"},
"validateQuery": {"type": "string"},
"fieldsByKeys": {"type": "boolean"},
"fields": {
"type": "array",
"items": {"type": "string"}
},
"startAt": {"type": "integer"},
"properties": {
"type": "array",
"items": {"type": "string"}
}
},
"required": ["fieldsByKeys"]
},
"in": "body",
"name": "searchRequestBean"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "search",
"description": "Searches for issues using JQL.\n <p>\n <b>Sorting<\/b>:\n the <code>jql<\/code> parameter is a full <a href=\"http://confluence.atlassian.com/display/JIRA/Advanced+Searching\">JQL<\/a>\n expression which can include an <code>ORDER BY<\/code> clause.\n\n <p>\n <b>Fields<\/b>:\n The <code>fields<\/code> param (which can be specified multiple times) gives a comma-separated list of fields\n to include in the response. This can be used to retrieve a subset of fields.\n A particular field can be excluded by prefixing it with a minus.\n\n <p>\n By default, only navigable (<code>*navigable<\/code>) fields are returned in this search resource. Note: the default is different\n in the get-issue resource -- the default there all fields (<code>*all<\/code>).\n <ul>\n <li><code>*all<\/code> - include all fields<\/li>\n <li><code>*navigable<\/code> - include just navigable fields<\/li>\n <li><code>summary,comment<\/code> - include just the summary and comments<\/li>\n <li><code>-description<\/code> - include navigable fields except the description (the default is <code>*navigable<\/code> for search)<\/li>\n <li><code>*all,-comment<\/code> - include everything except comments<\/li>\n <\/ul>\n\n <p>\n <b>Properties<\/b>:\n The <code>properties<\/code> param is similar to <code>fields<\/code> and specifies a comma-separated list of issue\n properties to include. Unlike <code>fields<\/code>, properties are not included by default.\n It is also not allowed to request all properties.\n The number of different properties that may be requested in one query is limited to 5.\n\n <ul>\n <li><code>prop1,prop1<\/code> - include <code>prop1<\/code> and <code>prop2<\/code> properties <\/li>\n <\/ul>\n\n <p>\n\n <b>Query Validation<\/b>:\n The <code>validateQuery<\/code> param offers control over whether to validate and how strictly to treat the validation.\n <ul>\n <li><code>strict<\/code> - Strict validation: if any errors are found then a 400 will be returned with a list of all\n errors (and warnings).<\/li>\n <li><code>warn<\/code> - we validate, but all errors are demoted to warnings.<\/li>\n <li><code>none<\/code> - no validation is run.<\/li>\n <li><code>true<\/code> - <em>deprecated<\/em>. A legacy synonym for \"strict\".<\/li>\n <li><code>false<\/code> - <em>deprecated<\/em>. For legacy reasons this acts like \"warn\".<\/li>\n <\/ul>\n The default value is \"strict\". Note that this setting only effects semantic validation of the given JQL. If the JQL\n is syntactically invalid, we will not even be able to parse it and a 400 will be raised no matter what validateQuery value is given.\n\n\n <p><b>GET vs POST<\/b>:\n If the JQL query is too large to be encoded as a query param you should instead\n POST to this resource.\n\n <p>\n <b>Expanding Issues in the Search Result:<\/b>\n It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed\n in to this resources.\n\n <p>\n For instance, to expand the &quot;changelog&quot; for all the issues on the search result, it is neccesary to\n specify &quot;changelog&quot; as one of the values to expand.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/search-results#",
"additionalProperties": false,
"title": "Search Results",
"type": "object",
"definitions": {
"history-metadata-participant": {
"additionalProperties": false,
"title": "History Metadata Participant",
"type": "object",
"properties": {
"avatarUrl": {"type": "string"},
"displayName": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"displayNameKey": {"type": "string"},
"url": {"type": "string"}
}
},
"field-meta": {
"additionalProperties": false,
"title": "Field Meta",
"type": "object",
"properties": {
"schema": {"$ref": "#/definitions/json-type"},
"hasDefaultValue": {"type": "boolean"},
"allowedValues": {
"type": "array",
"items": {}
},
"operations": {
"type": "array",
"items": {"type": "string"}
},
"defaultValue": {},
"name": {"type": "string"},
"autoCompleteUrl": {"type": "string"},
"required": {"type": "boolean"},
"key": {"type": "string"}
},
"required": ["required"]
},
"link-group": {
"additionalProperties": false,
"title": "Link Group",
"type": "object",
"properties": {
"header": {"$ref": "#/definitions/simple-link"},
"weight": {"type": "integer"},
"groups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
},
"links": {
"type": "array",
"items": {"$ref": "#/definitions/simple-link"}
},
"id": {"type": "string"},
"styleClass": {"type": "string"}
}
},
"json-type": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"simple-link": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"warningMessages": {
"type": "array",
"items": {"type": "string"}
},
"expand": {"type": "string"},
"total": {"type": "integer"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"maxResults": {"type": "integer"},
"issues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"editmeta": {
"additionalProperties": false,
"title": "Edit Meta",
"type": "object",
"properties": {"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}}
},
"fieldsToInclude": {
"title": "Included Fields",
"type": "object"
},
"changelog": {
"additionalProperties": false,
"title": "Changelog",
"type": "object",
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"histories": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"transitions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"hasScreen": {"type": "boolean"},
"expand": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}
}
}
},
"renderedFields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"expand": {"type": "string"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"operations": {
"additionalProperties": false,
"title": "Opsbar",
"type": "object",
"properties": {"linkGroups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
}}
},
"versionedRepresentations": {
"patternProperties": {".+": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"key": {"type": "string"},
"properties": {
"additionalProperties": false,
"title": "Properties",
"type": "object",
"properties": {"properties": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10001\",\"self\":\"http://www.example.com/jira/rest/api/2/issue/10001\",\"key\":\"HSP-1\"}],\"warningMessages\":[\"The\n value 'splat' does not exist for the field\n 'Foo'.\"]}"},
"description": "\n a SearchResultsBean\n"
},
"400": {"description": "\n a SearchResultsBean\n"}
},
"parameters": [
{
"in": "query",
"name": "jql",
"description": "\n a JQL query string\n",
"type": "string"
},
{
"in": "query",
"name": "startAt",
"description": "\n the index of the first issue to return (0-based)\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n the maximum number of issues to return (defaults to 50). The maximum allowable value is\n dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this\n number, your search results will be truncated.\n",
"type": "integer"
},
{
"in": "query",
"name": "validateQuery",
"description": "\n Whether to validate the JQL query and how strictly to treat the validation results.\n Supported values: \"strict\", \"warn\", \"none\" + legacy synonyms \"true\" and \"false\"\n",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "\n the list of fields to return for each issue. By default, all navigable fields are returned.\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n A comma-separated list of the parameters to expand.\n",
"type": "string"
},
{
"in": "query",
"name": "properties",
"description": "\n the list of properties to return for each issue. By default no properties are returned.\n",
"type": "string"
},
{
"in": "query",
"name": "fieldsByKeys",
"description": "\n if true then fields in issues will be referenced by keys instead of ids\n",
"type": "boolean"
}
]
}
},
"api/2/project/{projectKeyOrId}/issuesecuritylevelscheme": {
"get": {
"produces": ["application/json"],
"operationId": "getIssueSecurityScheme",
"description": "Returns the issue security scheme for project.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/security-scheme#",
"additionalProperties": false,
"title": "Security Scheme",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"defaultSecurityLevelId": {"type": "integer"},
"id": {"type": "integer"},
"levels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Security Level",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"}
}
}
}
}
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issuesecurityschemes/1000\",\"id\":1000,\"name\":\"Default\n Issue Security Scheme\",\"description\":\"Description\n for the default issue security\n scheme\",\"defaultSecurityLevelId\":10021,\"levels\":[{\"self\":\"http://www.example.com/jira/rest/api/2/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only\n the reporter and internal staff can see this\n issue.\",\"name\":\"Reporter Only\"}]}"},
"description": "\n an object containing an issue security scheme.\n"
},
"401": {"description": "\n an object containing an issue security scheme.\n"},
"403": {"description": "\n an object containing an issue security scheme.\n"},
"404": {"description": "\n an object containing an issue security scheme.\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"type": "string",
"required": true
}]
},
"api/2/issuetype": {
"post": {
"produces": ["application/json"],
"operationId": "createIssueType",
"description": "Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue\n type scheme.",
"responses": {
"201": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-type#",
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}},
"400": {},
"401": {},
"403": {},
"409": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-type-create#",
"additionalProperties": false,
"title": "Issue Type Create",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"type": {
"type": "string",
"enum": [
"subtask",
"standard"
]
}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getIssueAllTypes",
"description": "Returns a list of all issue types visible to the user",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-issue-type#",
"title": "List of Issue Type",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"examples": {"application/json": "\n [{\"self\":\"http://localhost:8090/jira/rest/api/2.0/issueType/3\",\"id\":\"3\",\"description\":\"A\n task that needs to be\n done.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/issuetypes/task.png\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://localhost:8090/jira/rest/api/2.0/issueType/1\",\"id\":\"1\",\"description\":\"A\n problem with the\n software.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/issuetypes/bug.png\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002}]"},
"description": "\n a list of issue types\n"
}}
}
},
"api/2/screens/{screenId}/tabs/{tabId}": {
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
}
],
"delete": {
"produces": ["application/json"],
"operationId": "deleteTab",
"description": "Deletes tab to give screen",
"responses": {
"201": {"description": "\n A response containing no content\n"},
"400": {"description": "\n A response containing no content\n"},
"401": {"description": "\n A response containing no content\n"}
}
},
"put": {
"produces": ["application/json"],
"operationId": "renameTab",
"description": "Renames tab on given screen",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "{\"id\":10000,\"name\":\"Fields\n Tab\"}"},
"description": "\n a response containing renamed tab\n"
},
"400": {"description": "\n a response containing renamed tab\n"},
"401": {"description": "\n a response containing renamed tab\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"in": "body"
}]
}
},
"api/2/attachment/meta": {"get": {
"produces": ["application/json"],
"operationId": "getAttachmentMeta",
"description": "Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size\n allowed.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment-meta#",
"additionalProperties": false,
"title": "Attachment Meta",
"type": "object",
"properties": {
"uploadLimit": {"type": "integer"},
"enabled": {"type": "boolean"}
},
"required": ["enabled"]
},
"examples": {"application/json": "\n {\"enabled\":true,\"uploadLimit\":1000000}"},
"description": "\n a JSON representation of the enable attachment capabilities\n"
}}
}},
"api/2/field": {
"post": {
"produces": ["application/json"],
"operationId": "createCustomField",
"description": "Creates a custom field using a definition (object encapsulating custom field data)",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/field#",
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"examples": {"application/json": "{\"id\":\"customfield_10101\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}}"},
"description": "\n Response with information about created field\n"
},
"400": {"description": "\n Response with information about created field\n"},
"500": {"description": "\n Response with information about created field\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/custom-field-definition#",
"additionalProperties": false,
"title": "Custom Field Definition",
"type": "object",
"properties": {
"searcherKey": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"type": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getFields",
"description": "Returns a list of all fields, both System and Custom",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-field#",
"title": "List of Field",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
}
},
"examples": {"application/json": "\n [{\"id\":\"description\",\"name\":\"Description\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"description\"],\"schema\":{\"type\":\"string\",\"system\":\"description\"}},{\"id\":\"summary\",\"key\":\"summary\",\"name\":\"Summary\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"summary\"],\"schema\":{\"type\":\"string\",\"system\":\"summary\"}}]"},
"description": "\n a response containing all fields as short Field Meta Beans\n"
}}
}
},
"api/2/project/{projectKeyOrId}/notificationscheme": {
"get": {
"produces": ["application/json"],
"operationId": "getNotificationScheme",
"description": "Gets a notification scheme associated with the project.\n Follow the documentation of /notificationscheme/{id} resource for all details about returned value.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/notification-scheme#",
"additionalProperties": false,
"title": "Notification Scheme",
"type": "object",
"definitions": {
"group-notification": {
"additionalProperties": false,
"title": "Group Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"custom-field-value-notification": {
"additionalProperties": false,
"title": "Custom Field Value Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"email-notification": {
"additionalProperties": false,
"title": "Email Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"emailAddress": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"notification-event": {
"additionalProperties": false,
"title": "Notification Event",
"type": "object",
"properties": {
"templateEvent": {"$ref": "#/definitions/notification-event"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"role-notification": {
"additionalProperties": false,
"title": "Role Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"project-role-notification": {
"additionalProperties": false,
"title": "Project Role Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"user-notification": {
"additionalProperties": false,
"title": "User Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
}
}
},
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"},
"notificationSchemeEvents": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Notification Scheme Event",
"type": "object",
"properties": {
"event": {"$ref": "#/definitions/notification-event"},
"notifications": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/custom-field-value-notification"},
{"$ref": "#/definitions/email-notification"},
{"$ref": "#/definitions/group-notification"},
{"$ref": "#/definitions/project-role-notification"},
{"$ref": "#/definitions/role-notification"},
{"$ref": "#/definitions/user-notification"}
],
"title": "Notification",
"type": "object"
}
}
}
}
}
}
},
"examples": {"application/json": "\n {\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://example.com/jira/rest/api/2/notificationscheme/10010\",\"name\":\"notification\n scheme\n name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom\n event\",\"description\":\"Custom event which is\n published together with issue created\n event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}"},
"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"
},
"401": {"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"},
"403": {"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"},
"404": {"description": "\n The associated notification scheme if successful, appropriate error otherwise.\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "projectKeyOrId",
"description": "\n key or id of the project\n",
"type": "string",
"required": true
}]
},
"api/2/role": {
"post": {
"produces": ["application/json"],
"operationId": "createProjectRole",
"description": "Creates a new ProjectRole to be available in JIRA.\n The created role does not have any default actors assigned.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-role#",
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\"}"},
"description": "\n Returns full details of the created role\n"
},
"400": {"description": "\n Returns full details of the created role\n"},
"401": {"description": "\n Returns full details of the created role\n"},
"403": {"description": "\n Returns full details of the created role\n"},
"409": {"description": "\n Returns full details of the created role\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/create-update-role-request#",
"additionalProperties": false,
"title": "Create Update Role Request",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getProjectRoles",
"description": "Get all the ProjectRoles available in JIRA. Currently this list is global.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-role#",
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\"}"},
"description": "\n Returns full details of the roles available in JIRA.\n"
},
"401": {"description": "\n Returns full details of the roles available in JIRA.\n"},
"403": {"description": "\n Returns full details of the roles available in JIRA.\n"}
}
}
},
"api/2//userProperties": {
"post": {
"produces": ["application/json"],
"operationId": "setProperty",
"responses": {"": {}},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/property#",
"additionalProperties": false,
"title": "Property",
"type": "object",
"properties": {
"value": {"type": "string"},
"key": {"type": "string"},
"status": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getProperty",
"responses": {"": {}},
"parameters": [{
"in": "query",
"name": "key",
"type": "string"
}]
},
"delete": {
"produces": ["application/json"],
"operationId": "deleteProperty",
"responses": {"": {}},
"parameters": [{
"in": "query",
"name": "key",
"type": "string"
}]
}
},
"api/2/attachment/{id}/expand/human": {
"get": {
"produces": ["application/json"],
"operationId": "expandForHumans",
"description": "Tries to expand an attachment. Output is human-readable and subject to change.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/human-readable-archive#",
"additionalProperties": false,
"title": "Human Readable Archive",
"type": "object",
"properties": {
"totalEntryCount": {"type": "integer"},
"entries": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Human Readable Archive Entry",
"type": "object",
"properties": {
"path": {"type": "string"},
"size": {"type": "string"},
"index": {"type": "integer"},
"mediaType": {"type": "string"},
"label": {"type": "string"}
},
"required": ["index"]
}
},
"name": {"type": "string"},
"mediaType": {"type": "string"},
"id": {"type": "integer"}
},
"required": [
"id",
"totalEntryCount"
]
},
"examples": {"application/json": "\n {\"id\":7237823,\"name\":\"images.zip\",\"entries\":[{\"path\":\"MG00N067.JPG\",\"index\":0,\"size\":\"119\n kB\",\"mediaType\":\"image/jpeg\",\"label\":\"MG00N067.JPG\"},{\"path\":\"Allegro\n from Duet in C\n Major.mp3\",\"index\":1,\"size\":\"1.36\n MB\",\"mediaType\":\"audio/mpeg\",\"label\":\"Allegro\n from Duet in C\n Major.mp3\"},{\"path\":\"long/path/thanks/to/lots/of/subdirectories/inside/making/it/quite/hard/to/reach/the/leaf.txt\",\"index\":2,\"size\":\"0.0\n k\",\"mediaType\":\"text/plain\",\"label\":\"long/path/thanks/to/.../reach/the/leaf.txt\"}],\"totalEntryCount\":39,\"mediaType\":\"application/zip\"}"},
"description": "\n A response\n"
},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"},
"409": {"description": "\n A response\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n the id of the attachment to expand.\n",
"type": "string",
"required": true
}]
},
"api/2/worklog/deleted": {"get": {
"produces": ["application/json"],
"operationId": "getIdsOfWorklogsDeletedSince",
"description": "Returns worklogs id and delete time of worklogs that was deleted since given time.\n The returns set of worklogs is limited to 1000 elements.\n This API will not return worklogs deleted during last minute.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-changed-since#",
"additionalProperties": false,
"title": "Worklog Changed Since",
"type": "object",
"properties": {
"nextPage": {
"format": "uri",
"type": "string"
},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog Change",
"type": "object",
"properties": {
"updatedTime": {"type": "integer"},
"worklogId": {"type": "integer"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"isLastPage": {"type": "boolean"},
"self": {
"format": "uri",
"type": "string"
},
"until": {"type": "integer"},
"since": {"type": "integer"}
},
"required": ["isLastPage"]
},
"examples": {"application/json": "\n {\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://www.example.com/jira/worklog/updated/updated/deleted?since=1438013671136&since=1438013693136&since=1438013671136\",\"nextPage\":\"http://www.example.com/jira/worklog/updated/updated/deleted/deleted?since=1438013671136&since=1438013693136&since=1438013671136&since=1438013693136\",\"lastPage\":true}"},
"description": "\n a set of worklogs id and delete time.\n"
}},
"parameters": [{
"in": "query",
"name": "since",
"description": "\n a date time in unix timestamp format since when deleted worklogs will be returned.\n",
"type": "integer"
}]
}},
"api/2/issueLink": {"post": {
"produces": ["application/json"],
"operationId": "linkIssues",
"description": "Creates an issue link between two issues.\n The user requires the link issue permission for the issue which will be linked to another issue.\n The specified link type in the request is used to create the link and will create a link from the first issue\n to the second issue using the outward description. It also create a link from the second issue to the first issue using the\n inward description of the issue link type.\n It will add the supplied comment to the first issue. The comment can have a restriction who can view it.\n If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment.\n The user who creates the issue link needs to belong to the specified group or have the specified role.",
"responses": {
"201": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"400": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"401": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"500": {"description": "\n a response indicating if the issue link was created successfully.\n"},
"404": {"description": "\n a response indicating if the issue link was created successfully.\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/link-issue-request#",
"additionalProperties": false,
"title": "Link Issue Request",
"type": "object",
"definitions": {
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"issue-ref": {
"additionalProperties": false,
"title": "Issue Ref",
"type": "object",
"properties": {
"id": {"type": "string"},
"fields": {
"additionalProperties": false,
"title": "Fields",
"type": "object",
"properties": {
"summary": {"type": "string"},
"issuetype": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
},
"priority": {
"additionalProperties": false,
"title": "Priority",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"}
}
},
"status": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
}
}
},
"key": {"type": "string"}
}
}
},
"properties": {
"outwardIssue": {"$ref": "#/definitions/issue-ref"},
"comment": {
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"renderedBody": {"type": "string"},
"visibility": {
"additionalProperties": false,
"title": "Visibility",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"group",
"role"
]
},
"value": {"type": "string"}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"type": "string"},
"updateAuthor": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"body": {"type": "string"},
"updated": {"type": "string"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
},
"inwardIssue": {"$ref": "#/definitions/issue-ref"},
"type": {
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"outward": {"type": "string"}
}
}
}
},
"in": "body"
}]
}},
"api/2/priority": {"get": {
"produces": ["application/json"],
"operationId": "getPriorities",
"description": "Returns a list of all issue priorities.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-priority#",
"title": "List of Priority",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Priority",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major\n loss of\n function.\",\"iconUrl\":\"http://www.example.com/jira/images/icons/priorities/major.png\",\"name\":\"Major\"},{\"self\":\"http://www.example.com/jira/rest/api/2/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very\n little\n impact.\",\"iconUrl\":\"http://www.example.com/jira/images/icons/priorities/trivial.png\",\"name\":\"Trivial\"}]"},
"description": "\n a list of Jira Priorities\n"
}}
}},
"api/2/group": {
"post": {
"produces": ["application/json"],
"operationId": "createGroup",
"description": "Creates a group by given group parameter\n <p>\n Returns REST representation for the requested group.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/group#",
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"users": {
"additionalProperties": false,
"title": "Paged List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"end-index": {"type": "integer"},
"start-index": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
}
},
"required": [
"size",
"max-results",
"start-index",
"end-index"
]
}
}
},
"examples": {"application/json": "\n {\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\",\"users\":{\"size\":1,\"items\":[{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false}],\"max-results\":50,\"start-index\":0,\"end-index\":0},\"expand\":\"users\"}"},
"description": "\n REST representation of a group\n"
},
"400": {"description": "\n REST representation of a group\n"},
"401": {"description": "\n REST representation of a group\n"},
"403": {"description": "\n REST representation of a group\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/add-group#",
"additionalProperties": false,
"title": "Add Group",
"type": "object",
"properties": {"name": {"type": "string"}}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getGroup",
"description": "Returns REST representation for the requested group. Allows to get list of active users belonging to the\n specified group and its subgroups if \"users\" expand option is provided. You can page through users list by using\n indexes in expand param. For example to get users from index 10 to index 15 use \"users[10:15]\" expand value. This\n will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.\n <p>\n This resource is deprecated, please use group/member API instead.",
"responses": {"": {}},
"parameters": [
{
"in": "query",
"name": "groupname",
"description": "\n A name of requested group.\n",
"type": "string"
},
{
"in": "query",
"name": "expand",
"description": "\n List of fields to expand. Currently only available expand is \"users\".\n",
"type": "string"
}
]
},
"delete": {
"produces": ["application/json"],
"operationId": "removeGroup",
"description": "Deletes a group by given group parameter.\n <p>\n Returns no content",
"responses": {
"200": {"description": "\n no content\n"},
"400": {"description": "\n no content\n"},
"401": {"description": "\n no content\n"},
"403": {"description": "\n no content\n"},
"404": {"description": "\n no content\n"}
},
"parameters": [
{
"in": "query",
"name": "groupname",
"description": "\n (mandatory) The name of the group to delete.\n",
"type": "string"
},
{
"in": "query",
"name": "swapGroup",
"description": "\n If you delete a group and content is restricted to that group, the content will be hidden from all users. \n To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.\n",
"type": "string"
}
]
}
},
"api/2/component": {"post": {
"produces": ["application/json"],
"operationId": "createComponent",
"description": "Create a component via POST.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/component#",
"additionalProperties": false,
"title": "Component",
"type": "object",
"definitions": {
"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
}
},
"properties": {
"leadUserName": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"realAssignee": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"}
},
"required": ["isAssigneeTypeValid"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/component/10000\",\"id\":\"10000\",\"name\":\"Component\n 1\",\"description\":\"This is a JIRA\n component\",\"lead\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}"}
},
"401": {},
"403": {},
"404": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/component#",
"additionalProperties": false,
"title": "Component",
"type": "object",
"definitions": {
"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {"name": {"type": "string"}}
}
}
},
"required": ["size"]
},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
}
},
"properties": {
"leadUserName": {"type": "string"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"realAssignee": {"$ref": "#/definitions/user"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"},
"lead": {"$ref": "#/definitions/user"}
},
"required": ["isAssigneeTypeValid"]
},
"in": "body",
"name": "component"
}]
}},
"api/2/reindex/request": {"post": {
"produces": ["application/json"],
"operationId": "processRequests",
"description": "Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests\n that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through\n other REST calls.",
"responses": {"200": {
"schema": {
"type": "array",
"items": {"type": "integer"}
},
"description": "\n JSON array containing the IDs of the reindex requests that are being processed.\n"
}}
}},
"api/2/reindex": {
"post": {
"produces": ["application/json"],
"operationId": "reindex",
"description": "Kicks off a reindex. Need Admin permissions to perform this reindex.\n <p>\n Note that some versions of JIRA may no longer require manual reindexing.\n In this case, this resource will no-op: a 200 OK response code will returned along with \"progress details\" that\n indicate the work is complete (progress=100%). Subsequent GETs will return 404 to indicate no actua reindex has\n taken place.\n <p>\n In the case that an index is actually triggered, this call will be asynchronous: it will return 202 immediately\n and then the caller can call GET on the resource to track progress of the task.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/reindex#",
"additionalProperties": false,
"title": "Reindex",
"type": "object",
"properties": {
"currentProgress": {"type": "integer"},
"currentSubTask": {"type": "string"},
"finishTime": {"type": "string"},
"progressUrl": {"type": "string"},
"submittedTime": {"type": "string"},
"success": {"type": "boolean"},
"startTime": {"type": "string"},
"type": {
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND",
"BACKGROUND_PREFFERED",
"BACKGROUND_PREFERRED"
]
}
},
"required": ["success"]
},
"examples": {"application/json": "\n {\"progressUrl\":\"/secure/admin/jira/IndexProgress.jspa?taskId=10000\",\"currentProgress\":50,\"currentSubTask\":\"Currently\n reindexing Change\n History\",\"type\":\"FOREGROUND\",\"submittedTime\":\"2017-05-22T07:28:49.664+0000\",\"startTime\":\"2017-05-22T07:28:49.664+0000\",\"finishTime\":\"2017-05-22T07:28:49.664+0000\",\"success\":false}"},
"description": "\n Response that provides a redirect to the GET.\n"
},
"202": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/reindex#",
"additionalProperties": false,
"title": "Reindex",
"type": "object",
"properties": {
"currentProgress": {"type": "integer"},
"currentSubTask": {"type": "string"},
"finishTime": {"type": "string"},
"progressUrl": {"type": "string"},
"submittedTime": {"type": "string"},
"success": {"type": "boolean"},
"startTime": {"type": "string"},
"type": {
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND",
"BACKGROUND_PREFFERED",
"BACKGROUND_PREFERRED"
]
}
},
"required": ["success"]
},
"examples": {"application/json": "\n {\"progressUrl\":\"/secure/admin/jira/IndexProgress.jspa?taskId=10000\",\"currentProgress\":50,\"currentSubTask\":\"Currently\n reindexing Change\n History\",\"type\":\"FOREGROUND\",\"submittedTime\":\"2017-05-22T07:28:49.664+0000\",\"startTime\":\"2017-05-22T07:28:49.664+0000\",\"finishTime\":\"2017-05-22T07:28:49.664+0000\",\"success\":false}"},
"description": "\n Response that provides a redirect to the GET.\n"
}
},
"parameters": [
{
"in": "query",
"name": "type",
"description": "\n Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED.\n",
"type": "string"
},
{
"in": "query",
"name": "indexComments",
"description": "\n Indicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed.\n",
"type": "boolean"
},
{
"in": "query",
"name": "indexChangeHistory",
"description": "\n Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.\n",
"type": "boolean"
},
{
"in": "query",
"name": "indexWorklogs",
"description": "\n Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed.\n",
"type": "boolean"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getReindexInfo",
"description": "Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.\n If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404\n indicating that no reindex has taken place.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/reindex#",
"additionalProperties": false,
"title": "Reindex",
"type": "object",
"properties": {
"currentProgress": {"type": "integer"},
"currentSubTask": {"type": "string"},
"finishTime": {"type": "string"},
"progressUrl": {"type": "string"},
"submittedTime": {"type": "string"},
"success": {"type": "boolean"},
"startTime": {"type": "string"},
"type": {
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND",
"BACKGROUND_PREFFERED",
"BACKGROUND_PREFERRED"
]
}
},
"required": ["success"]
},
"examples": {"application/json": "\n {\"progressUrl\":\"/secure/admin/jira/IndexProgress.jspa?taskId=10000\",\"currentProgress\":50,\"currentSubTask\":\"Currently\n reindexing Change\n History\",\"type\":\"FOREGROUND\",\"submittedTime\":\"2017-05-22T07:28:49.664+0000\",\"startTime\":\"2017-05-22T07:28:49.664+0000\",\"finishTime\":\"2017-05-22T07:28:49.664+0000\",\"success\":false}"}
},
"404": {}
},
"parameters": [{
"in": "query",
"name": "taskId",
"description": "\n the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and\n returns information on the active reindex task, or the last task to run if no reindex is taking place. . If there is no\n reindexing task with that id then a 404 is returned.\n",
"type": "integer"
}]
}
},
"api/2/permissions": {"get": {
"produces": ["application/json"],
"operationId": "getAllPermissions",
"description": "Returns all permissions that are present in the JIRA instance - Global, Project and the global ones added by plugins",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permissions#",
"additionalProperties": false,
"title": "Permissions",
"type": "object",
"properties": {"permissions": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Permission",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"type": {
"type": "string",
"enum": [
"GLOBAL",
"PROJECT"
]
},
"key": {"type": "string"}
}
}},
"additionalProperties": false,
"type": "object"
}}
},
"examples": {"application/json": "\n {\"permissions\":{\"BULK_CHANGE\":{\"key\":\"BULK_CHANGE\",\"name\":\"Bulk\n Change\",\"type\":\"GLOBAL\",\"description\":\"Ability\n to modify a collection of issues at once. For\n example, resolve multiple issues in one\n step.\"}}}"},
"description": "\n all permissions\n"
},
"401": {"description": "\n all permissions\n"},
"403": {"description": "\n all permissions\n"}
}
}},
"api/2/status": {"get": {
"produces": ["application/json"],
"operationId": "getStatuses",
"description": "Returns a list of all statuses",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-status#",
"title": "List of Status",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://localhost:8090/jira/rest/api/2.0/status/10000\",\"description\":\"The\n issue is currently being worked\n on.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/progress.gif\",\"name\":\"In\n Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In\n Progress\"}},{\"self\":\"http://localhost:8090/jira/rest/api/2.0/status/5\",\"description\":\"The\n issue is\n closed.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://localhost:8090/jira/rest/api/2.0/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}}]"},
"description": "\n a full representation of the Status\n"
},
"404": {"description": "\n a full representation of the Status\n"}
}
}},
"api/2/customFieldOption/{id}": {
"get": {
"produces": ["application/json"],
"operationId": "getCustomFieldOption",
"description": "Returns a full representation of the Custom Field Option that has the given id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/custom-field-option#",
"additionalProperties": false,
"title": "Custom Field Option",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"value": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://localhost:8090/jira/rest/api/2.0/customFieldOption/3\",\"value\":\"Blue\"}"},
"description": "\n a full representation of the Custom Field Option with the given id\n"
},
"404": {"description": "\n a full representation of the Custom Field Option with the given id\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n a String containing an Custom Field Option id\n",
"type": "string",
"required": true
}]
},
"api/2/screens/{screenId}/tabs": {
"post": {
"produces": ["application/json"],
"operationId": "addTab",
"description": "Creates tab for given screen",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "{\"id\":10000,\"name\":\"Fields\n Tab\"}"},
"description": "\n a response containing newly created tab\n"
},
"400": {"description": "\n a response containing newly created tab\n"},
"401": {"description": "\n a response containing newly created tab\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/screenable-tab#",
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllTabs",
"description": "Returns a list of all tabs for the given screen",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-screenable-tab#",
"title": "List of Screenable Tab",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"description": "\n a response containing all tabs for screen\n"
},
"400": {"description": "\n a response containing all tabs for screen\n"},
"401": {"description": "\n a response containing all tabs for screen\n"}
},
"parameters": [{
"in": "query",
"name": "projectKey",
"description": "\n the key of the project; this parameter is optional\n",
"type": "string"
}]
},
"parameters": [{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
}]
},
"api/2/resolution": {"get": {
"produces": ["application/json"],
"operationId": "getResolutions",
"description": "Returns a list of all resolutions.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-resolution#",
"title": "List of Resolution",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Resolution",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"}
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/resolution/1\",\"description\":\"A\n fix for this issue is checked into the tree and\n tested.\",\"iconUrl\":\"http://www.example.com/jira/images/icons/statuses/resolved.png\",\"name\":\"Fixed\"},{\"self\":\"http://www.example.com/jira/rest/api/2/resolution/3\",\"description\":\"This\n is what it is supposed to do.\",\"name\":\"Works as\n designed\"}]"},
"description": "\n a list of JIRA issue resolutions\n"
}}
}},
"api/2/attachment/{id}": {
"get": {
"produces": ["application/json"],
"operationId": "getAttachment",
"description": "Returns the meta-data for an attachment, including the URI of the actual attached file.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment#",
"additionalProperties": false,
"title": "Attachment",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}},
"properties": {
"thumbnail": {"type": "string"},
"filename": {"type": "string"},
"size": {"type": "integer"},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"created": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "integer"},
"mimeType": {"type": "string"},
"properties": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"content": {"type": "string"}
},
"required": [
"id",
"size"
]
},
"examples": {"application/json": "\n {\"id\":10001,\"self\":\"http://www.example.com/jira/rest/api/2.0/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"created\":\"2017-05-22T07:28:50.772+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"http://www.example.com/jira/attachments/10000\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10000\"}"},
"description": "\n A response\n"
},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"}
}
},
"parameters": [{
"in": "path",
"name": "id",
"description": "\n id of the attachment to remove\n",
"type": "string",
"required": true
}],
"delete": {
"produces": ["application/json"],
"operationId": "removeAttachment",
"description": "Remove an attachment from an issue.",
"responses": {
"204": {"description": "\n A response\n"},
"403": {"description": "\n A response\n"},
"404": {"description": "\n A response\n"}
}
}
},
"api/2/myself": {"get": {
"produces": ["application/json"],
"operationId": "getUser",
"description": "Returns currently logged user. This resource cannot be accessed anonymously.\n <p>\n The resource accepts the <code>expand<\/code> param that is used to include, hidden by default, parts of response. This can be used to include:\n <ul>\n <li><code>groups<\/code> - all groups, including nested groups, to which user belongs<\/li>\n <li><code>applicationRoles<\/code> - application roles defines to which application user has access<\/li>\n <\/ul>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"definitions": {"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
}},
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"name\":\"fred\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[{\"name\":\"jira-user\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-user\"},{\"name\":\"jira-admin\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-admin\"},{\"name\":\"important\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=important\"}]},\"applicationRoles\":{\"size\":1,\"items\":[]},\"expand\":\"groups,applicationRoles\"}"}
},
"401": {}
}
}},
"api/2/project/{projectIdOrKey}/role": {
"get": {
"produces": ["application/json"],
"operationId": "getProjectRoles",
"description": "Returns all roles in the given project Id or key, with links to full details on each role.",
"responses": {
"200": {
"schema": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"examples": {"application/json": "\n {\"Administrators\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10002\",\"Users\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10001\",\"Developers\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10000\"}"},
"description": "\n list of roles and URIs to full details\n"
},
"404": {"description": "\n list of roles and URIs to full details\n"}
}
},
"parameters": [{
"in": "path",
"name": "projectIdOrKey",
"description": "\n the project id or project key\n",
"type": "string",
"required": true
}]
},
"api/2/comment/{commentId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the comment identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
}
},
"parameters": [{
"in": "path",
"name": "commentId",
"description": "\n the comment from which keys will be returned.\n",
"type": "string",
"required": true
}]
},
"api/2/notificationscheme": {"get": {
"produces": ["application/json"],
"operationId": "getNotificationSchemes",
"description": "Returns a <a href=\"#pagination\">paginated<\/a> list of notification schemes. In order to access notification scheme, the calling user is\n required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains\n a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response.\n The list is ordered by the scheme's name.\n Follow the documentation of /notificationscheme/{id} resource for all details about returned value.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/page-of-notification-scheme#",
"additionalProperties": false,
"title": "Page of Notification Scheme",
"type": "object",
"definitions": {
"group-notification": {
"additionalProperties": false,
"title": "Group Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"custom-field-value-notification": {
"additionalProperties": false,
"title": "Custom Field Value Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"email-notification": {
"additionalProperties": false,
"title": "Email Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"emailAddress": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"notification-event": {
"additionalProperties": false,
"title": "Notification Event",
"type": "object",
"properties": {
"templateEvent": {"$ref": "#/definitions/notification-event"},
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"role-notification": {
"additionalProperties": false,
"title": "Role Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"project-role-notification": {
"additionalProperties": false,
"title": "Project Role Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"}
}
},
"user-notification": {
"additionalProperties": false,
"title": "User Notification",
"type": "object",
"properties": {
"expand": {"type": "string"},
"parameter": {"type": "string"},
"id": {"type": "integer"},
"notificationType": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
}
}
},
"properties": {
"total": {"type": "integer"},
"isLast": {"type": "boolean"},
"nextPage": {
"format": "uri",
"type": "string"
},
"maxResults": {"type": "integer"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Notification Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "integer"},
"notificationSchemeEvents": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Notification Scheme Event",
"type": "object",
"properties": {
"event": {"$ref": "#/definitions/notification-event"},
"notifications": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/custom-field-value-notification"},
{"$ref": "#/definitions/email-notification"},
{"$ref": "#/definitions/group-notification"},
{"$ref": "#/definitions/project-role-notification"},
{"$ref": "#/definitions/role-notification"},
{"$ref": "#/definitions/user-notification"}
],
"title": "Notification",
"type": "object"
}
}
}
}
}
}
}
},
"self": {
"format": "uri",
"type": "string"
},
"startAt": {"type": "integer"}
},
"required": [
"maxResults",
"startAt"
]
},
"examples": {"application/json": "\n {\"maxResults\":6,\"startAt\":1,\"total\":5,\"isLast\":false,\"values\":[{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://example.com/jira/rest/api/2/notificationscheme/10010\",\"name\":\"notification\n scheme\n name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom\n event\",\"description\":\"Custom event which is\n published together with issue created\n event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue\n created\",\"description\":\"Event published when\n issue is\n created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://www.example.com/jira/rest/api/2/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A\n project role that represents developers in a\n project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\"},{\"id\":10241,\"displayName\":\"Fred\n F.\n User\",\"type\":\"atlassian-user-role-actor\",\"name\":\"fred\"}]},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"[email protected]\",\"emailAddress\":\"[email protected]\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"displayName\":\"Fred\n F.\n User\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"custom_fields_may_have_friendly_keys\",\"name\":\"New\n custom\n field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New\n custom\n field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}]}"},
"description": "\n a paginated list of notification schemes to which the calling user has permissions.\n"
}},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n the index of the first notification scheme to return (0 based).\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n the maximum number of notification schemes to return (max 50).\n",
"type": "integer"
},
{
"in": "query",
"name": "expand",
"type": "string"
}
]
}},
"api/2/avatar/{type}/system": {
"get": {
"produces": ["application/json"],
"operationId": "getAllSystemAvatars",
"description": "Returns all system avatars of the given type.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/system-avatars#",
"additionalProperties": false,
"title": "System Avatars",
"type": "object",
"properties": {"system": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Avatar",
"type": "object",
"properties": {
"owner": {"type": "string"},
"isDeletable": {"type": "boolean"},
"urls": {
"patternProperties": {"\\d\\dx\\d\\d": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"isSystemAvatar": {"type": "boolean"},
"isSelected": {"type": "boolean"},
"id": {"type": "string"},
"selected": {"type": "boolean"}
},
"required": [
"isSystemAvatar",
"isSelected",
"isDeletable",
"selected"
]
}
}}
},
"examples": {"application/json": "\n {\"system\":[{\"id\":\"1000\",\"owner\":\"fred\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"http://localhost:8090/jira/secure/useravatar?size=xsmall&avatarId=10040\",\"24x24\":\"http://localhost:8090/jira/secure/useravatar?size=small&avatarId=10040\",\"32x32\":\"http://localhost:8090/jira/secure/useravatar?size=medium&avatarId=10040\",\"48x48\":\"http://localhost:8090/jira/secure/useravatar?avatarId=10040\"},\"selected\":false}]}"},
"description": "\n all system avatars of the given type.\n"
},
"500": {"description": "\n all system avatars of the given type.\n"}
}
},
"parameters": [{
"in": "path",
"name": "type",
"description": "\n the avatar type\n",
"type": "string",
"required": true
}]
},
"api/2/user/properties/": {"get": {
"produces": ["application/json"],
"operationId": "getPropertiesKeys",
"description": "Returns the keys of all properties for the user identified by the key or by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean.\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"401": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"403": {"description": "\n a response containing EntityPropertiesKeysBean.\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean.\n"}
},
"parameters": [
{
"in": "query",
"name": "userKey",
"description": "\n key of the user whose properties are to be returned\n",
"type": "string"
},
{
"in": "query",
"name": "username",
"description": "\n username of the user whose properties are to be returned\n",
"type": "string"
}
]
}},
"api/2/project": {
"post": {
"produces": ["application/json"],
"operationId": "createProject",
"description": "Creates a new project.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-identity#",
"additionalProperties": false,
"title": "Project Identity",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "integer"},
"key": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"self\":\"http://example/jira/rest/api/2/project/10042\",\"id\":10010,\"key\":\"EX\"}"},
"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"
},
"400": {"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"},
"401": {"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"},
"403": {"description": "\n The {@link com.atlassian.jira.rest.v2.issue.project.ProjectIdentity} of newly created project.\n"}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/project-input#",
"additionalProperties": false,
"title": "Project Input",
"type": "object",
"properties": {
"notificationScheme": {"type": "integer"},
"description": {"type": "string"},
"lead": {"type": "string"},
"url": {"type": "string"},
"projectTemplateKey": {"type": "string"},
"avatarId": {"type": "integer"},
"issueSecurityScheme": {"type": "integer"},
"name": {"type": "string"},
"permissionScheme": {"type": "integer"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"categoryId": {"type": "integer"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getAllProjects",
"description": "Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the\n list of projects that are visible when using anonymous access.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-project#",
"title": "List of Project",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Project",
"type": "object",
"properties": {
"components": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Component",
"type": "object",
"properties": {
"leadUserName": {"type": "string"},
"description": {"type": "string"},
"project": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"isAssigneeTypeValid": {"type": "boolean"},
"realAssigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"realAssignee": {"$ref": "#/definitions/user"},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"assignee": {"$ref": "#/definitions/user"},
"projectId": {"type": "integer"}
},
"required": ["isAssigneeTypeValid"]
}
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"roles": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"description": {"type": "string"},
"lead": {"$ref": "#/definitions/user"},
"url": {"type": "string"},
"issueTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Type",
"type": "object",
"properties": {
"avatarId": {"type": "integer"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"iconUrl": {"type": "string"},
"subtask": {"type": "boolean"}
},
"required": ["subtask"]
}
},
"expand": {"type": "string"},
"versions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Version",
"type": "object",
"properties": {
"description": {"type": "string"},
"project": {"type": "string"},
"archived": {"type": "boolean"},
"expand": {"type": "string"},
"operations": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Simple Link",
"type": "object",
"properties": {
"weight": {"type": "integer"},
"id": {"type": "string"},
"label": {"type": "string"},
"href": {"type": "string"},
"styleClass": {"type": "string"},
"title": {"type": "string"},
"iconClass": {"type": "string"}
}
}
},
"overdue": {"type": "boolean"},
"remotelinks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Remote Entity Link",
"type": "object",
"properties": {
"name": {"type": "string"},
"link": {},
"self": {
"format": "uri",
"type": "string"
}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"moveUnfixedIssuesTo": {
"format": "uri",
"type": "string"
},
"userReleaseDate": {"type": "string"},
"id": {"type": "string"},
"userStartDate": {"type": "string"},
"projectId": {"type": "integer"},
"released": {"type": "boolean"}
}
}
},
"projectCategory": {
"additionalProperties": false,
"title": "Project Category",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"assigneeType": {
"type": "string",
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
]
},
"projectKeys": {
"type": "array",
"items": {"type": "string"}
},
"projectTypeKey": {"type": "string"},
"key": {"type": "string"},
"email": {"type": "string"}
}
},
"definitions": {
"simple-list-wrapper": {
"additionalProperties": false,
"title": "Simple List Wrapper",
"type": "object",
"properties": {
"size": {"type": "integer"},
"max-results": {"type": "integer"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"required": ["size"]
},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"avatarUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"groups": {"$ref": "#/definitions/simple-list-wrapper"},
"locale": {"type": "string"},
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"expand": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"key": {"type": "string"},
"applicationRoles": {"$ref": "#/definitions/simple-list-wrapper"}
},
"required": ["active"]
}
}
},
"examples": {"application/json": "\n [{\"self\":\"http://www.example.com/jira/rest/api/2/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://www.example.com/jira/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First\n Project\n Category\"}},{\"self\":\"http://www.example.com/jira/rest/api/2/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"http://www.example.com/jira/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"http://www.example.com/jira/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"http://www.example.com/jira/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First\n Project Category\"}}]"},
"description": "\n all projects for which the user has the BROWSE project permission. If no user is logged in,\n it returns all projects, which are visible when using anonymous access.\n"
}},
"parameters": [
{
"in": "query",
"name": "expand",
"description": "\n the parameters to expand\n",
"type": "string"
},
{
"in": "query",
"name": "recent",
"description": "\n if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20).\n",
"type": "integer"
}
]
}
},
"api/2/groups/picker": {"get": {
"produces": ["application/json"],
"operationId": "findGroups",
"description": "Returns groups with substrings matching a given query. This is mainly for use with\n the group picker, so the returned groups contain html to be used as picker suggestions.\n The groups are also wrapped in a single response object that also contains a header for\n use in the picker, specifically <i>Showing X of Y matching groups<\/i>.\n <p>\n The number of groups returned is limited by the system property \"jira.ajax.autocomplete.limit\"\n <p>\n The groups will be unique and sorted.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/group-suggestions#",
"additionalProperties": false,
"title": "Group Suggestions",
"type": "object",
"properties": {
"total": {"type": "integer"},
"header": {"type": "string"},
"groups": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Suggestion",
"type": "object",
"properties": {
"name": {"type": "string"},
"html": {"type": "string"},
"labels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Label",
"type": "object",
"properties": {
"text": {"type": "string"},
"title": {"type": "string"},
"type": {
"type": "string",
"enum": [
"ADMIN",
"SINGLE",
"MULTIPLE"
]
}
}
}
}
}
}
}
}
},
"examples": {"application/json": "{\"header\":\"Showing 20 of 25 matching\n groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"<b>j<\/b>dog-developers\"},{\"name\":\"juvenal-bot\",\"html\":\"<b>j<\/b>uvenal-bot\"}]}"},
"description": "\n a collection of matching groups\n"
}},
"parameters": [
{
"in": "query",
"name": "query",
"description": "\n a String to match groups agains\n",
"type": "string"
},
{
"in": "query",
"name": "exclude",
"type": "string"
},
{
"in": "query",
"name": "maxResults",
"type": "integer"
},
{
"in": "query",
"name": "userName",
"type": "string"
}
]
}},
"api/2/permissionscheme": {
"post": {
"produces": ["application/json"],
"operationId": "createPermissionScheme",
"description": "Create a new permission scheme.\n This method can create schemes with a defined permission set, or without.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-developers\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}"},
"description": "\n a newly created scheme\n"
},
"401": {"description": "\n a newly created scheme\n"},
"403": {"description": "\n a newly created scheme\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-scheme#",
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"parameter": {"type": "string"},
"type": {"type": "string"}
}
},
"permission": {"type": "string"}
}
}
},
"name": {"type": "string"},
"description": {"type": "string"}
}
},
"in": "body"
},
{
"in": "query",
"name": "expand",
"type": "string"
}
]
},
"get": {
"produces": ["application/json"],
"operationId": "getPermissionSchemes",
"description": "Returns a list of all permission schemes.\n <p>\n By default only shortened beans are returned. If you want to include permissions of all the schemes,\n then specify the <b>permissions<\/b> expand parameter. Permissions will be included also if you specify\n any other expand parameter.\n <\/p>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permission-schemes#",
"additionalProperties": false,
"title": "Permission Schemes",
"type": "object",
"properties": {"permissionSchemes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Scheme",
"type": "object",
"properties": {
"expand": {"type": "string"},
"permissions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Permission Grant",
"type": "object",
"properties": {
"self": {
"format": "uri",
"type": "string"
},
"holder": {
"additionalProperties": false,
"title": "Permission Holder",
"type": "object",
"properties": {
"expand": {"type": "string"},
"field": {
"additionalProperties": false,
"title": "Field",
"type": "object",
"properties": {
"schema": {
"additionalProperties": false,
"title": "Json Type",
"type": "object",
"properties": {
"system": {"type": "string"},
"custom": {"type": "string"},
"type": {"type": "string"},
"items": {"type": "string"},
"customId": {"type": "integer"}
}
},
"navigable": {"type": "boolean"},
"orderable": {"type": "boolean"},
"custom": {"type": "boolean"},
"name": {"type": "string"},
"clauseNames": {
"type": "array",
"items": {"type": "string"}
},
"id": {"type": "string"},
"key": {"type": "string"},
"searchable": {"type": "boolean"}
}
},
"projectRole": {
"additionalProperties": false,
"title": "Project Role",
"type": "object",
"properties": {
"actors": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Role Actor",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "integer"},
"type": {"type": "string"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
},
"parameter": {"type": "string"},
"type": {"type": "string"},
"user": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"group": {
"additionalProperties": false,
"title": "Group",
"type": "object",
"properties": {
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
}
}
}
}
},
"permission": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"description": {"type": "string"},
"id": {"type": "integer"}
}
}
}}
},
"examples": {"application/json": "\n {\"permissionSchemes\":[{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/2/permissionscheme/10000\",\"name\":\"Example\n permission\n scheme\",\"description\":\"description\"}]}"},
"description": "\n a list of all permission schemes.\n"
},
"401": {"description": "\n a list of all permission schemes.\n"},
"403": {"description": "\n a list of all permission schemes.\n"}
},
"parameters": [{
"in": "query",
"name": "expand",
"type": "string"
}]
}
},
"api/2/projectvalidate/key": {"get": {
"produces": ["application/json"],
"operationId": "getProject",
"description": "Validates a project key.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/error-collection#",
"additionalProperties": false,
"title": "Error Collection",
"type": "object",
"properties": {
"errorMessages": {
"type": "array",
"items": {"type": "string"}
},
"errors": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"status": {"type": "integer"}
}
},
"examples": {"application/json": "\n {\"errorMessages\":[],\"errors\":{\"projectKey\":\"A\n project with that project key already\n exists.\"}}"},
"description": "\n an ErrorCollection containing any errors. If the project key is valid, the ErrorCollection will be empty.\n"
}},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n the project key\n",
"type": "string"
}]
}},
"api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}": {
"parameters": [
{
"in": "path",
"name": "id",
"description": "\n database id for avatar\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "type",
"description": "\n Project id or project key\n",
"type": "string",
"required": true
},
{
"in": "path",
"name": "owningObjectId",
"type": "string",
"required": true
}
],
"delete": {
"produces": ["application/json"],
"operationId": "deleteAvatar",
"description": "Deletes avatar",
"responses": {"": {}}
}
},
"api/2/issueLinkType": {
"post": {
"produces": ["application/json"],
"operationId": "createIssueLinkType",
"description": "Create a new issue link type.",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-link-type#",
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"outward": {"type": "string"}
}
},
"examples": {"application/json": "\n {\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated\n by\",\"outward\":\"Duplicates\",\"self\":\"http://www.example.com/jira/rest/api/2//issueLinkType/1000\"}"}
},
"404": {}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-link-type#",
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"outward": {"type": "string"}
}
},
"in": "body"
}]
},
"get": {
"produces": ["application/json"],
"operationId": "getIssueLinkTypes",
"description": "Returns a list of available issue link types, if issue linking is enabled.\n Each issue link type has an id, a name and a label for the outward and inward link relationship.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/issue-link-types#",
"additionalProperties": false,
"title": "Issue Link Types",
"type": "object",
"properties": {"issueLinkTypes": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue Link Type",
"type": "object",
"properties": {
"inward": {"type": "string"},
"name": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"outward": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"issueLinkTypes\":[{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated\n by\",\"outward\":\"Duplicates\",\"self\":\"http://www.example.com/jira/rest/api/2//issueLinkType/1000\"},{\"id\":\"1010\",\"name\":\"Blocks\",\"inward\":\"Blocked\n by\",\"outward\":\"Blocks\",\"self\":\"http://www.example.com/jira/rest/api/2//issueLinkType/1010\"}]}"},
"description": "\n a list of available issue link types.\n"
},
"404": {"description": "\n a list of available issue link types.\n"}
}
}
},
"api/2/worklog/updated": {"get": {
"produces": ["application/json"],
"operationId": "getIdsOfWorklogsModifiedSince",
"description": "Returns worklogs id and update time of worklogs that was updated since given time.\n The returns set of worklogs is limited to 1000 elements.\n This API will not return worklogs updated during last minute.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/worklog-changed-since#",
"additionalProperties": false,
"title": "Worklog Changed Since",
"type": "object",
"properties": {
"nextPage": {
"format": "uri",
"type": "string"
},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Worklog Change",
"type": "object",
"properties": {
"updatedTime": {"type": "integer"},
"worklogId": {"type": "integer"},
"properties": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property",
"type": "object",
"properties": {
"value": {},
"key": {"type": "string"}
}
}
}
}
}
},
"isLastPage": {"type": "boolean"},
"self": {
"format": "uri",
"type": "string"
},
"until": {"type": "integer"},
"since": {"type": "integer"}
},
"required": ["isLastPage"]
},
"examples": {"application/json": "\n {\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://www.example.com/jira/worklog/updated?since=1438013671136\",\"nextPage\":\"http://www.example.com/jira/worklog/updated/updated?since=1438013671136&since=1438013693136\",\"lastPage\":true}"},
"description": "\n a set of worklogs id and update time.\n"
}},
"parameters": [
{
"in": "query",
"name": "since",
"description": "\n a date time in unix timestamp format since when updated worklogs will be returned.\n",
"type": "integer"
},
{
"in": "query",
"name": "expand",
"description": "\n optional comma separated list of parameters to expand: properties (provides worklog properties).\n",
"type": "string"
}
]
}},
"api/2/screens/{screenId}/tabs/{tabId}/move/{pos}": {
"post": {
"produces": ["application/json"],
"operationId": "moveTab",
"description": "Moves tab position",
"responses": {
"201": {"description": "\n A response containing no content\n"},
"400": {"description": "\n A response containing no content\n"},
"401": {"description": "\n A response containing no content\n"}
}
},
"parameters": [
{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "tabId",
"description": "\n id of tab\n",
"type": "integer",
"required": true
},
{
"in": "path",
"name": "pos",
"description": "\n position of tab\n",
"type": "integer",
"required": true
}
]
},
"api/2/screens/{screenId}/availableFields": {
"get": {
"produces": ["application/json"],
"operationId": "getFieldsToAdd",
"description": "Gets available fields for screen. i.e ones that haven't already been added.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/list-of-screenable-tab#",
"title": "List of Screenable Tab",
"type": "array",
"items": {
"additionalProperties": false,
"title": "Screenable Tab",
"type": "object",
"properties": {
"name": {"type": "string"},
"id": {"type": "integer"}
}
}
},
"description": "\n a response containing available fields\n"
},
"400": {"description": "\n a response containing available fields\n"},
"401": {"description": "\n a response containing available fields\n"}
}
},
"parameters": [{
"in": "path",
"name": "screenId",
"description": "\n id of screen\n",
"type": "integer",
"required": true
}]
},
"api/2/issuetype/{issueTypeId}/properties": {
"get": {
"produces": ["application/json"],
"operationId": "getPropertyKeys",
"description": "Returns the keys of all properties for the issue type identified by the id.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/entity-properties-keys#",
"additionalProperties": false,
"title": "Entity Properties Keys",
"type": "object",
"properties": {"keys": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Entity Property Key",
"type": "object",
"properties": {
"self": {"type": "string"},
"key": {"type": "string"}
}
}
}}
},
"examples": {"application/json": "\n {\"keys\":[{\"self\":\"http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}"},
"description": "\n a response containing EntityPropertiesKeysBean\n"
},
"400": {"description": "\n a response containing EntityPropertiesKeysBean\n"},
"404": {"description": "\n a response containing EntityPropertiesKeysBean\n"}
}
},
"parameters": [{
"in": "path",
"name": "issueTypeId",
"description": "\n the issue type from which the keys will be returned\n",
"type": "string",
"required": true
}]
},
"api/2/issue/{issueIdOrKey}/changelog": {
"get": {
"produces": ["application/json"],
"operationId": "getChangeLogs",
"description": "Returns all changelogs for an issue, sorted by date, starting from the latest.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/page-of-change-history#",
"additionalProperties": false,
"title": "Page of Change History",
"type": "object",
"definitions": {"history-metadata-participant": {
"additionalProperties": false,
"title": "History Metadata Participant",
"type": "object",
"properties": {
"avatarUrl": {"type": "string"},
"displayName": {"type": "string"},
"id": {"type": "string"},
"type": {"type": "string"},
"displayNameKey": {"type": "string"},
"url": {"type": "string"}
}
}},
"properties": {
"total": {"type": "integer"},
"isLast": {"type": "boolean"},
"nextPage": {
"format": "uri",
"type": "string"
},
"maxResults": {"type": "integer"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"accountId": {"type": "string"},
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"self": {
"format": "uri",
"type": "string"
},
"startAt": {"type": "integer"}
},
"required": [
"maxResults",
"startAt"
]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/issue/TT-1/changelog?startAt=2&maxResults=2\",\"nextPage\":\"http://www.example.com/jira/rest/api/2/issue/TT-1/changelog?&startAt=4&maxResults=2\",\"maxResults\":2,\"startAt\":2,\"total\":5,\"isLast\":false,\"values\":[{\"id\":\"10001\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:50.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"from\":null,\"fromString\":\"\",\"to\":null,\"toString\":\"label-1\"}]},{\"id\":\"10002\",\"author\":{\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"name\":\"fred\",\"key\":\"fred\",\"accountId\":\"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e\",\"emailAddress\":\"[email protected]\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"displayName\":\"Fred\n F.\n User\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:51.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"from\":null,\"fromString\":\"label-1\",\"to\":null,\"toString\":\"label-1\n label-2\"}]}]}"},
"description": "\n all changelogs for the issue\n"
},
"404": {"description": "\n all changelogs for the issue\n"}
},
"parameters": [
{
"in": "query",
"name": "startAt",
"description": "\n the page offset, if not specified then defaults to 0\n",
"type": "integer"
},
{
"in": "query",
"name": "maxResults",
"description": "\n how many results on the page should be included. Defaults to 100 and any number that bigger than 100 will be limited to that value.\n",
"type": "integer"
}
]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"description": "\n to get changelogs for\n",
"type": "string",
"required": true
}]
},
"api/2/mypermissions": {"get": {
"produces": ["application/json"],
"operationId": "getPermissions",
"description": "Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for\n (<code>projectKey<\/code> OR <code>projectId<\/code> OR <code>issueKey<\/code> OR <code>issueId<\/code>)\n <p>When no context supplied the project related permissions will return true if the user has that permission in ANY project.<\/p>\n <p>If a project context is provided, project related permissions will return true if the user has the permissions in the specified project.\n For permissions that are determined using issue data (e.g Current Assignee), true will be returned if the user meets the permission criteria in ANY issue in that project.<\/p>\n <p>If an issue context is provided, it will return whether or not the user has each permission in that specific issue.<\/p>\n <p>The above means that for issue-level permissions (EDIT_ISSUE for example), hasPermission may be true when no context is provided, or when a project context is provided,\n <b>but<\/b> may be false for any given (or all) issues. This would occur (for example) if Reporters were given the EDIT_ISSUE permission. This is because\n any user could be a reporter, except in the context of a concrete issue, where the reporter is known.\n <\/p>\n <p>\n Global permissions will still be returned for all scopes.\n <\/p>",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/permissions#",
"additionalProperties": false,
"title": "Permissions",
"type": "object",
"properties": {"permissions": {
"patternProperties": {".+": {
"additionalProperties": false,
"title": "Permission",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"id": {"type": "string"},
"type": {
"type": "string",
"enum": [
"GLOBAL",
"PROJECT"
]
},
"key": {"type": "string"}
}
}},
"additionalProperties": false,
"type": "object"
}}
},
"examples": {"application/json": "\n {\"permissions\":{\"EDIT_ISSUE\":{\"id\":\"12\",\"key\":\"EDIT_ISSUES\",\"name\":\"Edit\n Issues\",\"type\":\"PROJECT\",\"description\":\"Ability\n to edit\n issues.\",\"havePermission\":true}}}"},
"description": "\n all permissions and whether the currently logged in user has them.\n"
},
"400": {"description": "\n all permissions and whether the currently logged in user has them.\n"},
"404": {"description": "\n all permissions and whether the currently logged in user has them.\n"}
},
"parameters": [
{
"in": "query",
"name": "projectKey",
"description": "\n Key of project to scope returned permissions for.\n",
"type": "string"
},
{
"in": "query",
"name": "projectId",
"description": "\n Id of project to scope returned permissions for.\n",
"type": "string"
},
{
"in": "query",
"name": "issueKey",
"description": "\n Key of the issue to scope returned permissions for.\n",
"type": "string"
},
{
"in": "query",
"name": "issueId",
"description": "\n Id of the issue to scope returned permissions for.\n",
"type": "string"
}
]
}},
"api/2/groupuserpicker": {"get": {
"produces": ["application/json"],
"operationId": "findUsersAndGroups",
"description": "Returns a list of users and groups matching query with highlighting. This resource cannot be accessed\n anonymously.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/users-and-groups#",
"additionalProperties": false,
"title": "Users And Groups",
"type": "object",
"properties": {
"groups": {
"additionalProperties": false,
"title": "Group Suggestions",
"type": "object",
"properties": {
"total": {"type": "integer"},
"header": {"type": "string"},
"groups": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Suggestion",
"type": "object",
"properties": {
"name": {"type": "string"},
"html": {"type": "string"},
"labels": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Group Label",
"type": "object",
"properties": {
"text": {"type": "string"},
"title": {"type": "string"},
"type": {
"type": "string",
"enum": [
"ADMIN",
"SINGLE",
"MULTIPLE"
]
}
}
}
}
}
}
}
}
},
"users": {
"additionalProperties": false,
"title": "User Picker Results",
"type": "object",
"properties": {
"total": {"type": "integer"},
"header": {"type": "string"},
"users": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User Picker User",
"type": "object",
"properties": {
"avatarUrl": {
"format": "uri",
"type": "string"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"html": {"type": "string"},
"key": {"type": "string"}
}
}
}
}
}
}
},
"description": "\n An object containing list of matched user objects, with html representing highlighting.\n"
}},
"parameters": [
{
"in": "query",
"name": "query",
"description": "\n A string used to search username, Name or e-mail address\n",
"type": "string"
},
{
"in": "query",
"name": "maxResults",
"description": "\n the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If\n you specify a value that is higher than this number, your search results will be truncated.\n",
"type": "integer"
},
{
"in": "query",
"name": "showAvatar",
"type": "boolean"
},
{
"in": "query",
"name": "fieldId",
"description": "\n The custom field id, if this request comes from a custom field, such as a user picker. Optional.\n",
"type": "string"
},
{
"in": "query",
"name": "projectId",
"description": "\n The list of project ids to further restrict the search\n This parameter can occur multiple times to pass in multiple project ids.\n Comma separated value is not supported.\n This parameter is only used when fieldId is present.\n",
"type": "string"
},
{
"in": "query",
"name": "issueTypeId",
"description": "\n The list of issue type ids to further restrict the search.\n This parameter can occur multiple times to pass in multiple issue type ids.\n Comma separated value is not supported.\n Special values such as -1 (all standard issue types), -2 (all subtask issue types) are supported.\n This parameter is only used when fieldId is present.\n",
"type": "string"
}
]
}},
"api/2/jql/autocompletedata": {"get": {
"produces": ["application/json"],
"operationId": "getAutoComplete",
"description": "Returns the auto complete data required for JQL searches.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/auto-complete-response#",
"additionalProperties": false,
"title": "Auto Complete Response",
"type": "object",
"properties": {
"visibleFieldNames": {
"type": "array",
"items": {"type": "string"}
},
"visibleFunctionNames": {
"type": "array",
"items": {"type": "string"}
},
"jqlReservedWords": {
"type": "array",
"items": {"type": "string"}
}
}
},
"examples": {"application/json": "\"{\\\"visibleFieldNames\\\":\n [{\\\"value\\\":\\\"affectedVersion\\\",\\\"displayName\\\":\\\"affectedVersion\\\",\\\"auto\\\":\\\"true\\\",\\\"orderable\\\":\\\"true\\\",\\\"searchable\\\":\\\"true\\\",\\\"operators\\\":[\\\"=\\\",\\\"!=\\\",\\\"in\\\",\\\"not\n in\\\",\\\"is\\\",\\\"is\n not\\\",\\\"<\\\",\\\"<=\\\",\\\">\\\",\\\">=\\\"],\\\"types\\\":[\\\"com.atlassian.jira.project.version.Version\\\"]},{\\\"value\\\":\\\"assignee\\\",\\\"displayName\\\":\\\"assignee\\\",\\\"auto\\\":\\\"true\\\",\\\"orderable\\\":\\\"true\\\",\\\"searchable\\\":\\\"true\\\",\\\"operators\\\":[\\\"!=\\\",\\\"was\n not in\\\",\\\"not in\\\",\\\"was not\\\",\\\"is\\\",\\\"was\n in\\\",\\\"was\\\",\\\"=\\\",\\\"in\\\",\\\"changed\\\",\\\"is\n not\\\"],\\\"types\\\":[\\\"com.atlassian.crowd.embedded.api.User\\\"]}],\\\"visibleFunctionNames\\\":\n {\\\"value\\\":\\\"currentLogin()\\\",\\\"displayName\\\":\\\"currentLogin()\\\",\\\"types\\\":[\\\"java.util.Date\\\"]},{\\\"value\\\":\\\"currentUser()\\\",\\\"displayName\\\":\\\"currentUser()\\\",\\\"types\\\":[\\\"com.atlassian.crowd.embedded.api.User\\\"]}],\\\"jqlReservedWords\\\":\n \\\"empty\\\",\\\"and\\\",\\\"or\\\",\\\"in\\\",\\\"distinct\\\"]}\""},
"description": "\n the auto complete data required for JQL searches.\n"
},
"401": {"description": "\n the auto complete data required for JQL searches.\n"},
"500": {"description": "\n the auto complete data required for JQL searches.\n"}
}
}},
"api/2/serverInfo": {"get": {
"produces": ["application/json"],
"operationId": "getServerInfo",
"description": "Returns general information about the current JIRA server.",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/server-info#",
"additionalProperties": false,
"title": "Server Info",
"type": "object",
"properties": {
"healthChecks": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Health Check Result",
"type": "object",
"properties": {
"name": {"type": "string"},
"description": {"type": "string"},
"passed": {"type": "boolean"}
}
}
},
"baseUrl": {"type": "string"},
"deploymentType": {"type": "string"},
"scmInfo": {"type": "string"},
"buildPartnerName": {"type": "string"},
"serverTime": {"type": "string"},
"buildDate": {"type": "string"},
"serverTitle": {"type": "string"},
"version": {"type": "string"},
"buildNumber": {"type": "integer"},
"versionNumbers": {
"type": "array",
"items": {"type": "integer"}
}
}
},
"examples": {"application/json": "\n {\"baseUrl\":\"http://localhost:8080/jira\",\"version\":\"5.0-SNAPSHOT\",\"versionNumbers\":[5,0,0],\"buildNumber\":582,\"buildDate\":\"2017-05-22T07:28:47.399+0000\",\"serverTime\":\"2017-05-22T07:28:47.399+0000\",\"scmInfo\":\"1f51473f5c7b75c1a69a0090f4832cdc5053702a\",\"buildPartnerName\":\"Example\n Partner Co.\",\"serverTitle\":\"My Shiny New JIRA\n Server\"}"},
"description": "\n a Response containing a ServerInfoBean\n"
}},
"parameters": [{
"in": "query",
"name": "doHealthCheck",
"type": "boolean"
}]
}},
"api/2/mypreferences": {
"get": {
"produces": ["application/json"],
"operationId": "getPreference",
"description": "Returns preference of the currently logged in user. Preference key must be provided as input parameter (key).\n The value is returned exactly as it is.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"description": "\n response with value of one preference of currently logged in user.\n"
},
"404": {"description": "\n response with value of one preference of currently logged in user.\n"}
},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n - key of the preference to be returned.\n",
"type": "string"
}]
},
"delete": {
"produces": ["application/json"],
"operationId": "removePreference",
"description": "Removes preference of the currently logged in user. Preference key must be provided as input parameters (key).",
"responses": {
"204": {"description": "\n empty response\n"},
"404": {"description": "\n empty response\n"}
},
"parameters": [{
"in": "query",
"name": "key",
"description": "\n - key of the preference to be removed.\n",
"type": "string"
}]
},
"put": {
"produces": ["application/json"],
"operationId": "setPreference",
"description": "Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value\n must be provided as POST body.",
"responses": {
"204": {"description": "\n empty response\n"},
"404": {"description": "\n empty response\n"}
},
"parameters": [
{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/string#",
"title": "String",
"type": "string"
},
"in": "body"
},
{
"in": "query",
"name": "key",
"description": "\n - key of the preference to be set.\n",
"type": "string"
}
]
}
},
"api/2/configuration": {"get": {
"produces": ["application/json"],
"operationId": "getConfiguration",
"description": "Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled,\n it also returns the detailed information about time tracking configuration.",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/configuration#",
"additionalProperties": false,
"title": "Configuration",
"type": "object",
"properties": {
"unassignedIssuesAllowed": {"type": "boolean"},
"watchingEnabled": {"type": "boolean"},
"timeTrackingEnabled": {"type": "boolean"},
"attachmentsEnabled": {"type": "boolean"},
"subTasksEnabled": {"type": "boolean"},
"issueLinkingEnabled": {"type": "boolean"},
"votingEnabled": {"type": "boolean"},
"timeTrackingConfiguration": {
"additionalProperties": false,
"title": "Time Tracking Configuration",
"type": "object",
"properties": {
"defaultUnit": {
"type": "string",
"enum": [
"minute",
"hour",
"day",
"week"
]
},
"workingHoursPerDay": {"type": "number"},
"workingDaysPerWeek": {"type": "number"},
"timeFormat": {
"type": "string",
"enum": [
"pretty",
"days",
"hours"
]
}
},
"required": [
"workingHoursPerDay",
"workingDaysPerWeek"
]
}
},
"required": [
"votingEnabled",
"watchingEnabled",
"unassignedIssuesAllowed",
"subTasksEnabled",
"issueLinkingEnabled",
"timeTrackingEnabled",
"attachmentsEnabled"
]
},
"examples": {"application/json": "\n {\"votingEnabled\":true,\"watchingEnabled\":true,\"unassignedIssuesAllowed\":false,\"subTasksEnabled\":false,\"issueLinkingEnabled\":true,\"timeTrackingEnabled\":true,\"attachmentsEnabled\":true,\"timeTrackingConfiguration\":{\"workingHoursPerDay\":8.0,\"workingDaysPerWeek\":5.0,\"timeFormat\":\"pretty\",\"defaultUnit\":\"day\"}}"}
},
"401": {}
}
}},
"api/2/task/{taskId}": {
"get": {
"produces": ["application/json"],
"operationId": "getTask",
"description": "Returns a task progress. When the task is finished, it will contain the <strong>result<\/strong>.\n The result may be an arbitrary JSON, its shape is different for each task type. Consult the documentation\n of the method that created the task to know what it is.",
"responses": {
"200": {
"schema": {
"additionalProperties": false,
"title": "Task Progress",
"type": "object",
"properties": {
"submittedBy": {
"description": "Id of the user that submitted the task",
"type": "integer"
},
"description": {
"description": "Description of the task",
"type": "string"
},
"started": {
"description": "The timestamp of when the task was started",
"type": "string"
},
"finished": {
"description": "The timestamp of when the task processing was finished",
"type": "string"
},
"message": {
"description": "Message regarding the current progress",
"type": "string"
},
"result": {"description": "The eventual result, will be available when the task is finished successfully"},
"submitted": {
"description": "The timestamp of when the task was submitted",
"type": "string"
},
"lastUpdate": {
"description": "The timestamp of when the task progress was last updated",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
},
"progress": {
"description": "The progress percentage (from 0 to 100)",
"type": "integer"
},
"id": {"type": "string"},
"elapsedRuntime": {
"description": "How much time did running the task take (so far, this is updated in real time), in milliseconds",
"type": "integer"
},
"status": {
"description": "Current status of the task",
"type": "string",
"enum": [
"ENQUEUED",
"RUNNING",
"COMPLETE",
"FAILED",
"CANCEL_REQUESTED",
"CANCELLED",
"DEAD"
]
}
},
"required": [
"self",
"id",
"status",
"submittedBy",
"progress",
"elapsedRuntime",
"submitted",
"started",
"lastUpdate"
]
},
"examples": {"application/json": "\n {\"self\":\"http://www.example.com/jira/rest/api/2/task/1\",\"id\":\"1\",\"description\":\"Task\n description\",\"status\":\"COMPLETE\",\"result\":\"the\n task result, this may be any\n JSON\",\"submittedBy\":10000,\"progress\":100,\"elapsedRuntime\":156,\"submitted\":1495438132073,\"started\":1495438132173,\"finished\":1495438132273,\"lastUpdate\":1495438132273}"}
},
"401": {},
"404": {}
}
},
"parameters": [{
"in": "path",
"name": "taskId",
"type": "string",
"required": true
}]
}
},
"host": "example.com",
"produces": ["application/json"],
"schemes": ["http"],
"swagger": "2.0",
"infos": {
"description": "This documents the current REST API provided by JIRA.",
"title": "JIRA Cloud REST API Reference",
"version": "1000.1010.0"
},
"consumes": ["application/json"]
}
Raw
jsd-api-wo-local-definitions.json
This file has been truncated, but you can view the full file.
{
"basePath": "/rest/",
"paths": {
"servicedeskapi/request": {
"post": {
"produces": ["application/json"],
"operationId": "request-createCustomerRequest",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/customer-request#",
"additionalProperties": false,
"title": "Customer Request",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"issueKey": {"type": "string"},
"requestType": {
"additionalProperties": false,
"title": "Request Type",
"type": "object",
"properties": {
"helpText": {"type": "string"},
"serviceDeskId": {"type": "string"},
"_links": {"$ref": "#/definitions/self-link"},
"groupIds": {
"type": "array",
"items": {"type": "string"}
},
"name": {"type": "string"},
"icon": {
"additionalProperties": false,
"title": "Request Type Icon",
"type": "object",
"properties": {
"_links": {
"additionalProperties": false,
"title": "Request Type Icon Link",
"type": "object",
"properties": {"iconUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
}}
},
"id": {"type": "string"}
}
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"serviceDeskId": {"type": "string"},
"requestTypeId": {"type": "string"},
"currentStatus": {"$ref": "#/definitions/customer-request-status"},
"_links": {
"additionalProperties": false,
"title": "Customer Request Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"web": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"serviceDesk": {
"additionalProperties": false,
"title": "Service Desk",
"type": "object",
"properties": {
"projectKey": {"type": "string"},
"_links": {"$ref": "#/definitions/self-link"},
"id": {"type": "string"},
"projectName": {"type": "string"},
"projectId": {"type": "string"}
}
},
"sla": {"$ref": "#/definitions/paged"},
"reporter": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"requestFieldValues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Customer Request Field Value",
"type": "object",
"properties": {
"renderedValue": {},
"label": {"type": "string"},
"value": {},
"fieldId": {"type": "string"}
}
}
},
"issueTypeId": {"type": "string"},
"createdDate": {"$ref": "#/definitions/date"},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"projectId": {"type": "string"},
"status": {"$ref": "#/definitions/paged"},
"participants": {"$ref": "#/definitions/paged"}
}
},
"examples": {"application/json": "{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\"],\"issueId\":\"107001\",\"issueKey\":\"HELPDESK-1\",\"requestTypeId\":\"25\",\"serviceDeskId\":\"10\",\"createdDate\":{\"iso8601\":\"2015-10-08T14:42:00+0700\",\"jira\":\"2015-10-08T14:42:00.000+0700\",\"friendly\":\"Monday 14:42 PM\",\"epochMillis\":1444290120000},\"reporter\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"requestFieldValues\":[{\"fieldId\":\"summary\",\"label\":\"What do you need?\",\"value\":\"Request JSD help via REST\"},{\"fieldId\":\"description\",\"label\":\"Why do you need this?\",\"value\":\"I need a new mouse for my Mac\"}],\"currentStatus\":{\"status\":\"Waiting for Support\",\"statusDate\":{\"iso8601\":\"2015-10-08T14:01:00+0700\",\"jira\":\"2015-10-08T14:01:00.000+0700\",\"friendly\":\"Today 14:01 PM\",\"epochMillis\":1444287660000}},\"_links\":{\"jiraRest\":\"http://host:port/context/rest/api/2/issue/107001\",\"web\":\"http://host:port/context/servicedesk/customer/portal/10/HELPDESK-1\",\"self\":\"http://host:port/context/rest/servicedeskapi/request/107001\"}}"}
},
"400": {"description": "Returned if the HTTP request call is invalid."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to create a customer request in the specified project or on behalf of another user."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/request-create#",
"additionalProperties": false,
"title": "Request Create",
"type": "object",
"properties": {
"requestParticipants": {
"type": "array",
"items": {"type": "string"}
},
"raiseOnBehalfOf": {"type": "string"},
"serviceDeskId": {"type": "string"},
"requestTypeId": {"type": "string"},
"requestFieldValues": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
}
}
},
"in": "body",
"name": "request-createCustomerRequest-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "request-getCustomerRequestByIdOrKey",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/customer-request#",
"additionalProperties": false,
"title": "Customer Request",
"type": "object",
"properties": {
"issueId": {"type": "string"},
"issueKey": {"type": "string"},
"requestType": {
"additionalProperties": false,
"title": "Request Type",
"type": "object",
"properties": {
"helpText": {"type": "string"},
"serviceDeskId": {"type": "string"},
"_links": {"$ref": "#/definitions/self-link"},
"groupIds": {
"type": "array",
"items": {"type": "string"}
},
"name": {"type": "string"},
"icon": {
"additionalProperties": false,
"title": "Request Type Icon",
"type": "object",
"properties": {
"_links": {
"additionalProperties": false,
"title": "Request Type Icon Link",
"type": "object",
"properties": {"iconUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
}}
},
"id": {"type": "string"}
}
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"serviceDeskId": {"type": "string"},
"requestTypeId": {"type": "string"},
"currentStatus": {"$ref": "#/definitions/customer-request-status"},
"_links": {
"additionalProperties": false,
"title": "Customer Request Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"web": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"serviceDesk": {
"additionalProperties": false,
"title": "Service Desk",
"type": "object",
"properties": {
"projectKey": {"type": "string"},
"_links": {"$ref": "#/definitions/self-link"},
"id": {"type": "string"},
"projectName": {"type": "string"},
"projectId": {"type": "string"}
}
},
"sla": {"$ref": "#/definitions/paged"},
"reporter": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"requestFieldValues": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Customer Request Field Value",
"type": "object",
"properties": {
"renderedValue": {},
"label": {"type": "string"},
"value": {},
"fieldId": {"type": "string"}
}
}
},
"issueTypeId": {"type": "string"},
"createdDate": {"$ref": "#/definitions/date"},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"projectId": {"type": "string"},
"status": {"$ref": "#/definitions/paged"},
"participants": {"$ref": "#/definitions/paged"}
}
},
"examples": {"application/json": "{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\"],\"issueId\":\"107001\",\"issueKey\":\"HELPDESK-1\",\"requestTypeId\":\"25\",\"serviceDeskId\":\"10\",\"createdDate\":{\"iso8601\":\"2015-10-08T14:42:00+0700\",\"jira\":\"2015-10-08T14:42:00.000+0700\",\"friendly\":\"Monday 14:42 PM\",\"epochMillis\":1444290120000},\"reporter\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"requestFieldValues\":[{\"fieldId\":\"summary\",\"label\":\"What do you need?\",\"value\":\"Request JSD help via REST\"},{\"fieldId\":\"description\",\"label\":\"Why do you need this?\",\"value\":\"I need a new mouse for my Mac\"}],\"currentStatus\":{\"status\":\"Waiting for Support\",\"statusDate\":{\"iso8601\":\"2015-10-08T14:01:00+0700\",\"jira\":\"2015-10-08T14:01:00.000+0700\",\"friendly\":\"Today 14:01 PM\",\"epochMillis\":1444287660000}},\"_links\":{\"jiraRest\":\"http://host:port/context/rest/api/2/issue/107001\",\"web\":\"http://host:port/context/servicedesk/customer/portal/10/HELPDESK-1\",\"self\":\"http://host:port/context/rest/servicedeskapi/request/107001\"}}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to access the service desk, or if the user cannot view the customer request."},
"404": {"description": "Returned if the customer request does not exist."}
},
"parameters": [{
"in": "query",
"name": "expand",
"description": "This is a multi-value parameter indicating which properties of the customer request to expand:"
}]
}
},
"servicedeskapi/request/{issueIdOrKey}/attachment": {
"post": {
"produces": ["application/json"],
"operationId": "attachment-createAttachment",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment-create-result#",
"additionalProperties": false,
"title": "Attachment Create Result",
"type": "object",
"properties": {
"attachments": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Attachment",
"type": "object",
"properties": {
"filename": {"type": "string"},
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Attachment Link",
"type": "object",
"properties": {
"thumbnail": {
"format": "uri",
"type": "string"
},
"jiraRest": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
},
"content": {
"format": "uri",
"type": "string"
}
}
},
"author": {"$ref": "#/definitions/user"},
"created": {"$ref": "#/definitions/date"},
"mimeType": {"type": "string"}
},
"required": ["size"]
}
},
"comment": {
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"public": {"type": "boolean"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"author": {"$ref": "#/definitions/user"},
"created": {"$ref": "#/definitions/date"},
"id": {"type": "string"},
"body": {"type": "string"}
},
"required": ["public"]
}
}
},
"examples": {"application/json": "{\"comment\":{\"id\":\"1000\",\"body\":\"Please find the screenshot and the log file attached. !screenshot.png|thumbnail! [^log.txt] _(32 kB)_\",\"public\":true,\"author\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"created\":{\"iso8601\":\"2015-10-09T10:22:00+0700\",\"jira\":\"2015-10-09T10:22:00.000+0700\",\"friendly\":\"Today 10:22 AM\",\"epochMillis\":1444360920000},\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/request/2000/comment/1000\"}},\"attachments\":[{\"filename\":\"screenshot.png\",\"author\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"created\":{\"iso8601\":\"2015-10-09T10:22:00+0700\",\"jira\":\"2015-10-09T10:22:00.000+0700\",\"friendly\":\"Today 10:22 AM\",\"epochMillis\":1444360920000},\"size\":23123,\"mimeType\":\"image/png\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/attachment/10000\",\"content\":\"http://www.example.com/jira/servicedesk/customershim/secure/attachment/10000/screenshot.png\",\"thumbnail\":\"http://www.example.com/jira/servicedesk/customershim/secure/thumbnail/10000/_thumb_10000.png\"}},{\"filename\":\"log.txt\",\"author\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"created\":{\"iso8601\":\"2015-10-09T10:22:00+0700\",\"jira\":\"2015-10-09T10:22:00.000+0700\",\"friendly\":\"Today 10:22 AM\",\"epochMillis\":1444360920000},\"size\":32132,\"mimeType\":\"text/plain\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/attachment/10001\",\"content\":\"http://www.example.com/jira/servicedesk/customershim/secure/attachment/10001/log.txt\"}}]}"}
},
"400": {"description": "Returned if the HTTP request is invalid, e.g. missing the required \"public\" field, or list of temporary attachment IDs, or the temporary attachment are expired."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to add an attachment, or the attachment violates permission checks."},
"404": {"description": "Returned if the customer request does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/attachment-create#",
"additionalProperties": false,
"title": "Attachment Create",
"type": "object",
"properties": {
"temporaryAttachmentIds": {
"type": "array",
"items": {"type": "string"}
},
"public": {"type": "boolean"},
"additionalComment": {
"additionalProperties": false,
"title": "Additional Comment",
"type": "object",
"properties": {"body": {"type": "string"}}
}
}
},
"in": "body",
"name": "attachment-createAttachment-input",
"required": true
}]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
}]
},
"servicedeskapi/servicedesk/{serviceDeskId}/requesttype": {
"post": {
"produces": ["application/json"],
"operationId": "requesttype-createRequestType",
"responses": {
"200": {"examples": {"application/json": "{\"id\":\"11001\",\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/servicedesk/10001/requesttype/11001\"},\"name\":\"Get IT Help\",\"description\":\"Get IT Help\",\"helpText\":\"Please tell us clearly the problem you have within 100 words.\",\"serviceDeskId\":\"10001\",\"groupIds\":[\"12\"],\"icon\":{\"id\":\"12345\",\"_links\":{\"iconUrls\":{\"48x48\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=large&avatarId=12345\",\"24x24\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=small&avatarId=12345\",\"16x16\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=xsmall&avatarId=12345\",\"32x32\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=medium&avatarId=12345\"}}}}"}},
"400": {"description": "Returned if request type name is empty."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to create a new request type."},
"404": {"description": "Returned if the service desk or issue type does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/request-type-create#",
"additionalProperties": false,
"title": "Request Type Create",
"type": "object",
"properties": {
"issueTypeId": {"type": "string"},
"helpText": {"type": "string"},
"name": {"type": "string"},
"description": {"type": "string"}
}
},
"in": "body",
"name": "requesttype-createRequestType-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "requesttype-getRequestTypeById",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/request-type#",
"additionalProperties": false,
"title": "Request Type",
"type": "object",
"properties": {
"helpText": {"type": "string"},
"serviceDeskId": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"groupIds": {
"type": "array",
"items": {"type": "string"}
},
"name": {"type": "string"},
"icon": {
"additionalProperties": false,
"title": "Request Type Icon",
"type": "object",
"properties": {
"_links": {
"additionalProperties": false,
"title": "Request Type Icon Link",
"type": "object",
"properties": {"iconUrls": {
"patternProperties": {".+": {
"format": "uri",
"type": "string"
}},
"additionalProperties": false,
"type": "object"
}}
},
"id": {"type": "string"}
}
},
"description": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "{\"id\":\"11001\",\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/servicedesk/10001/requesttype/11001\"},\"name\":\"Get IT Help\",\"description\":\"Get IT Help\",\"helpText\":\"Please tell us clearly the problem you have within 100 words.\",\"serviceDeskId\":\"10001\",\"groupIds\":[\"12\"],\"icon\":{\"id\":\"12345\",\"_links\":{\"iconUrls\":{\"48x48\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=large&avatarId=12345\",\"24x24\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=small&avatarId=12345\",\"16x16\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=xsmall&avatarId=12345\",\"32x32\":\"http://host:port/context/secure/viewavatar?avatarType=SD_REQTYPE&size=medium&avatarId=12345\"}}}}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to access the service desk."},
"404": {"description": "Returned if the service desk or request type does not exist."}
}
},
"parameters": [{
"in": "path",
"name": "serviceDeskId",
"type": "string",
"required": true
}]
},
"servicedeskapi/request/{issueIdOrKey}/participant": {
"post": {
"produces": ["application/json"],
"operationId": "participant-addRequestParticipants",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/paged-of-user#",
"additionalProperties": false,
"title": "Paged of User",
"type": "object",
"properties": {
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Paged Link",
"type": "object",
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"context": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"base": {
"format": "uri",
"type": "string"
}
}
},
"isLastPage": {"type": "boolean"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"start": {"type": "integer"},
"limit": {"type": "integer"}
}
},
"examples": {"application/json": "{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"http://host:port/context/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"http://host:port/context/rest/servicedeskapi/request/1000/participant?start=2&limit=1\",\"prev\":\"http://host:port/context/rest/servicedeskapi/request/1000/participant?start=0&limit=1\"},\"values\":[{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}]}"}
},
"400": {"description": "Returned if any user in the request does not exist."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to manage participants of the customer request."},
"404": {"description": "Returned if the customer request does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/request-participant-update#",
"additionalProperties": false,
"title": "Request Participant Update",
"type": "object",
"properties": {"usernames": {
"type": "array",
"items": {"type": "string"}
}}
},
"in": "body",
"name": "participant-addRequestParticipants-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "participant-getRequestParticipants",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/paged-of-user#",
"additionalProperties": false,
"title": "Paged of User",
"type": "object",
"properties": {
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Paged Link",
"type": "object",
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"context": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"base": {
"format": "uri",
"type": "string"
}
}
},
"isLastPage": {"type": "boolean"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"start": {"type": "integer"},
"limit": {"type": "integer"}
}
},
"examples": {"application/json": "{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"http://host:port/context/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"http://host:port/context/rest/servicedeskapi/request/1000/participant?start=2&limit=1\",\"prev\":\"http://host:port/context/rest/servicedeskapi/request/1000/participant?start=0&limit=1\"},\"values\":[{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}]}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to view the customer request."},
"404": {"description": "Returned if the customer request does not exist."}
},
"parameters": [
{
"in": "query",
"name": "start",
"description": "The starting index of the returned objects. Base index: 0. See the Pagination section for more details."
},
{
"in": "query",
"name": "limit",
"description": "The maximum number of request types to return per page. Default: 50. See the Pagination section for more details."
}
]
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
}],
"delete": {
"produces": ["application/json"],
"operationId": "participant-removeRequestParticipants",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/paged-of-user#",
"additionalProperties": false,
"title": "Paged of User",
"type": "object",
"properties": {
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Paged Link",
"type": "object",
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"context": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"base": {
"format": "uri",
"type": "string"
}
}
},
"isLastPage": {"type": "boolean"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"start": {"type": "integer"},
"limit": {"type": "integer"}
}
},
"examples": {"application/json": "{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"http://host:port/context/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"http://host:port/context/rest/servicedeskapi/request/1000/participant?start=2&limit=1\",\"prev\":\"http://host:port/context/rest/servicedeskapi/request/1000/participant?start=0&limit=1\"},\"values\":[{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}]}"}
},
"400": {"description": "Returned if any user in the request does not exist, or is not a participant of the customer request, or is the reporter of the customer request."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to manage participants of the customer request."},
"404": {"description": "Returned if the customer request does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/request-participant-update#",
"additionalProperties": false,
"title": "Request Participant Update",
"type": "object",
"properties": {"usernames": {
"type": "array",
"items": {"type": "string"}
}}
},
"in": "body",
"name": "participant-removeRequestParticipants-input",
"required": true
}]
}
},
"servicedeskapi/admin/queues": {
"get": {
"produces": ["application/json"],
"operationId": "queues-getQueueSettingsOnProject",
"responses": {"200": {}}
},
"put": {
"produces": ["application/json"],
"operationId": "queues-setShouldQueuesIncludeCountGlobally",
"responses": {"200": {}},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/boolean#",
"title": "boolean",
"type": "boolean"
},
"in": "body",
"name": "queues-setShouldQueuesIncludeCountGlobally-input",
"required": true
}]
}
},
"servicedeskapi/organization": {
"post": {
"produces": ["application/json"],
"operationId": "organization-addUsersToOrganization",
"responses": {
"400": {"description": "Some usernames are incorrect"},
"401": {"description": "Returned if the user is not logged in."},
"204": {"description": "Returns a paged list of users of the organization"},
"403": {"description": "Returned if the user is not permitted to add users."},
"404": {"description": "Returned if the organization does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/users-organization-update#",
"additionalProperties": false,
"title": "Users Organization Update",
"type": "object",
"properties": {"usernames": {
"type": "array",
"items": {"type": "string"}
}}
},
"in": "body",
"name": "organization-addUsersToOrganization-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "organization-getUsersInOrganization",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"examples": {"application/json": "{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user is not an agent."},
"404": {"description": "Returned if the organization does not exist."}
},
"parameters": [
{
"in": "query",
"name": "start",
"description": "The starting index of the returned objects. Base index: 0. See the Pagination section for more details."
},
{
"in": "query",
"name": "limit",
"description": "The maximum number of users to return per page. Default: 50. See the Pagination section for more details."
}
]
},
"delete": {
"produces": ["application/json"],
"operationId": "organization-removeUsersFromOrganization",
"responses": {
"400": {"description": "Some usernames are incorrect"},
"401": {"description": "Returned if the user is not logged in."},
"204": {},
"403": {"description": "Returned if the user is not permitted to remove users from an organization."},
"404": {"description": "Returned if the organization does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/users-organization-update#",
"additionalProperties": false,
"title": "Users Organization Update",
"type": "object",
"properties": {"usernames": {
"type": "array",
"items": {"type": "string"}
}}
},
"in": "body",
"name": "organization-removeUsersFromOrganization-input",
"required": true
}]
}
},
"servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile": {
"post": {
"produces": ["application/json"],
"operationId": "attachTemporaryFile-attachTemporaryFile",
"responses": {
"201": {"examples": {"application/json": "{\"temporaryAttachments\":[{\"temporaryAttachmentId\":\"temp8186986881700442965\",\"fileName\":\"atlassian.png\"},{\"temporaryAttachmentId\":\"temp589064256337898328\",\"fileName\":\"readme.txt\"}]}"}},
"400": {"description": "Returned if attachments are not invalid, or exceeds the maximum configured attachment size."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if attachments is disabled or if you don't have permission to add attachments, or if no permission to access the Service Desk"},
"404": {"description": "Returned if the Service Desk is not found"}
}
},
"parameters": [{
"in": "path",
"name": "serviceDeskId",
"type": "string",
"required": true
}]
},
"servicedeskapi/servicedesk/{serviceDeskId}/queue": {
"get": {
"produces": ["application/json"],
"operationId": "queue-getIssuesInQueue",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/paged-of-issue#",
"additionalProperties": false,
"title": "Paged of Issue",
"type": "object",
"properties": {
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Paged Link",
"type": "object",
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"context": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"base": {
"format": "uri",
"type": "string"
}
}
},
"isLastPage": {"type": "boolean"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Issue",
"type": "object",
"properties": {
"schema": {
"patternProperties": {".+": {"$ref": "#/definitions/json-type"}},
"additionalProperties": false,
"type": "object"
},
"editmeta": {
"additionalProperties": false,
"title": "Edit Meta",
"type": "object",
"properties": {"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}}
},
"fieldsToInclude": {
"title": "Included Fields",
"type": "object"
},
"changelog": {
"additionalProperties": false,
"title": "Changelog",
"type": "object",
"properties": {
"total": {"type": "integer"},
"maxResults": {"type": "integer"},
"histories": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change History",
"type": "object",
"properties": {
"historyMetadata": {
"additionalProperties": false,
"title": "History Metadata",
"type": "object",
"properties": {
"emailDescription": {"type": "string"},
"actor": {"$ref": "#/definitions/history-metadata-participant"},
"extraData": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"activityDescriptionKey": {"type": "string"},
"emailDescriptionKey": {"type": "string"},
"descriptionKey": {"type": "string"},
"description": {"type": "string"},
"generator": {"$ref": "#/definitions/history-metadata-participant"},
"cause": {"$ref": "#/definitions/history-metadata-participant"},
"activityDescription": {"type": "string"},
"type": {"type": "string"}
}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {"type": "string"},
"id": {"type": "string"},
"items": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Change Item",
"type": "object",
"properties": {
"field": {"type": "string"},
"from": {"type": "string"},
"toString": {"type": "string"},
"fromString": {"type": "string"},
"to": {"type": "string"},
"fieldtype": {"type": "string"}
}
}
}
}
}
},
"startAt": {"type": "integer"}
}
},
"transitions": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Transition",
"type": "object",
"properties": {
"expand": {"type": "string"},
"name": {"type": "string"},
"id": {"type": "string"},
"to": {
"additionalProperties": false,
"title": "Status",
"type": "object",
"properties": {
"statusColor": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"description": {"type": "string"},
"iconUrl": {"type": "string"},
"id": {"type": "string"},
"statusCategory": {
"additionalProperties": false,
"title": "Status Category",
"type": "object",
"properties": {
"colorName": {"type": "string"},
"name": {"type": "string"},
"self": {"type": "string"},
"id": {"type": "integer"},
"key": {"type": "string"}
}
}
}
},
"fields": {
"patternProperties": {".+": {"$ref": "#/definitions/field-meta"}},
"additionalProperties": false,
"type": "object"
}
}
}
},
"renderedFields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"expand": {"type": "string"},
"names": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"operations": {
"additionalProperties": false,
"title": "Opsbar",
"type": "object",
"properties": {"linkGroups": {
"type": "array",
"items": {"$ref": "#/definitions/link-group"}
}}
},
"versionedRepresentations": {
"patternProperties": {".+": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
},
"id": {"type": "string"},
"fields": {
"patternProperties": {".+": {}},
"additionalProperties": false,
"type": "object"
},
"key": {"type": "string"},
"properties": {
"additionalProperties": false,
"title": "Properties",
"type": "object",
"properties": {"properties": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
}}
}
}
}
},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"start": {"type": "integer"},
"limit": {"type": "integer"}
}
},
"examples": {"application/json": "{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"http://host:port/context/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"http://host:port/context/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=2&limit=1\",\"prev\":\"http://host:port/context/rest/servicedeskapi/servicedesk/1/queue/10/issue?start=0&limit=1\"},\"values\":[{\"id\":\"10001\",\"self\":\"http://host:port/context/rest/servicedeskapi/rest/api/2/issue/10001\",\"key\":\"SD-1\",\"fields\":{\"summary\":\"My keyboard is broken\",\"issuetype\":{\"self\":\"http://host:port/context/rest/api/2/issuetype/13\",\"id\":\"13\",\"description\":\"For general IT problems and questions. Created by JIRA Service Desk.\",\"iconUrl\":\"http://host:port/context/servicedesk/issue-type-icons?icon=it-help\",\"name\":\"IT Help\",\"subtask\":false,\"avatarId\":10002},\"duedate\":\"2015-11-11T14:17:13.000+0700\",\"created\":\"2015-11-09T14:17:13.000+0700\",\"reporter\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}}}]}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to view the queue."},
"404": {"description": "Returned if the service desk or the queue do not exist."}
},
"parameters": [
{
"in": "query",
"name": "start",
"description": "The starting index of the returned objects. Base index: 0. See the Pagination section for more details."
},
{
"in": "query",
"name": "limit",
"description": "The maximum number of items to return per page. Default: 50. See the Pagination section for more details."
}
]
},
"parameters": [{
"in": "path",
"name": "serviceDeskId",
"type": "string",
"required": true
}]
},
"servicedeskapi/customer": {"post": {
"produces": ["application/json"],
"operationId": "customer-createCustomer",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/user#",
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"examples": {"application/json": "{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}"}
},
"400": {"description": "Returned if the HTTP request is invalid, e.g. invalid email address, or if the username (email) already exists."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to create a customer."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/customer-create#",
"additionalProperties": false,
"title": "Customer Create",
"type": "object",
"properties": {
"fullName": {"type": "string"},
"email": {"type": "string"}
}
},
"in": "body",
"name": "customer-createCustomer-input",
"required": true
}]
}},
"servicedeskapi/servicedesk/{serviceDeskId}/customer": {
"post": {
"produces": ["application/json"],
"operationId": "customer-addCustomers",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/paged-of-user#",
"additionalProperties": false,
"title": "Paged of User",
"type": "object",
"properties": {
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Paged Link",
"type": "object",
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"context": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"base": {
"format": "uri",
"type": "string"
}
}
},
"isLastPage": {"type": "boolean"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"start": {"type": "integer"},
"limit": {"type": "integer"}
}
},
"examples": {"application/json": "{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"http://host:port/context/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"http://host:port/context/rest/servicedeskapi/servicedesk/1/customer?start=2&limit=1\",\"prev\":\"http://host:port/context/rest/servicedeskapi/servicedesk/1/customer?start=0&limit=1\"},\"values\":[{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}}]}"}
},
"201": {"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/paged-of-user#",
"additionalProperties": false,
"title": "Paged of User",
"type": "object",
"properties": {
"size": {"type": "integer"},
"_links": {
"additionalProperties": false,
"title": "Paged Link",
"type": "object",
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"context": {"type": "string"},
"self": {
"format": "uri",
"type": "string"
},
"base": {
"format": "uri",
"type": "string"
}
}
},
"isLastPage": {"type": "boolean"},
"values": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
}
},
"_expands": {
"type": "array",
"items": {"type": "string"}
},
"start": {"type": "integer"},
"limit": {"type": "integer"}
}
}},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to add a participant."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/service-desk-customer-add#",
"additionalProperties": false,
"title": "Service Desk Customer Add",
"type": "object",
"properties": {"usernames": {
"type": "array",
"items": {"type": "string"}
}}
},
"in": "body",
"name": "customer-addCustomers-input",
"required": true
}]
},
"parameters": [{
"in": "path",
"name": "serviceDeskId",
"type": "string",
"required": true
}]
},
"servicedeskapi/request/{issueIdOrKey}/comment": {
"post": {
"produces": ["application/json"],
"operationId": "comment-createRequestComment",
"responses": {
"201": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment#",
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"public": {"type": "boolean"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {
"additionalProperties": false,
"title": "Date",
"type": "object",
"properties": {
"iso8601": {"type": "string"},
"friendly": {"type": "string"},
"epochMillis": {"type": "integer"},
"jira": {"type": "string"}
}
},
"id": {"type": "string"},
"body": {"type": "string"}
},
"required": ["public"]
},
"examples": {"application/json": "{\"id\":\"1000\",\"body\":\"Hello there\",\"public\":true,\"author\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"created\":{\"iso8601\":\"2015-10-09T10:22:00+0700\",\"jira\":\"2015-10-09T10:22:00.000+0700\",\"friendly\":\"Today 10:22 AM\",\"epochMillis\":1444360920000},\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/request/2000/comment/1000\"}}"}
},
"400": {"description": "Returned if the HTTP request is invalid, e.g. missing the required \"public\" field."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to add a comment, or the comment violates permission checks."},
"404": {"description": "Returned if the customer request does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment-create#",
"additionalProperties": false,
"title": "Comment Create",
"type": "object",
"properties": {
"public": {"type": "boolean"},
"body": {"type": "string"}
}
},
"in": "body",
"name": "comment-createRequestComment-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "comment-getRequestCommentById",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/comment#",
"additionalProperties": false,
"title": "Comment",
"type": "object",
"properties": {
"public": {"type": "boolean"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"author": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"created": {
"additionalProperties": false,
"title": "Date",
"type": "object",
"properties": {
"iso8601": {"type": "string"},
"friendly": {"type": "string"},
"epochMillis": {"type": "integer"},
"jira": {"type": "string"}
}
},
"id": {"type": "string"},
"body": {"type": "string"}
},
"required": ["public"]
},
"examples": {"application/json": "{\"id\":\"1000\",\"body\":\"Hello there\",\"public\":true,\"author\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"created\":{\"iso8601\":\"2015-10-09T10:22:00+0700\",\"jira\":\"2015-10-09T10:22:00.000+0700\",\"friendly\":\"Today 10:22 AM\",\"epochMillis\":1444360920000},\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/request/2000/comment/1000\"}}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the authenticated user does not have permission to view the customer request or the comment."},
"404": {"description": "Returned if the customer request or the comment do not exist."}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
}]
},
"servicedeskapi/request/{issueIdOrKey}/approval": {
"post": {
"produces": ["application/json"],
"operationId": "approval-answerApproval",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/approval#",
"additionalProperties": false,
"title": "Approval",
"type": "object",
"properties": {
"createdDate": {"$ref": "#/definitions/date"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"name": {"type": "string"},
"canAnswerApproval": {"type": "boolean"},
"finalDecision": {
"type": "string",
"enum": [
"approved",
"declined",
"pending"
]
},
"approvers": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Approver",
"type": "object",
"properties": {
"approver": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"approverDecision": {
"type": "string",
"enum": [
"approved",
"declined",
"pending"
]
}
}
}
},
"id": {"type": "string"},
"completedDate": {"$ref": "#/definitions/date"}
},
"required": ["canAnswerApproval"]
},
"examples": {"application/json": "{\"id\":\"1\",\"name\":\"Please approve this request\",\"finalDecision\":\"approved\",\"canAnswerApproval\":false,\"approvers\":[{\"approver\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"approverDecision\":\"approved\"}],\"createdDate\":{\"iso8601\":\"2016-09-28T14:01:00+0700\",\"jira\":\"2016-09-28T14:01:00.000+0700\",\"friendly\":\"Monday 14:01 PM\",\"epochMillis\":1475046060000},\"completedDate\":{\"iso8601\":\"2016-09-29T14:30:00+0700\",\"jira\":\"2016-09-29T14:30:00.000+0700\",\"friendly\":\"Today 14:30 PM\",\"epochMillis\":1475134200000},\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/request/2/approval/1\"}}"}
},
"400": {"description": "Returned if the request isn't in a status that has the approval or the approval already got decided."},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user isn't an approver of the approval or the user doesn't have permission to view the request."},
"404": {"description": "Returned if the request doesn't exist or the approval doesn't exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/approval-decision-request#",
"additionalProperties": false,
"title": "Approval Decision Request",
"type": "object",
"properties": {"decision": {
"type": "string",
"enum": [
"approve",
"decline"
]
}}
},
"in": "body",
"name": "approval-answerApproval-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "approval-getApprovalById",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/approval#",
"additionalProperties": false,
"title": "Approval",
"type": "object",
"properties": {
"createdDate": {"$ref": "#/definitions/date"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"name": {"type": "string"},
"canAnswerApproval": {"type": "boolean"},
"finalDecision": {
"type": "string",
"enum": [
"approved",
"declined",
"pending"
]
},
"approvers": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Approver",
"type": "object",
"properties": {
"approver": {
"additionalProperties": false,
"title": "User",
"type": "object",
"properties": {
"emailAddress": {"type": "string"},
"_links": {
"additionalProperties": false,
"title": "User Link",
"type": "object",
"properties": {
"jiraRest": {
"format": "uri",
"type": "string"
},
"avatarUrls": {
"patternProperties": {".+": {"type": "string"}},
"additionalProperties": false,
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
}
}
},
"displayName": {"type": "string"},
"name": {"type": "string"},
"active": {"type": "boolean"},
"timeZone": {"type": "string"},
"key": {"type": "string"}
},
"required": ["active"]
},
"approverDecision": {
"type": "string",
"enum": [
"approved",
"declined",
"pending"
]
}
}
}
},
"id": {"type": "string"},
"completedDate": {"$ref": "#/definitions/date"}
},
"required": ["canAnswerApproval"]
},
"examples": {"application/json": "{\"id\":\"1\",\"name\":\"Please approve this request\",\"finalDecision\":\"approved\",\"canAnswerApproval\":false,\"approvers\":[{\"approver\":{\"name\":\"fred\",\"key\":\"fred\",\"emailAddress\":\"[email protected]\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"http://www.example.com/jira/rest/api/2/user?username=fred\",\"avatarUrls\":{\"48x48\":\"http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred\",\"24x24\":\"http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred\",\"16x16\":\"http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred\",\"32x32\":\"http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred\"},\"self\":\"http://www.example.com/jira/rest/api/2/user?username=fred\"}},\"approverDecision\":\"approved\"}],\"createdDate\":{\"iso8601\":\"2016-09-28T14:01:00+0700\",\"jira\":\"2016-09-28T14:01:00.000+0700\",\"friendly\":\"Monday 14:01 PM\",\"epochMillis\":1475046060000},\"completedDate\":{\"iso8601\":\"2016-09-29T14:30:00+0700\",\"jira\":\"2016-09-29T14:30:00.000+0700\",\"friendly\":\"Today 14:30 PM\",\"epochMillis\":1475134200000},\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/request/2/approval/1\"}}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the authenticated user does not have permission to view the request."},
"404": {"description": "Returned if the request or the approval does not exist."}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
}]
},
"servicedeskapi/servicedesk/{serviceDeskId}/organization": {
"post": {
"produces": ["application/json"],
"operationId": "organization-addOrganization",
"responses": {
"401": {"description": "Returned if the user is not logged in."},
"204": {"description": "Add organization was successful."},
"403": {"description": "Returned if the user is not an agent of the servicedesk."},
"404": {"description": "Returned if the servicedesk or organization does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/organization-service-desk-update#",
"additionalProperties": false,
"title": "Organization Service Desk Update",
"type": "object",
"properties": {"organizationId": {"type": "integer"}}
},
"in": "body",
"name": "organization-addOrganization-input",
"required": true
}]
},
"get": {
"produces": ["application/json"],
"operationId": "organization-getOrganizations",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/organization#",
"additionalProperties": false,
"title": "Organization",
"type": "object",
"properties": {
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"name": {"type": "string"},
"id": {"type": "string"}
}
},
"examples": {"application/json": "{\"_expands\":[],\"size\":3,\"start\":3,\"limit\":3,\"isLastPage\":false,\"_links\":{\"base\":\"http://host:port/context/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"http://host:port/context/rest/servicedeskapi/servicedesk/10001/organization?start=6&limit=3\",\"prev\":\"http://host:port/context/rest/servicedeskapi/servicedesk/10001/organization?start=0&limit=3\"},\"values\":[{\"id\":\"1\",\"name\":\"Charlie Cakes Franchises\",\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/organization/1\"}},{\"id\":\"2\",\"name\":\"Atlas Coffee Co\",\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/organization/2\"}},{\"id\":\"3\",\"name\":\"The Adjustment Bureau\",\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/organization/3\"}}]}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user is not an agent of the servicedesk."},
"404": {"description": "Returned if the servicedesk does not exist."}
},
"parameters": [
{
"in": "query",
"name": "start"
},
{
"in": "query",
"name": "limit"
}
]
},
"parameters": [{
"in": "path",
"name": "serviceDeskId",
"type": "string",
"required": true
}],
"delete": {
"produces": ["application/json"],
"operationId": "organization-removeOrganization",
"responses": {
"401": {"description": "Returned if the user is not logged in."},
"204": {"description": "Remove organization was successful."},
"403": {"description": "Returned if the user is not an agent of the servicedesk."},
"404": {"description": "Returned if the servicedesk or organization does not exist."}
},
"parameters": [{
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/organization-service-desk-update#",
"additionalProperties": false,
"title": "Organization Service Desk Update",
"type": "object",
"properties": {"organizationId": {"type": "integer"}}
},
"in": "body",
"name": "organization-removeOrganization-input",
"required": true
}]
}
},
"servicedeskapi/info": {"get": {
"produces": ["application/json"],
"operationId": "info-getInfo",
"responses": {"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/software-info#",
"additionalProperties": false,
"title": "Software Info",
"type": "object",
"properties": {
"buildChangeSet": {"type": "string"},
"isLicensedForUse": {"type": "boolean"},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"platformVersion": {"type": "string"},
"buildDate": {
"additionalProperties": false,
"title": "Date",
"type": "object",
"properties": {
"iso8601": {"type": "string"},
"friendly": {"type": "string"},
"epochMillis": {"type": "integer"},
"jira": {"type": "string"}
}
},
"version": {"type": "string"}
}
},
"examples": {"application/json": "{\"version\":\"3.0.1\",\"platformVersion\":\"7.0.1\",\"buildDate\":{\"iso8601\":\"2015-09-15T02:34:00+0700\",\"jira\":\"2015-09-15T02:34:00.000+0700\",\"friendly\":\"Monday 02:34 AM\",\"epochMillis\":1442259240000},\"buildChangeSet\":\"c6679417c550918e7c94a9eaaada133f15dc8ff0\",\"isLicensedForUse\":true,\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/info\"}}"}
}}
}},
"servicedeskapi/request/{issueIdOrKey}/sla": {
"get": {
"produces": ["application/json"],
"operationId": "sla-getSlaInformationById",
"responses": {
"200": {
"schema": {
"id": "https://docs.atlassian.com/jira/REST/schema/sla-information#",
"additionalProperties": false,
"title": "Sla Information",
"type": "object",
"properties": {
"ongoingCycle": {
"additionalProperties": false,
"title": "Sla Information Ongoing Cycle",
"type": "object",
"properties": {
"paused": {"type": "boolean"},
"goalDuration": {"$ref": "#/definitions/duration"},
"breachTime": {"$ref": "#/definitions/date"},
"breached": {"type": "boolean"},
"startTime": {"$ref": "#/definitions/date"},
"withinCalendarHours": {"type": "boolean"},
"elapsedTime": {"$ref": "#/definitions/duration"},
"remainingTime": {"$ref": "#/definitions/duration"}
},
"required": [
"breached",
"paused",
"withinCalendarHours"
]
},
"_links": {
"additionalProperties": false,
"title": "Self Link",
"type": "object",
"properties": {"self": {
"format": "uri",
"type": "string"
}}
},
"name": {"type": "string"},
"completedCycles": {
"type": "array",
"items": {
"additionalProperties": false,
"title": "Sla Information Completed Cycle",
"type": "object",
"properties": {
"goalDuration": {"$ref": "#/definitions/duration"},
"breached": {"type": "boolean"},
"startTime": {"$ref": "#/definitions/date"},
"stopTime": {"$ref": "#/definitions/date"},
"elapsedTime": {"$ref": "#/definitions/duration"},
"remainingTime": {"$ref": "#/definitions/duration"}
},
"required": ["breached"]
}
},
"id": {"type": "string"}
}
},
"examples": {"application/json": "{\"name\":\"Time To First Response\",\"_links\":{\"self\":\"http://host:port/context/rest/servicedeskapi/request/101102/sla/10030\"},\"completedCycles\":[{\"startTime\":{\"iso8601\":\"2015-10-09T10:45:23+0700\",\"jira\":\"2015-10-09T10:45:23.000+0700\",\"friendly\":\"Yesterday 10:45 AM\",\"epochMillis\":1444362323000},\"stopTime\":{\"iso8601\":\"2015-10-09T10:52:23+0700\",\"jira\":\"2015-10-09T10:52:23.000+0700\",\"friendly\":\"Yesterday 10:52 AM\",\"epochMillis\":1444362743000},\"breached\":false,\"goalDuration\":{\"millis\":14400000,\"friendly\":\"4h 240m\"},\"elapsedTime\":{\"millis\":420000,\"friendly\":\"0h 7m\"},\"remainingTime\":{\"millis\":13980000,\"friendly\":\"3h 233m\"}},{\"startTime\":{\"iso8601\":\"2015-10-10T10:52:23+0700\",\"jira\":\"2015-10-10T10:52:23.000+0700\",\"friendly\":\"Today 10:52 AM\",\"epochMillis\":1444449143000},\"stopTime\":{\"iso8601\":\"2015-10-10T16:15:23+0700\",\"jira\":\"2015-10-10T16:15:23.000+0700\",\"friendly\":\"Today 16:15 PM\",\"epochMillis\":1444468523000},\"breached\":true,\"goalDuration\":{\"millis\":14400000,\"friendly\":\"4h 240m\"},\"elapsedTime\":{\"millis\":19380000,\"friendly\":\"5h 323m\"},\"remainingTime\":{\"millis\":-4980000,\"friendly\":\"-1h -83m\"}}],\"ongoingCycle\":{\"startTime\":{\"iso8601\":\"2015-10-10T19:15:23+0700\",\"jira\":\"2015-10-10T19:15:23.000+0700\",\"friendly\":\"Today 19:15 PM\",\"epochMillis\":1444479323000},\"breached\":false,\"paused\":false,\"withinCalendarHours\":false,\"goalDuration\":{\"millis\":14400000,\"friendly\":\"4h 240m\"},\"elapsedTime\":{\"millis\":5640000,\"friendly\":\"1h 94m\"},\"remainingTime\":{\"millis\":8760000,\"friendly\":\"2h 146m\"}}}"}
},
"401": {"description": "Returned if the user is not logged in."},
"403": {"description": "Returned if the user does not have permission to view the customer request."},
"404": {"description": "Returned if the customer request does not exist."}
}
},
"parameters": [{
"in": "path",
"name": "issueIdOrKey",
"type": "string",
"required": true
}]
},
"servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup": {
"get": {
"produces": ["application/json"],
"operationId": "requesttypegroup-getRequestTypeGroups",
"responses": {
"200
Raw
jsd-api.json
View raw

(Sorry about that, but we can’t show files that are this big right now.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment