{ "x-atlassian-narrative" : { "documents" : [ { "anchor" : "about", "body" : "The Jira REST API enables you to interact with Jira programmatically. Use this API to \n[build apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/), script interactions with \nJira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including \nthe HTTP response codes and example requests and responses.\n\n**NOTE:** Personal data that is used to identify users, such as `username` and `userKey`, has been \nremoved from the Jira Cloud REST APIs. In addition, other personal data (for example, email) is now restricted by a \nuser's profile settings (or in the case of managed accounts, the visibility settings decided by the site administrator). \nYou must update your apps to accommodate these changes, if you have not done so already. This change was previously \nannounced on 01 October 2018 and followed by a deprecation period \n(see the [announcement](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)).", "title" : "About" }, { "title" : "Version and URI", "body" : "This documentation is for **version 3** of the Jira Cloud platform REST API, which is the latest version. \n\nThe URIs for resources have the following structure:\n\n`https:///rest/api/3/`\n\nFor example,\n`https://your-domain.atlassian.net/rest/api/3/issue/DEMO-1`\n\n**Note that version 3 of the Jira Cloud platform REST API is in beta**. All the endpoints from the \n[version 2](https://developer.atlassian.com/cloud/jira/platform/rest/v2/) API are available. However,\nthey are under development and may change. \n\nThe change from version 2 is the introduction of the \n[Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) \nto: \n- `body` in comments, including where comments are used in issue, issue link, and transition resources.\n- `comment` in worklogs.\n- `description` and `environment` fields in issues.\n- `textarea` type custom fields (multi-line text fields) in issues. Single line custom fields \n (`textfield`) accept a string and don't handle Atlassian Document Format content.", "anchor" : "version" }, { "title" : "Authentication and authorization", "anchor" : "authentication", "body" : "### Connect apps\n\nFor Connect apps, authentication (JWT-based) is built into the Connect libraries. Authorization is implemented using either \nscopes (shown as _App scope required_ for operations on this page) or user impersonation. See \n[Security for Connect apps](https://developer.atlassian.com/cloud/jira/platform/security-for-connect-apps/) \nfor details.\n\n### Other integrations\n\nFor integrations that are not Connect apps, use OAuth 2.0 authorization code grants (3LO) for security \n(3LO scopes are shown as _OAuth scopes required_ for operations on this page). Basic authentication is also available, \nbut you should only use it for tools such as personal scripts or bots. See \n[Security for other integrations](https://developer.atlassian.com/cloud/jira/platform/security-for-other-integrations/) \nfor details." }, { "body" : "Most operations in this API require permissions. The calling user must have the required permissions for an operation to \nuse it. Note that for Connect apps, the app user must have the required permissions for the operation and the app must \nhave scopes that permit the operation.\n\nA permission can be granted to a group, project role, or issue role that the user is a member of, or granted directly to a user. \nSee [Permissions overview](https://confluence.atlassian.com/x/FQiiLQ) for details. The most common permissions are:\n\n- **Administer the Cloud site**: Users in the _site-admins_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) for details.\n- **Administer Jira**: Granted by the _Jira Administrators_ global permission. Users in the _administrators_ group have this \npermission. See [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.\n- **Administer a project in Jira**: Granted by the _Administer projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access a project in Jira**: Granted by the _Browse projects_ project permission for a project. This can be \ngranted to a user, a group, a project role, and more. \nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for details.\n- **Access Jira**: Granted by the _Jira Users_ global permission. Users in the _\\[product]-users_ (for example, \n_jira-software-users_) group have this permission. \nSee [Manage groups](https://confluence.atlassian.com/x/24xjL) and \n[Managing global permissions](https://confluence.atlassian.com/x/x4dKLg) for details.", "anchor" : "permissions", "title" : "Permissions" }, { "title" : "Expansion, pagination, and ordering", "body" : "### Expansion\n\nThe Jira REST API uses resource expansion, which means that some parts of a resource are not returned unless specified \nin the request. This simplifies responses and minimizes network traffic.\n\nTo expand part of a resource in a request, use the expand query parameter and specify the object(s) to be expanded. \nIf you need to expand nested objects, use the `.` dot notation. If you need to expand multiple objects, use a \ncomma-separated list. \n\nFor example, the following request expands the `names` and `renderedFields` properties for the _JRACLOUD-34423_ issue:\n\n`GET issue/JRACLOUD-34423?expand=names,renderedFields`\n\nTo discover which object can be expanded, refer to the `expand` property in the object. \nIn the JSON example below, the resource declares `widgets` as expandable.\n\n```json\n{\n \"expand\": \"widgets\", \n \"self\": \"https://your-domain.atlassian.net/rest/api/3/resource/KEY-1\", \n \"widgets\": {\n \"widgets\": [],\n \"size\": 5\n }\n}\n```\n\n### Pagination\n\nThe Jira REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large \ncollection of items. When you make a request to a paginated resource, the response wraps the returned array of values in \na JSON object with paging metadata. For example:\n\n```json\n{\n \"startAt\" : 0,\n \"maxResults\" : 10,\n \"total\": 200,\n \"isLast\": false,\n \"values\": [\n { /* result 0 */ },\n { /* result 1 */ },\n { /* result 2 */ }\n ]\n}\n```\n\n* `startAt` is the index of the first item returned in the page.\n* `maxResults` is the maximum number of items that can be returned per page. Each API endpoint may have a different \nlimit for the number of items returned, and these limits may change without notice.\n* `total` is the total number of items contained in all pages. This number **_may change_** as the client \nrequests the subsequent pages, therefore the client should always assume that the requested page can be empty. Note \nthat this property is not returned for all operations.\n* `isLast` indicates whether the page returned is the last one. Note that this property is not returned for all operations.\n\n### Ordering\n\nSome operations support ordering the elements of a response by a field. Check the documentation for the operation to \nconfirm whether ordering of a response is supported and which fields can be used. Responses are listed in ascending order \nby default. You can change the order using the `orderby` query parameter with a `-` or `+` symbol. For example:\n\n* `?orderBy=name` to order by `name` field ascending.\n* `?orderBy=+name` to order by `name` field ascending.\n* `?orderBy=-name` to order by `name` field descending.\n\n\n", "anchor" : "expansion" }, { "title" : "Special headers", "body" : "The following request and response headers define important metadata for the Jira Cloud REST API resources.\n\n- `X-Atlassian-Token` (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` \nheader in requests. Otherwise the request will be blocked by cross-site request forgery (CSRF/XSRF) protection.\n- `X-AACCOUNTID` (response): This response header contains the Atlassian account ID of the authenticated user.", "anchor" : "special-request-headers" }, { "body" : " Jira provides for all permissions, except the [global permission](https://confluence.atlassian.com/x/x4dKLg) Administer Jira, to be assigned to *Anyone*. Once a permission is assigned to *Anyone*, anyone knowing a project's URL is able to use the features in Jira enabled by the permission. However, the Jira REST API does not enable anonymous access for operations by default. This means that an anonymous user who may be able to perform an action through Jira, may not be able to perform the same action where it's enabled by the REST API. \n\n The operations that provide anonymous access are annotated \"This operation can be accessed anonymously.\"", "anchor" : "anonymous-operations", "title" : "Anonymous operations" }, { "anchor" : "async-operations", "body" : "Some Jira REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation \nwill schedule an asynchronous task and return a `303 (See Other)` response, indicating the location of the queued task \nin the `Location` header. You can query this task to get progress updates.\n\nWhen the task finishes, the response object will contain the `result` field. The content of the field is specific to the \noperation that created the task. Refer to the operation’s documentation for more information.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute \nin a certain order, you should start a task only after the prerequisite task(s) have finished.", "title" : "Asynchronous operations" }, { "title" : "Experimental features", "anchor" : "experimental", "body" : "Features and methods marked as experimental may change without notice. Feedback on experimental functionality is welcome. \nReport your suggestions and bugs in the [ACJIRA project](https://ecosystem.atlassian.net/projects/ACJIRA) (preferred) or use the \n**Give docs feedback** link at the top of this page. \n" }, { "body" : "The Jira Cloud platform REST API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. \nThe schema for the response body is shown below:\n\n\n```json\n{\n \"id\": \"https://docs.atlassian.com/jira/REST/schema/error-collection#\",\n \"title\": \"Error Collection\",\n \"type\": \"object\",\n \"properties\": {\n \"errorMessages\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"errors\": {\n \"type\": \"object\",\n \"patternProperties\": {\n \".+\": {\n \"type\": \"string\"\n }\n },\n \"additionalProperties\": false\n },\n \"status\": { \n \"type\": \"integer\"\n }\n },\n \"additionalProperties\": false\n}\n```", "anchor" : "status-codes", "title" : "Status codes" } ] }, "openapi" : "3.0.1", "servers" : [ { "url" : "//your-domain.atlassian.net/rest/" } ], "externalDocs" : { "url" : "http://www.atlassian.com", "description" : "Find out more about Atlassian products and services." }, "components" : { "schemas" : { "ProjectIdentifierBean" : { "properties" : { "id" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The ID of the project." }, "key" : { "readOnly" : true, "description" : "The key of the project.", "type" : "string" } }, "description" : "The identifiers for a project.", "additionalProperties" : false, "type" : "object" }, "JiraExpressionsComplexityValueBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "value" : { "description" : "The complexity value of the current expression.", "format" : "int32", "type" : "integer" }, "limit" : { "type" : "integer", "format" : "int32", "description" : "The maximum allowed complexity. The evaluation will fail if this value is exceeded." } }, "required" : [ "limit", "value" ] }, "FieldWasClause" : { "type" : "object", "description" : "A clause that asserts a previous value of a field. For example, `status WAS \"Resolved\" BY currentUser() BEFORE \"2019/02/02\"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for more information about the WAS operator.", "required" : [ "field", "operand", "operator", "predicates" ], "properties" : { "operator" : { "enum" : [ "was", "was in", "was not in", "was not" ], "description" : "The operator between the field and operand.", "type" : "string" }, "field" : { "$ref" : "#/components/schemas/JqlQueryField" }, "predicates" : { "items" : { "$ref" : "#/components/schemas/JqlQueryClauseTimePredicate" }, "description" : "The list of time predicates.", "type" : "array" }, "operand" : { "$ref" : "#/components/schemas/JqlQueryClauseOperand" } } }, "ProjectCategory" : { "additionalProperties" : false, "description" : "A project category.", "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "The description of the project category. Required on create, optional on update." }, "name" : { "description" : "The name of the project category. Required on create, optional on update.", "type" : "string" }, "id" : { "description" : "The ID of the project category.", "readOnly" : true, "type" : "string" }, "self" : { "type" : "string", "description" : "The URL of the project category.", "format" : "uri", "readOnly" : true } } }, "PageBeanWebhook" : { "type" : "object", "description" : "A page of items.", "additionalProperties" : false, "properties" : { "startAt" : { "format" : "int64", "readOnly" : true, "description" : "The index of the first item returned.", "type" : "integer" }, "nextPage" : { "readOnly" : true, "format" : "uri", "description" : "If there is another page of results, the URL of the next page.", "type" : "string" }, "maxResults" : { "description" : "The maximum number of items that could be returned.", "format" : "int32", "readOnly" : true, "type" : "integer" }, "values" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Webhook" }, "description" : "The list of items.", "type" : "array" }, "isLast" : { "description" : "Indicates whether this is the last page.", "readOnly" : true, "type" : "boolean" }, "total" : { "type" : "integer", "description" : "The number of items returned.", "format" : "int64", "readOnly" : true }, "self" : { "format" : "uri", "readOnly" : true, "description" : "The URL of the page.", "type" : "string" } } }, "Icon" : { "properties" : { "url16x16" : { "description" : "The URL of an icon that displays at 16x16 pixel in Jira.", "type" : "string" }, "link" : { "description" : "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.", "type" : "string" }, "title" : { "description" : "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\".", "type" : "string" } }, "type" : "object", "additionalProperties" : true, "description" : "An icon. If no icon is defined:\n\n * for a status icon, no status icon displays in Jira.\n * for the remote object icon, the default link icon displays in Jira." }, "StatusCategory" : { "properties" : { "key" : { "type" : "string", "readOnly" : true, "description" : "The key of the status category." }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the status category." }, "self" : { "readOnly" : true, "description" : "The URL of the status category.", "type" : "string" }, "id" : { "description" : "The ID of the status category.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "colorName" : { "description" : "The name of the color used to represent the status category.", "readOnly" : true, "type" : "string" } }, "type" : "object", "additionalProperties" : true, "description" : "A status category." }, "WorkflowStatus" : { "required" : [ "id", "name" ], "properties" : { "name" : { "type" : "string", "description" : "The name of the status in the workflow." }, "properties" : { "$ref" : "#/components/schemas/WorkflowStatusProperties" }, "id" : { "type" : "string", "description" : "The ID of the issue status." } }, "type" : "object", "additionalProperties" : false, "description" : "Details of a workflow status." }, "PublishedWorkflowId" : { "type" : "object", "additionalProperties" : false, "description" : "Properties that identify a published workflow.", "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "description" : "The name of the workflow." } } }, "ProjectIssueSecurityLevels" : { "required" : [ "levels" ], "properties" : { "levels" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/SecurityLevel" }, "description" : "Issue level security items list.", "type" : "array" } }, "type" : "object", "description" : "List of issue level security items in a project.", "additionalProperties" : false }, "Component" : { "properties" : { "leadUserName" : { "type" : "string", "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, "isAssigneeTypeValid" : { "type" : "boolean", "description" : "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.", "readOnly" : true }, "assignee" : { "allOf" : [ { "$ref" : "#/components/schemas/User" } ], "description" : "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", "readOnly" : true }, "realAssigneeType" : { "readOnly" : true, "description" : "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", "type" : "string", "enum" : [ "PROJECT_DEFAULT", "COMPONENT_LEAD", "PROJECT_LEAD", "UNASSIGNED" ] }, "self" : { "type" : "string", "description" : "The URL of the component.", "format" : "uri", "readOnly" : true }, "project" : { "description" : "The key of the project the component is assigned to. Required when creating a component. Can't be updated.", "type" : "string" }, "realAssignee" : { "allOf" : [ { "$ref" : "#/components/schemas/User" } ], "readOnly" : true, "description" : "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee." }, "projectId" : { "format" : "int64", "readOnly" : true, "description" : "The ID of the project the component is assigned to.", "type" : "integer" }, "description" : { "type" : "string", "description" : "The description for the component. Optional when creating or updating a component." }, "name" : { "type" : "string", "description" : "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters." }, "assigneeType" : { "enum" : [ "PROJECT_DEFAULT", "COMPONENT_LEAD", "PROJECT_LEAD", "UNASSIGNED" ], "description" : "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component.", "type" : "string" }, "leadAccountId" : { "description" : "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Optional when creating or updating a component.", "type" : "string" }, "lead" : { "readOnly" : true, "description" : "The user details for the component's lead user.", "allOf" : [ { "$ref" : "#/components/schemas/User" } ] }, "id" : { "type" : "string", "description" : "The unique identifier for the component.", "readOnly" : true } }, "type" : "object", "xml" : { "name" : "component" }, "description" : "Details about a project component.", "additionalProperties" : false }, "ConnectWorkflowTransitionRule" : { "required" : [ "id", "key" ], "properties" : { "id" : { "description" : "The ID of the transition rule.", "type" : "string" }, "transition" : { "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/WorkflowTransition" } ] }, "key" : { "readOnly" : true, "description" : "The key of the rule, as defined in the Connect app descriptor.", "type" : "string" }, "configuration" : { "$ref" : "#/components/schemas/RuleConfiguration" } }, "type" : "object", "description" : "A workflow transition rule.", "additionalProperties" : false }, "JiraExpressionEvaluationMetaDataBean" : { "type" : "object", "additionalProperties" : false, "properties" : { "issues" : { "allOf" : [ { "$ref" : "#/components/schemas/IssuesMetaBean" } ], "description" : "Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here." }, "complexity" : { "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionsComplexityBean" } ], "description" : "Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression." } } }, "WebhookRegistrationDetails" : { "type" : "object", "additionalProperties" : false, "description" : "Details of webhooks to register.", "required" : [ "url", "webhooks" ], "properties" : { "url" : { "type" : "string", "description" : "The URL that specifies where to send the webhooks." }, "webhooks" : { "items" : { "$ref" : "#/components/schemas/WebhookDetails" }, "description" : "A list of webhooks.", "type" : "array" } } }, "ValueOperand" : { "description" : "An operand that is a user-provided value.", "type" : "object", "properties" : { "value" : { "description" : "The operand value.", "type" : "string" } }, "required" : [ "value" ] }, "DefaultWorkflow" : { "properties" : { "workflow" : { "description" : "The name of the workflow to set as the default workflow.", "type" : "string" }, "updateDraftIfNeeded" : { "type" : "boolean", "description" : "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`." } }, "required" : [ "workflow" ], "additionalProperties" : false, "description" : "Details about the default workflow.", "type" : "object" }, "IssueBean" : { "properties" : { "editmeta" : { "readOnly" : true, "description" : "The metadata for the fields on the issue that can be amended.", "allOf" : [ { "$ref" : "#/components/schemas/IssueUpdateMetadata" } ] }, "self" : { "readOnly" : true, "format" : "uri", "description" : "The URL of the issue details.", "type" : "string" }, "changelog" : { "description" : "Details of changelogs associated with the issue.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/PageOfChangelogs" } ] }, "fields" : { "type" : "object", "additionalProperties" : {} }, "properties" : { "type" : "object", "additionalProperties" : { "readOnly" : true }, "description" : "Details of the issue properties identified in the request.", "readOnly" : true }, "schema" : { "readOnly" : true, "description" : "The schema describing each field present on the issue.", "additionalProperties" : { "$ref" : "#/components/schemas/JsonTypeBean" }, "type" : "object" }, "id" : { "type" : "string", "readOnly" : true, "description" : "The ID of the issue." }, "fieldsToInclude" : { "$ref" : "#/components/schemas/IncludedFields" }, "names" : { "additionalProperties" : { "type" : "string", "readOnly" : true }, "description" : "The ID and name of each field present on the issue.", "readOnly" : true, "type" : "object" }, "operations" : { "readOnly" : true, "description" : "The operations that can be performed on the issue.", "allOf" : [ { "$ref" : "#/components/schemas/Operations" } ] }, "renderedFields" : { "type" : "object", "readOnly" : true, "description" : "The rendered value of each field present on the issue.", "additionalProperties" : { "readOnly" : true } }, "key" : { "readOnly" : true, "description" : "The key of the issue.", "type" : "string" }, "transitions" : { "readOnly" : true, "description" : "The transitions that can be performed on the issue.", "items" : { "$ref" : "#/components/schemas/IssueTransition" }, "type" : "array" }, "versionedRepresentations" : { "additionalProperties" : { "additionalProperties" : { "readOnly" : true }, "readOnly" : true, "type" : "object" }, "description" : "The versions of each field on the issue.", "readOnly" : true, "type" : "object" }, "expand" : { "type" : "string", "xml" : { "attribute" : true }, "readOnly" : true, "description" : "Expand options that include additional issue details in the response." } }, "xml" : { "name" : "issue" }, "type" : "object", "additionalProperties" : false }, "JsonTypeBean" : { "properties" : { "type" : { "type" : "string", "readOnly" : true, "description" : "The data type of the field." }, "configuration" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "readOnly" : true }, "description" : "If the field is a custom field, the configuration of the field." }, "system" : { "type" : "string", "description" : "If the field is a system field, the name of the field.", "readOnly" : true }, "items" : { "description" : "When the data type is an array, the name of the field items within the array.", "readOnly" : true, "type" : "string" }, "customId" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "If the field is a custom field, the custom ID of the field." }, "custom" : { "description" : "If the field is a custom field, the URI of the field.", "readOnly" : true, "type" : "string" } }, "required" : [ "type" ], "additionalProperties" : false, "description" : "The schema of a field.", "type" : "object" }, "JqlQueryUnitaryOperand" : { "description" : "An operand that can be part of a list operand.", "type" : "object", "anyOf" : [ { "$ref" : "#/components/schemas/ValueOperand" }, { "$ref" : "#/components/schemas/FunctionOperand" }, { "$ref" : "#/components/schemas/KeywordOperand" } ] }, "PageBeanIssueFieldOption" : { "properties" : { "isLast" : { "readOnly" : true, "description" : "Indicates whether this is the last page.", "type" : "boolean" }, "self" : { "readOnly" : true, "format" : "uri", "description" : "The URL of the page.", "type" : "string" }, "total" : { "description" : "The number of items returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IssueFieldOption" }, "description" : "The list of items.", "readOnly" : true }, "maxResults" : { "format" : "int32", "readOnly" : true, "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "nextPage" : { "description" : "If there is another page of results, the URL of the next page.", "readOnly" : true, "format" : "uri", "type" : "string" }, "startAt" : { "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true, "type" : "integer" } }, "type" : "object", "additionalProperties" : false, "description" : "A page of items." }, "PageBeanWorkflowTransitionRules" : { "properties" : { "self" : { "description" : "The URL of the page.", "format" : "uri", "readOnly" : true, "type" : "string" }, "isLast" : { "description" : "Indicates whether this is the last page.", "readOnly" : true, "type" : "boolean" }, "total" : { "type" : "integer", "description" : "The number of items returned.", "readOnly" : true, "format" : "int64" }, "values" : { "items" : { "$ref" : "#/components/schemas/WorkflowTransitionRules" }, "description" : "The list of items.", "readOnly" : true, "type" : "array" }, "maxResults" : { "type" : "integer", "description" : "The maximum number of items that could be returned.", "readOnly" : true, "format" : "int32" }, "nextPage" : { "description" : "If there is another page of results, the URL of the next page.", "format" : "uri", "readOnly" : true, "type" : "string" }, "startAt" : { "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true, "type" : "integer" } }, "description" : "A page of items.", "additionalProperties" : false, "type" : "object" }, "HierarchyLevelOutput" : { "properties" : { "issueTypes" : { "items" : { "$ref" : "#/components/schemas/MinimalIssueTypeOutput" }, "type" : "array" }, "level" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "entityId" : { "format" : "uuid", "type" : "string" } }, "additionalProperties" : false, "type" : "object" }, "UserWriteBean" : { "properties" : { "self" : { "description" : "The URL of the user.", "readOnly" : true, "type" : "string" }, "key" : { "type" : "string", "description" : "The key for the user. When provided with `name`, overrides the value in `name` to set both `name` and `key`. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, "applicationKeys" : { "items" : { "type" : "string" }, "description" : "Deprecated, do not use.", "type" : "array" }, "displayName" : { "type" : "string", "description" : "The display name for the user. Required." }, "name" : { "type" : "string", "description" : "The username for the user. This property is deprecated because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, "emailAddress" : { "description" : "The email address for the user. Required.", "type" : "string" }, "password" : { "description" : "A password for the user. If a password is not set, a random password is generated.", "type" : "string" }, "notification" : { "description" : "Sends the user an email confirmation that they have been added to Jira. Default is `false`.", "type" : "string" } }, "required" : [ "displayName", "emailAddress" ], "additionalProperties" : true, "type" : "object" }, "ChangedValueBean" : { "type" : "object", "description" : "Details of names changed in the record event.", "additionalProperties" : false, "properties" : { "changedFrom" : { "readOnly" : true, "description" : "The value of the field before the change.", "type" : "string" }, "fieldName" : { "readOnly" : true, "description" : "The name of the field changed.", "type" : "string" }, "changedTo" : { "readOnly" : true, "description" : "The value of the field after the change.", "type" : "string" } } }, "IssuesAndJQLQueries" : { "required" : [ "issueIds", "jqls" ], "properties" : { "jqls" : { "items" : { "type" : "string", "description" : "A list of JQL queries." }, "description" : "A list of JQL queries.", "type" : "array" }, "issueIds" : { "description" : "A list of issue IDs.", "items" : { "type" : "integer", "description" : "A list of issue IDs.", "format" : "int64" }, "uniqueItems" : true, "type" : "array" } }, "type" : "object", "additionalProperties" : false, "description" : "List of issues and JQL queries." }, "IncludedFields" : { "properties" : { "included" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "excluded" : { "uniqueItems" : true, "items" : { "type" : "string" }, "type" : "array" }, "actuallyIncluded" : { "uniqueItems" : true, "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object", "additionalProperties" : false }, "WorkflowTransitionRulesUpdateErrorDetails" : { "required" : [ "ruleUpdateErrors" ], "properties" : { "updateErrors" : { "items" : { "description" : "An error specifying why the workflow update failed.", "type" : "string" }, "description" : "The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.", "uniqueItems" : true, "type" : "array" }, "ruleUpdateErrors" : { "additionalProperties" : { "type" : "array", "items" : { "description" : "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.", "type" : "string" }, "description" : "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.", "uniqueItems" : true }, "description" : "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.", "type" : "object" }, "workflowId" : { "$ref" : "#/components/schemas/WorkflowId" } }, "type" : "object", "description" : "Details of any errors encountered while updating workflow transition rules for a workflow.", "additionalProperties" : false }, "PageBeanUser" : { "type" : "object", "additionalProperties" : false, "description" : "A page of items.", "properties" : { "nextPage" : { "type" : "string", "description" : "If there is another page of results, the URL of the next page.", "readOnly" : true, "format" : "uri" }, "maxResults" : { "readOnly" : true, "format" : "int32", "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "startAt" : { "readOnly" : true, "format" : "int64", "description" : "The index of the first item returned.", "type" : "integer" }, "isLast" : { "type" : "boolean", "description" : "Indicates whether this is the last page.", "readOnly" : true }, "total" : { "description" : "The number of items returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "self" : { "type" : "string", "description" : "The URL of the page.", "readOnly" : true, "format" : "uri" }, "values" : { "type" : "array", "readOnly" : true, "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/User" } } } }, "IssuesJqlMetaDataBean" : { "description" : "The description of the page of issues loaded by the provided JQL query.", "additionalProperties" : false, "type" : "object", "properties" : { "startAt" : { "type" : "integer", "description" : "The index of the first issue.", "format" : "int64" }, "maxResults" : { "type" : "integer", "description" : "The maximum number of issues that could be loaded in this evaluation.", "format" : "int32" }, "validationWarnings" : { "type" : "array", "description" : "Any warnings related to the JQL query. Present only if the validation mode was set to `warn`.", "items" : { "type" : "string" } }, "totalCount" : { "type" : "integer", "format" : "int64", "description" : "The total number of issues the JQL returned." }, "count" : { "type" : "integer", "description" : "The number of issues that were loaded in this evaluation.", "format" : "int32" } }, "required" : [ "count", "maxResults", "startAt", "totalCount" ] }, "FieldChangedClause" : { "required" : [ "field", "operator", "predicates" ], "properties" : { "predicates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JqlQueryClauseTimePredicate" }, "description" : "The list of time predicates." }, "operator" : { "type" : "string", "description" : "The operator applied to the field.", "enum" : [ "changed" ] }, "field" : { "$ref" : "#/components/schemas/JqlQueryField" } }, "type" : "object", "description" : "A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more information about the CHANGED operator." }, "SimpleListWrapperApplicationRole" : { "type" : "object", "xml" : { "name" : "list" }, "additionalProperties" : false, "properties" : { "pagingCallback" : { "$ref" : "#/components/schemas/ListWrapperCallbackApplicationRole" }, "size" : { "type" : "integer", "xml" : { "attribute" : true }, "format" : "int32" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationRole" } }, "callback" : { "$ref" : "#/components/schemas/ListWrapperCallbackApplicationRole" }, "max-results" : { "type" : "integer", "xml" : { "name" : "max-results", "attribute" : true }, "format" : "int32" } } }, "ListOperand" : { "properties" : { "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JqlQueryUnitaryOperand" }, "description" : "The list of operand values.", "minLength" : 1 } }, "description" : "An operand that is a list of values.", "type" : "object" }, "PageOfComments" : { "properties" : { "total" : { "readOnly" : true, "format" : "int64", "description" : "The number of items returned.", "type" : "integer" }, "startAt" : { "type" : "integer", "description" : "The index of the first item returned.", "readOnly" : true, "format" : "int64" }, "comments" : { "type" : "array", "description" : "The list of comments.", "items" : { "$ref" : "#/components/schemas/Comment" }, "readOnly" : true }, "maxResults" : { "type" : "integer", "description" : "The maximum number of items that could be returned.", "readOnly" : true, "format" : "int32" } }, "type" : "object", "additionalProperties" : true, "description" : "A page of comments." }, "Attachment" : { "type" : "object", "description" : "Details about an attachment.", "additionalProperties" : true, "properties" : { "mimeType" : { "type" : "string", "description" : "The MIME type of the attachment.", "readOnly" : true }, "id" : { "readOnly" : true, "description" : "The ID of the attachment.", "type" : "string" }, "size" : { "type" : "integer", "description" : "The size of the attachment.", "format" : "int64", "readOnly" : true }, "self" : { "readOnly" : true, "description" : "The URL of the attachment details response.", "type" : "string" }, "thumbnail" : { "type" : "string", "readOnly" : true, "description" : "The URL of a thumbnail representing the attachment." }, "filename" : { "readOnly" : true, "description" : "The file name of the attachment.", "type" : "string" }, "author" : { "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ], "readOnly" : true, "description" : "Details of the user who added the attachment." }, "created" : { "description" : "The datetime the attachment was created.", "format" : "date-time", "readOnly" : true, "type" : "string" }, "content" : { "readOnly" : true, "description" : "The content of the attachment.", "type" : "string" } } }, "PageBeanFoundFilter" : { "properties" : { "startAt" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The index of the first item returned." }, "nextPage" : { "readOnly" : true, "format" : "uri", "description" : "If there is another page of results, the URL of the next page.", "type" : "string" }, "maxResults" : { "description" : "The maximum number of items that could be returned.", "readOnly" : true, "format" : "int32", "type" : "integer" }, "values" : { "readOnly" : true, "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/FoundFilter" }, "type" : "array" }, "isLast" : { "type" : "boolean", "description" : "Indicates whether this is the last page.", "readOnly" : true }, "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of the page." }, "total" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The number of items returned." } }, "description" : "A page of items.", "additionalProperties" : false, "type" : "object" }, "CustomFieldOption" : { "additionalProperties" : false, "description" : "Details of a custom option for a field.", "xml" : { "name" : "customFieldOption" }, "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of these custom field option details." }, "value" : { "type" : "string", "readOnly" : true, "description" : "The value of the custom field option." } } }, "AvatarUrlsBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "32x32" : { "description" : "The URL of the item's 32x32 pixel avatar.", "format" : "uri", "type" : "string" }, "24x24" : { "format" : "uri", "description" : "The URL of the item's 24x24 pixel avatar.", "type" : "string" }, "16x16" : { "type" : "string", "format" : "uri", "description" : "The URL of the item's 16x16 pixel avatar." }, "48x48" : { "type" : "string", "format" : "uri", "description" : "The URL of the item's 48x48 pixel avatar." } } }, "FilterSubscription" : { "type" : "object", "additionalProperties" : false, "description" : "Details of a user or group subscribing to a filter.", "properties" : { "user" : { "allOf" : [ { "$ref" : "#/components/schemas/User" } ], "description" : "The user subscribing to filter.", "readOnly" : true }, "id" : { "type" : "integer", "description" : "The ID of the filter subscription.", "format" : "int64", "readOnly" : true }, "group" : { "description" : "The group subscribing to filter.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/GroupName" } ] } } }, "PageOfDashboards" : { "type" : "object", "description" : "A page containing dashboard details.", "additionalProperties" : false, "properties" : { "dashboards" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Dashboard" }, "description" : "List of dashboards." }, "startAt" : { "description" : "The index of the first item returned on the page.", "format" : "int32", "readOnly" : true, "type" : "integer" }, "next" : { "readOnly" : true, "description" : "The URL of the next page of results, if any.", "type" : "string" }, "maxResults" : { "description" : "The maximum number of results that could be on the page.", "format" : "int32", "readOnly" : true, "type" : "integer" }, "prev" : { "readOnly" : true, "description" : "The URL of the previous page of results, if any.", "type" : "string" }, "total" : { "type" : "integer", "description" : "The number of results on the page.", "format" : "int32", "readOnly" : true } } }, "FoundUsers" : { "properties" : { "users" : { "items" : { "$ref" : "#/components/schemas/UserPickerUser" }, "type" : "array" }, "header" : { "type" : "string", "description" : "Header text indicating the number of users in the response and the total number of users found in the search." }, "total" : { "format" : "int32", "description" : "The total number of users found in the search.", "type" : "integer" } }, "type" : "object", "description" : "The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users.", "additionalProperties" : false }, "PageBeanProject" : { "properties" : { "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Project" }, "description" : "The list of items.", "readOnly" : true }, "self" : { "type" : "string", "description" : "The URL of the page.", "format" : "uri", "readOnly" : true }, "isLast" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether this is the last page." }, "total" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The number of items returned." }, "startAt" : { "type" : "integer", "description" : "The index of the first item returned.", "readOnly" : true, "format" : "int64" }, "maxResults" : { "readOnly" : true, "format" : "int32", "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "nextPage" : { "type" : "string", "description" : "If there is another page of results, the URL of the next page.", "format" : "uri", "readOnly" : true } }, "type" : "object", "description" : "A page of items.", "additionalProperties" : false }, "NotificationScheme" : { "additionalProperties" : false, "description" : "Details about a notification scheme.", "type" : "object", "properties" : { "self" : { "type" : "string" }, "id" : { "description" : "The ID of the notification scheme.", "format" : "int64", "type" : "integer" }, "scope" : { "description" : "The scope of the notification scheme.", "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ] }, "name" : { "description" : "The name of the notification scheme.", "type" : "string" }, "notificationSchemeEvents" : { "items" : { "$ref" : "#/components/schemas/NotificationSchemeEvent" }, "description" : "The notification events and associated recipients.", "type" : "array" }, "description" : { "type" : "string", "description" : "The description of the notification scheme." }, "expand" : { "type" : "string", "description" : "Expand options that include additional notification scheme details in the response." } } }, "PageBeanComponentWithIssueCount" : { "type" : "object", "description" : "A page of items.", "additionalProperties" : false, "properties" : { "isLast" : { "description" : "Indicates whether this is the last page.", "readOnly" : true, "type" : "boolean" }, "self" : { "description" : "The URL of the page.", "readOnly" : true, "format" : "uri", "type" : "string" }, "total" : { "readOnly" : true, "format" : "int64", "description" : "The number of items returned.", "type" : "integer" }, "values" : { "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/ComponentWithIssueCount" }, "readOnly" : true, "type" : "array" }, "nextPage" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "If there is another page of results, the URL of the next page." }, "maxResults" : { "type" : "integer", "description" : "The maximum number of items that could be returned.", "readOnly" : true, "format" : "int32" }, "startAt" : { "description" : "The index of the first item returned.", "readOnly" : true, "format" : "int64", "type" : "integer" } } }, "WebhooksExpirationDate" : { "additionalProperties" : false, "description" : "The date the newly refreshed webhooks expire.", "type" : "object", "properties" : { "expirationDate" : { "type" : "integer", "format" : "int64", "readOnly" : true } }, "required" : [ "expirationDate" ] }, "ProjectPermissions" : { "type" : "object", "description" : "Permissions which a user has on a project.", "additionalProperties" : false, "properties" : { "canEdit" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the logged user can edit the project." } } }, "Status" : { "description" : "The status of the item.", "additionalProperties" : true, "type" : "object", "properties" : { "icon" : { "description" : "Details of the icon representing the status. If not provided, no status icon displays in Jira.", "allOf" : [ { "$ref" : "#/components/schemas/Icon" } ] }, "resolved" : { "description" : "Indicates whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.", "type" : "boolean" } } }, "avatarUrls" : { "$ref" : "#/components/schemas/AvatarUrlsBean", "description" : "The avatars of the user." }, "TaskProgressBeanRemoveOptionFromIssuesResult" : { "required" : [ "elapsedRuntime", "id", "lastUpdate", "progress", "self", "status", "submitted", "submittedBy" ], "properties" : { "progress" : { "description" : "The progress of the task, as a percentage complete.", "format" : "int64", "type" : "integer" }, "description" : { "description" : "The description of the task.", "type" : "string" }, "lastUpdate" : { "format" : "int64", "description" : "A timestamp recording when the task progress was last updated.", "type" : "integer" }, "id" : { "type" : "string", "description" : "The ID of the task." }, "finished" : { "type" : "integer", "format" : "int64", "description" : "A timestamp recording when the task was finished." }, "submitted" : { "format" : "int64", "description" : "A timestamp recording when the task was submitted.", "type" : "integer" }, "result" : { "description" : "The result of the task execution.", "allOf" : [ { "$ref" : "#/components/schemas/RemoveOptionFromIssuesResult" } ] }, "message" : { "description" : "Information about the progress of the task.", "type" : "string" }, "submittedBy" : { "type" : "integer", "description" : "The ID of the user who submitted the task.", "format" : "int64" }, "self" : { "description" : "The URL of the task.", "format" : "uri", "type" : "string" }, "elapsedRuntime" : { "description" : "The execution time of the task, in milliseconds.", "format" : "int64", "type" : "integer" }, "status" : { "description" : "The status of the task.", "type" : "string", "enum" : [ "ENQUEUED", "RUNNING", "COMPLETE", "FAILED", "CANCEL_REQUESTED", "CANCELLED", "DEAD" ] }, "started" : { "format" : "int64", "description" : "A timestamp recording when the task was started.", "type" : "integer" } }, "type" : "object", "description" : "Details about a task.", "additionalProperties" : false }, "PermissionScheme" : { "type" : "object", "additionalProperties" : true, "description" : "Details of a permission scheme.", "required" : [ "name" ], "properties" : { "expand" : { "readOnly" : true, "description" : "The expand options available for the permission scheme.", "type" : "string" }, "description" : { "description" : "A description for the permission scheme.", "type" : "string" }, "name" : { "description" : "The name of the permission scheme. Must be unique. Required when creating or updating a permission scheme.", "type" : "string" }, "scope" : { "description" : "The scope of the permission scheme.", "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ] }, "permissions" : { "description" : "The permission scheme to create or update. See [About permission schemes and grants](#about-permission-schemes-and-grants) for more information.", "items" : { "$ref" : "#/components/schemas/PermissionGrant" }, "type" : "array" }, "id" : { "description" : "The ID of the permission scheme.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "self" : { "description" : "The URL of the permission scheme.", "format" : "uri", "readOnly" : true, "type" : "string" } } }, "ApplicationRole" : { "properties" : { "platform" : { "type" : "boolean", "description" : "Indicates if the application role belongs to Jira platform (`jira-core`)." }, "selectedByDefault" : { "description" : "Determines whether this application role should be selected by default on user creation.", "type" : "boolean" }, "defaultGroups" : { "uniqueItems" : true, "items" : { "type" : "string" }, "description" : "The groups that are granted default access for this application role.", "type" : "array" }, "numberOfSeats" : { "type" : "integer", "description" : "The maximum count of users on your license.", "format" : "int32" }, "userCount" : { "type" : "integer", "format" : "int32", "description" : "The number of users counting against your license." }, "groups" : { "type" : "array", "description" : "The groups associated with the application role.", "items" : { "type" : "string" }, "uniqueItems" : true }, "hasUnlimitedSeats" : { "type" : "boolean" }, "userCountDescription" : { "type" : "string", "description" : "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." }, "name" : { "type" : "string", "description" : "The display name of the application role." }, "key" : { "description" : "The key of the application role.", "type" : "string" }, "defined" : { "description" : "Deprecated.", "type" : "boolean" }, "remainingSeats" : { "type" : "integer", "format" : "int32", "description" : "The count of users remaining on your license." } }, "description" : "Details of an application role.", "additionalProperties" : false, "type" : "object" }, "ProjectAvatars" : { "type" : "object", "description" : "List of project avatars.", "additionalProperties" : false, "properties" : { "custom" : { "type" : "array", "description" : "List of avatars added to Jira. These avatars may be deleted.", "items" : { "$ref" : "#/components/schemas/Avatar" }, "readOnly" : true }, "system" : { "type" : "array", "description" : "List of avatars included with Jira. These avatars cannot be deleted.", "items" : { "$ref" : "#/components/schemas/Avatar" }, "readOnly" : true } } }, "WorkflowId" : { "required" : [ "draft", "name" ], "properties" : { "draft" : { "description" : "Whether the workflow is in the draft state.", "type" : "boolean" }, "name" : { "type" : "string", "description" : "The name of the workflow." } }, "type" : "object", "description" : "Properties that identify a workflow.", "additionalProperties" : false }, "WorkflowTransitionProperty" : { "properties" : { "key" : { "readOnly" : true, "description" : "The key of the transition property. Also known as the name of the transition property.", "type" : "string" }, "id" : { "description" : "The ID of the transition property.", "readOnly" : true, "type" : "string" }, "value" : { "type" : "string", "description" : "The value of the transition property." } }, "required" : [ "value" ], "description" : "Details about the server Jira is running on.", "additionalProperties" : true, "type" : "object" }, "JqlQueryClause" : { "description" : "A JQL query clause.", "additionalProperties" : false, "anyOf" : [ { "$ref" : "#/components/schemas/CompoundClause" }, { "$ref" : "#/components/schemas/FieldValueClause" }, { "$ref" : "#/components/schemas/FieldWasClause" }, { "$ref" : "#/components/schemas/FieldChangedClause" } ], "type" : "object" }, "Watchers" : { "properties" : { "watchers" : { "type" : "array", "description" : "Details of the users watching this issue.", "items" : { "$ref" : "#/components/schemas/UserDetails" }, "readOnly" : true }, "isWatching" : { "readOnly" : true, "description" : "Indicates whether the calling user is watching this issue.", "type" : "boolean" }, "watchCount" : { "description" : "The number of users watching this issue.", "readOnly" : true, "format" : "int32", "type" : "integer" }, "self" : { "type" : "string", "description" : "The URL of these issue watcher details.", "readOnly" : true } }, "type" : "object", "xml" : { "name" : "watchers" }, "description" : "The details of watchers on an issue.", "additionalProperties" : false }, "JqlQueryOrderByClauseElement" : { "required" : [ "direction" ], "properties" : { "direction" : { "enum" : [ "asc", "desc" ], "description" : "The direction in which to order the results.", "type" : "string" }, "field" : { "$ref" : "#/components/schemas/JqlQueryField" } }, "type" : "object", "additionalProperties" : false, "description" : "An element of the order-by JQL clause." }, "JqlQueryFieldEntityProperty" : { "description" : "Details of an entity property.", "type" : "object", "properties" : { "key" : { "description" : "The key of the property.", "type" : "string", "example" : "stats" }, "entity" : { "description" : "The object on which the property is set.", "type" : "string", "example" : "issue" }, "type" : { "description" : "The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/) module.", "type" : "string", "enum" : [ "number", "string", "text", "date", "user" ], "example" : "number" }, "path" : { "description" : "The path in the property value to query.", "type" : "string", "example" : "comments.count" } }, "required" : [ "entity", "key", "path" ] }, "IssueFieldOptionScopeBean" : { "properties" : { "projects" : { "type" : "array", "description" : "DEPRECATED", "items" : { "type" : "integer", "format" : "int64" }, "uniqueItems" : true }, "global" : { "description" : "Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects.", "allOf" : [ { "$ref" : "#/components/schemas/GlobalScopeBean" } ] }, "projects2" : { "uniqueItems" : true, "items" : { "$ref" : "#/components/schemas/ProjectScopeBean" }, "description" : "Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.", "type" : "array" } }, "additionalProperties" : false, "type" : "object" }, "SecuritySchemes" : { "additionalProperties" : false, "description" : "List of security schemes.", "type" : "object", "properties" : { "issueSecuritySchemes" : { "type" : "array", "readOnly" : true, "description" : "List of security schemes.", "items" : { "$ref" : "#/components/schemas/SecurityScheme" } } } }, "PageBeanUserDetails" : { "properties" : { "values" : { "type" : "array", "readOnly" : true, "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/UserDetails" } }, "total" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The number of items returned." }, "isLast" : { "readOnly" : true, "description" : "Indicates whether this is the last page.", "type" : "boolean" }, "self" : { "type" : "string", "description" : "The URL of the page.", "readOnly" : true, "format" : "uri" }, "startAt" : { "type" : "integer", "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true }, "maxResults" : { "readOnly" : true, "format" : "int32", "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "nextPage" : { "type" : "string", "description" : "If there is another page of results, the URL of the next page.", "readOnly" : true, "format" : "uri" } }, "description" : "A page of items.", "additionalProperties" : false, "type" : "object" }, "IssueTypeUpdateBean" : { "type" : "object", "additionalProperties" : false, "properties" : { "name" : { "description" : "The unique name for the issue type. The maximum length is 60 characters.", "type" : "string" }, "description" : { "description" : "The description of the issue type.", "type" : "string" }, "avatarId" : { "type" : "integer", "format" : "int64", "description" : "The ID of an issue type avatar." } } }, "ErrorMessage" : { "properties" : { "message" : { "description" : "The error message.", "type" : "string" } }, "example" : { "message" : "The request is not from a Connect app." }, "required" : [ "message" ], "additionalProperties" : false, "type" : "object" }, "SimpleApplicationPropertyBean" : { "properties" : { "id" : { "description" : "The ID of the application property.", "type" : "string" }, "value" : { "description" : "The new value.", "type" : "string" } }, "additionalProperties" : false, "xml" : { "name" : "applicationProperty" }, "type" : "object" }, "WorkflowTransitionRulesUpdateErrors" : { "type" : "object", "description" : "Details of any errors encountered while updating workflow transition rules.", "additionalProperties" : false, "required" : [ "updateResults" ], "properties" : { "updateResults" : { "description" : "A list of workflows.", "items" : { "$ref" : "#/components/schemas/WorkflowTransitionRulesUpdateErrorDetails" }, "type" : "array" } } }, "PropertyKey" : { "properties" : { "key" : { "readOnly" : true, "description" : "The key of the property.", "type" : "string" }, "self" : { "type" : "string", "description" : "The URL of the property.", "readOnly" : true } }, "description" : "Property key details.", "additionalProperties" : false, "type" : "object" }, "IssueLink" : { "properties" : { "outwardIssue" : { "description" : "The issue the link originates from.", "allOf" : [ { "$ref" : "#/components/schemas/LinkedIssue" } ] }, "id" : { "type" : "string", "description" : "The ID of the issue link.", "readOnly" : true }, "self" : { "format" : "uri", "readOnly" : true, "description" : "The URL of the issue link.", "type" : "string" }, "inwardIssue" : { "allOf" : [ { "$ref" : "#/components/schemas/LinkedIssue" } ], "description" : "The issue the link joins to." }, "type" : { "description" : "The type of link between the issues.", "allOf" : [ { "$ref" : "#/components/schemas/IssueLinkType" } ] } }, "type" : "object", "xml" : { "name" : "issueLinks" }, "description" : "Details of a link between issues.", "additionalProperties" : false }, "Configuration" : { "additionalProperties" : false, "description" : "Details about the configuration of Jira.", "type" : "object", "properties" : { "votingEnabled" : { "type" : "boolean", "description" : "Whether the ability for users to vote on issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.", "readOnly" : true }, "attachmentsEnabled" : { "readOnly" : true, "description" : "Whether the ability to add attachments to issues is enabled.", "type" : "boolean" }, "subTasksEnabled" : { "type" : "boolean", "readOnly" : true, "description" : "Whether the ability to create subtasks for issues is enabled." }, "timeTrackingConfiguration" : { "allOf" : [ { "$ref" : "#/components/schemas/TimeTrackingConfiguration" } ], "description" : "The configuration of time tracking.", "readOnly" : true }, "watchingEnabled" : { "type" : "boolean", "description" : "Whether the ability for users to watch issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.", "readOnly" : true }, "issueLinkingEnabled" : { "type" : "boolean", "description" : "Whether the ability to link issues is enabled.", "readOnly" : true }, "unassignedIssuesAllowed" : { "type" : "boolean", "readOnly" : true, "description" : "Whether the ability to create unassigned issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details." }, "timeTrackingEnabled" : { "readOnly" : true, "description" : "Whether the ability to track time is enabled. This property is deprecated.", "type" : "boolean" } } }, "GlobalScopeBean" : { "properties" : { "attributes" : { "type" : "array", "uniqueItems" : true, "items" : { "enum" : [ "notSelectable", "defaultValue" ], "type" : "string" }, "description" : "Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default." } }, "additionalProperties" : false, "type" : "object" }, "IssueCommentListRequestBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "ids" : { "items" : { "type" : "integer", "format" : "int64" }, "description" : "The list of comment IDs. A maximum of 1000 IDs can be specified. Required.", "uniqueItems" : true, "type" : "array" } } }, "UserPermission" : { "description" : "Details of a permission and its availability to a user.", "additionalProperties" : true, "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions." }, "havePermission" : { "type" : "boolean", "description" : "Indicates whether the permission is available to the user in the queried context." }, "key" : { "type" : "string", "description" : "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions." }, "description" : { "description" : "The description of the permission.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the permission." }, "deprecatedKey" : { "type" : "boolean", "description" : "Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.`" }, "type" : { "enum" : [ "GLOBAL", "PROJECT" ], "type" : "string", "description" : "The type of the permission." } } }, "Field" : { "type" : "object", "additionalProperties" : false, "description" : "Details of a field.", "required" : [ "id", "name" ], "properties" : { "lastUsed" : { "type" : "string", "description" : "The date when the value of the field last changed.", "format" : "date-time" }, "screens" : { "items" : { "$ref" : "#/components/schemas/ScreenID" }, "description" : "List of screens where the field is used.", "type" : "array" }, "name" : { "type" : "string", "description" : "The name of the field." }, "key" : { "description" : "The key of the field.", "type" : "string" }, "description" : { "description" : "The description of the field.", "type" : "string" }, "id" : { "description" : "The id of the field.", "type" : "string" }, "schema" : { "$ref" : "#/components/schemas/JsonTypeBean" }, "contexts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ContextID" }, "description" : "List of contexts where the field is used." } } }, "Filter" : { "additionalProperties" : false, "description" : "Details about a filter.", "type" : "object", "xml" : { "name" : "filter" }, "properties" : { "description" : { "type" : "string", "description" : "A description of the filter." }, "name" : { "type" : "string", "description" : "The name of the filter. Must be unique." }, "sharePermissions" : { "items" : { "$ref" : "#/components/schemas/SharePermission" }, "description" : "The groups and projects that the filter is shared with.", "type" : "array" }, "favouritedCount" : { "description" : "The count of how many users have selected this filter as a favorite, including the filter owner.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "jql" : { "type" : "string", "description" : "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*." }, "id" : { "type" : "string", "description" : "The unique identifier for the filter.", "readOnly" : true }, "owner" : { "allOf" : [ { "$ref" : "#/components/schemas/User" } ], "readOnly" : true, "description" : "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings." }, "searchUrl" : { "description" : "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.", "readOnly" : true, "format" : "uri", "type" : "string" }, "viewUrl" : { "description" : "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.", "format" : "uri", "readOnly" : true, "type" : "string" }, "favourite" : { "type" : "boolean", "description" : "Indicates whether the filter is selected as a favorite." }, "subscriptions" : { "allOf" : [ { "$ref" : "#/components/schemas/FilterSubscriptionsList" } ], "readOnly" : true, "description" : "A paginated list of the users that are subscribed to the filter." }, "sharedUsers" : { "description" : "A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/UserList" } ] }, "self" : { "type" : "string", "description" : "The URL of the filter.", "format" : "uri", "readOnly" : true } }, "required" : [ "name" ] }, "ConvertedJQLQueries" : { "properties" : { "queriesWithUnknownUsers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JQLQueryWithUnknownUsers" }, "description" : "List of queries containing user information that could not be mapped to an existing user" }, "queryStrings" : { "description" : "The list of converted query strings with account IDs in place of user identifiers.", "items" : { "type" : "string" }, "type" : "array" } }, "description" : "The converted JQL queries.", "additionalProperties" : false, "type" : "object" }, "ParsedJqlQueries" : { "additionalProperties" : false, "description" : "A list of parsed JQL queries.", "type" : "object", "properties" : { "queries" : { "minLength" : 1, "items" : { "$ref" : "#/components/schemas/ParsedJqlQuery" }, "description" : "A list of parsed JQL queries.", "type" : "array" } }, "required" : [ "queries" ] }, "IssueMatchesForJQL" : { "type" : "object", "additionalProperties" : false, "description" : "A list of the issues matched to a JQL query or details of errors encountered during matching.", "required" : [ "errors", "matchedIssues" ], "properties" : { "matchedIssues" : { "description" : "A list of issue IDs.", "items" : { "description" : "A list of issue IDs.", "format" : "int64", "type" : "integer" }, "uniqueItems" : true, "type" : "array" }, "errors" : { "items" : { "description" : "A list of errors.", "type" : "string" }, "uniqueItems" : true, "description" : "A list of errors.", "type" : "array" } } }, "CustomFieldDefinitionJsonBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "searcherKey" : { "enum" : [ "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:daterange", "com.atlassian.jira.plugin.system.customfieldtypes:datetimerange", "com.atlassian.jira.plugin.system.customfieldtypes:exactnumber", "com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher", "com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:numberrange", "com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:textsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher", "com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher" ], "description" : "The searcher defines the way the field is searched in Jira. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*. \nThe search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):\n\n * `cascadingselect`: `cascadingselectsearcher`\n * `datepicker`: `daterange`\n * `datetime`: `datetimerange`\n * `float`: `exactnumber` or `numberrange`\n * `grouppicker`: `grouppickersearcher`\n * `importid`: `exactnumber` or `numberrange`\n * `labels`: `labelsearcher`\n * `multicheckboxes`: `multiselectsearcher`\n * `multigrouppicker`: `multiselectsearcher`\n * `multiselect`: `multiselectsearcher`\n * `multiuserpicker`: `userpickergroupsearcher`\n * `multiversion`: `versionsearcher`\n * `project`: `projectsearcher`\n * `radiobuttons`: `multiselectsearcher`\n * `readonlyfield`: `textsearcher`\n * `select`: `multiselectsearcher`\n * `textarea`: `textsearcher`\n * `textfield`: `textsearcher`\n * `url`: `exacttextsearcher`\n * `userpicker`: `userpickergroupsearcher`\n * `version`: `versionsearcher`", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the custom field, which is displayed in Jira. This is not the unique identifier." }, "description" : { "description" : "The description of the custom field, which is displayed in Jira.", "type" : "string" }, "type" : { "description" : "The type of the custom field. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppicker*.\n\n * `cascadingselect`: Allows multiple values to be selected using two select lists\n * `datepicker`: Stores a date using a picker control\n * `datetime`: Stores a date with a time component\n * `float`: Stores and validates a numeric (floating point) input\n * `grouppicker`: Stores a user group using a picker control\n * `importid`: A read-only field that stores the previous ID of the issue from the system that it was imported from\n * `labels`: Stores labels\n * `multicheckboxes`: Stores multiple values using checkboxes\n * `multigrouppicker`: Stores multiple user groups using a picker control\n * `multiselect`: Stores multiple values using a select list\n * `multiuserpicker`: Stores multiple users using a picker control\n * `multiversion`: Stores multiple versions from the versions available in a project using a picker control\n * `project`: Stores a project from a list of projects that the user is permitted to view\n * `radiobuttons`: Stores a value using radio buttons\n * `readonlyfield`: Stores a read-only text value, which can only be populated via the API\n * `select`: Stores a value from a configurable list of options\n * `textarea`: Stores a long text string using a multiline text area\n * `textfield`: Stores a text string using a single-line text box\n * `url`: Stores a URL\n * `userpicker`: Stores a user using a picker control\n * `version`: Stores a version using a picker control", "type" : "string", "enum" : [ "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect", "com.atlassian.jira.plugin.system.customfieldtypes:datepicker", "com.atlassian.jira.plugin.system.customfieldtypes:datetime", "com.atlassian.jira.plugin.system.customfieldtypes:float", "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker", "com.atlassian.jira.plugin.system.customfieldtypes:importid", "com.atlassian.jira.plugin.system.customfieldtypes:labels", "com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes", "com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker", "com.atlassian.jira.plugin.system.customfieldtypes:multiselect", "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker", "com.atlassian.jira.plugin.system.customfieldtypes:multiversion", "com.atlassian.jira.plugin.system.customfieldtypes:project", "com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons", "com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield", "com.atlassian.jira.plugin.system.customfieldtypes:select", "com.atlassian.jira.plugin.system.customfieldtypes:textarea", "com.atlassian.jira.plugin.system.customfieldtypes:textfield", "com.atlassian.jira.plugin.system.customfieldtypes:url", "com.atlassian.jira.plugin.system.customfieldtypes:userpicker", "com.atlassian.jira.plugin.system.customfieldtypes:version" ] } }, "required" : [ "name", "searcherKey", "type" ] }, "HistoryMetadata" : { "properties" : { "extraData" : { "description" : "Additional arbitrary information about the history record.", "additionalProperties" : { "type" : "string" }, "type" : "object" }, "actor" : { "description" : "Details of the user whose action created the history record.", "allOf" : [ { "$ref" : "#/components/schemas/HistoryMetadataParticipant" } ] }, "generator" : { "allOf" : [ { "$ref" : "#/components/schemas/HistoryMetadataParticipant" } ], "description" : "Details of the system that generated the history record." }, "activityDescriptionKey" : { "description" : "The key of the activity described in the history record.", "type" : "string" }, "type" : { "type" : "string", "description" : "The type of the history record." }, "cause" : { "description" : "Details of the cause that triggered the creation the history record.", "allOf" : [ { "$ref" : "#/components/schemas/HistoryMetadataParticipant" } ] }, "description" : { "type" : "string", "description" : "The description of the history record." }, "descriptionKey" : { "description" : "The description key of the history record.", "type" : "string" }, "activityDescription" : { "type" : "string", "description" : "The activity described in the history record." }, "emailDescriptionKey" : { "description" : "The description key of the email address associated the history record.", "type" : "string" }, "emailDescription" : { "type" : "string", "description" : "The description of the email address associated the history record." } }, "type" : "object", "additionalProperties" : true, "description" : "Details of issue history metadata." }, "IssueFieldOptionConfiguration" : { "type" : "object", "description" : "Details of the projects the option is available in.", "additionalProperties" : false, "properties" : { "scope" : { "allOf" : [ { "$ref" : "#/components/schemas/IssueFieldOptionScopeBean" } ], "description" : "Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects." }, "attributes" : { "description" : "DEPRECATED", "items" : { "enum" : [ "notSelectable", "defaultValue" ], "type" : "string" }, "uniqueItems" : true, "type" : "array" } } }, "ChangedWorklogs" : { "properties" : { "lastPage" : { "type" : "boolean" }, "nextPage" : { "format" : "uri", "readOnly" : true, "description" : "The URL of the next list of changed worklogs.", "type" : "string" }, "since" : { "description" : "The datetime of the first worklog item in the list.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "values" : { "description" : "Changed worklog list.", "items" : { "$ref" : "#/components/schemas/ChangedWorklog" }, "readOnly" : true, "type" : "array" }, "until" : { "format" : "int64", "readOnly" : true, "description" : "The datetime of the last worklog item in the list.", "type" : "integer" }, "self" : { "description" : "The URL of this changed worklogs list.", "readOnly" : true, "format" : "uri", "type" : "string" } }, "additionalProperties" : false, "description" : "List of changed worklogs.", "type" : "object" }, "Visibility" : { "properties" : { "type" : { "description" : "Indicates whether visibility of this item is restricted to a group or role.", "type" : "string", "enum" : [ "group", "role" ] }, "value" : { "type" : "string", "description" : "The name of the group or role to which visibility of this item is restricted." } }, "additionalProperties" : true, "description" : "The group or role to which this item is visible.", "type" : "object" }, "VersionIssueCounts" : { "properties" : { "issuesAffectedCount" : { "description" : "Count of issues where the `affectedVersion` is set to the version.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "customFieldUsage" : { "description" : "List of custom fields using the version.", "items" : { "$ref" : "#/components/schemas/VersionUsageInCustomField" }, "readOnly" : true, "type" : "array" }, "self" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "The URL of these count details." }, "issuesFixedCount" : { "type" : "integer", "description" : "Count of issues where the `fixVersion` is set to the version.", "format" : "int64", "readOnly" : true }, "issueCountWithCustomFieldsShowingVersion" : { "description" : "Count of issues where a version custom field is set to the version.", "readOnly" : true, "format" : "int64", "type" : "integer" } }, "type" : "object", "xml" : { "name" : "version" }, "additionalProperties" : false, "description" : "Various counts of issues within a version." }, "Resolution" : { "properties" : { "description" : { "description" : "The description of the issue resolution.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the issue resolution." }, "self" : { "type" : "string", "format" : "uri", "description" : "The URL of the issue resolution." }, "id" : { "description" : "The ID of the issue resolution.", "type" : "string" } }, "xml" : { "name" : "resolution" }, "type" : "object", "description" : "Details of an issue resolution.", "additionalProperties" : false }, "SecurityLevel" : { "additionalProperties" : false, "description" : "Details of an issue level security item.", "type" : "object", "properties" : { "description" : { "type" : "string", "readOnly" : true, "description" : "The description of the issue level security item." }, "name" : { "readOnly" : true, "description" : "The name of the issue level security item.", "type" : "string" }, "self" : { "type" : "string", "readOnly" : true, "description" : "The URL of the issue level security item." }, "id" : { "description" : "The ID of the issue level security item.", "readOnly" : true, "type" : "string" } } }, "ConnectModule" : { "example" : { "type" : "single_select", "name" : { "value" : "Team" }, "key" : "team-field", "description" : { "value" : "field with team" }, "extractions" : [ { "type" : "text", "path" : "category", "name" : "categoryName" } ] }, "type" : "object", "description" : "A [Connect module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/)." }, "Hierarchy" : { "properties" : { "level" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HierarchyLevel" } } }, "additionalProperties" : false, "description" : "Project Issue Type Hierarchy", "xml" : { "name" : "hierarchy" }, "type" : "object" }, "PageBeanDashboard" : { "description" : "A page of items.", "additionalProperties" : false, "type" : "object", "properties" : { "startAt" : { "format" : "int64", "readOnly" : true, "description" : "The index of the first item returned.", "type" : "integer" }, "maxResults" : { "readOnly" : true, "format" : "int32", "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "nextPage" : { "format" : "uri", "readOnly" : true, "description" : "If there is another page of results, the URL of the next page.", "type" : "string" }, "values" : { "type" : "array", "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/Dashboard" }, "readOnly" : true }, "total" : { "description" : "The number of items returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "isLast" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether this is the last page." }, "self" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "The URL of the page." } } }, "FieldDeprecated" : { "description" : "Details about a field. This object has been deprecated. See [Get Fields Paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-field-search-get) to obtain details about fields.", "additionalProperties" : false, "xml" : { "name" : "field" }, "type" : "object", "properties" : { "clauseNames" : { "items" : { "type" : "string" }, "description" : "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).", "uniqueItems" : true, "type" : "array" }, "key" : { "type" : "string", "description" : "The key of the field." }, "name" : { "type" : "string", "description" : "The name of the field." }, "scope" : { "description" : "The scope of the field.", "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ] }, "schema" : { "allOf" : [ { "$ref" : "#/components/schemas/JsonTypeBean" } ], "description" : "The data schema for the field." }, "orderable" : { "type" : "boolean", "description" : "Indicates whether the content of the field can be used to order lists." }, "id" : { "description" : "The ID of the field.", "type" : "string" }, "searchable" : { "description" : "Indicates whether the content of the field can be searched.", "type" : "boolean" }, "navigable" : { "description" : "Indicates whether the field can be used as a column on the issue navigator.", "type" : "boolean" }, "custom" : { "type" : "boolean", "description" : "Indicates whether the field is a custom field." } } }, "RestrictedPermission" : { "properties" : { "id" : { "description" : "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions.", "type" : "string" }, "key" : { "type" : "string", "description" : "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions." } }, "description" : "Details of the permission.", "additionalProperties" : true, "type" : "object" }, "Priority" : { "properties" : { "description" : { "description" : "The description of the issue priority.", "type" : "string" }, "name" : { "description" : "The name of the issue priority.", "type" : "string" }, "iconUrl" : { "description" : "The URL of the icon for the issue priority.", "type" : "string" }, "self" : { "description" : "The URL of the issue priority.", "type" : "string" }, "id" : { "type" : "string", "description" : "The ID of the issue priority." }, "statusColor" : { "description" : "The color used to indicate the issue priority.", "type" : "string" } }, "description" : "An issue priority.", "additionalProperties" : true, "type" : "object" }, "ColumnItem" : { "properties" : { "value" : { "type" : "string", "description" : "The issue navigator column value." }, "label" : { "type" : "string", "description" : "The issue navigator column label." } }, "description" : "Details of an issue navigator column item.", "additionalProperties" : false, "type" : "object" }, "ComponentIssuesCount" : { "xml" : { "name" : "component" }, "type" : "object", "additionalProperties" : false, "description" : "Count of issues assigned to a component.", "properties" : { "self" : { "type" : "string", "description" : "The URL for this count of issues for a component.", "readOnly" : true, "format" : "uri" }, "issueCount" : { "type" : "integer", "description" : "The count of issues assigned to a component.", "readOnly" : true, "format" : "int64" } } }, "TaskProgressBeanObject" : { "description" : "Details about a task.", "additionalProperties" : false, "type" : "object", "properties" : { "progress" : { "description" : "The progress of the task, as a percentage complete.", "format" : "int64", "type" : "integer" }, "description" : { "description" : "The description of the task.", "type" : "string" }, "lastUpdate" : { "type" : "integer", "description" : "A timestamp recording when the task progress was last updated.", "format" : "int64" }, "id" : { "type" : "string", "description" : "The ID of the task." }, "submitted" : { "type" : "integer", "format" : "int64", "description" : "A timestamp recording when the task was submitted." }, "finished" : { "format" : "int64", "description" : "A timestamp recording when the task was finished.", "type" : "integer" }, "result" : { "description" : "The result of the task execution." }, "message" : { "description" : "Information about the progress of the task.", "type" : "string" }, "submittedBy" : { "type" : "integer", "format" : "int64", "description" : "The ID of the user who submitted the task." }, "elapsedRuntime" : { "type" : "integer", "format" : "int64", "description" : "The execution time of the task, in milliseconds." }, "self" : { "type" : "string", "format" : "uri", "description" : "The URL of the task." }, "status" : { "description" : "The status of the task.", "type" : "string", "enum" : [ "ENQUEUED", "RUNNING", "COMPLETE", "FAILED", "CANCEL_REQUESTED", "CANCELLED", "DEAD" ] }, "started" : { "type" : "integer", "format" : "int64", "description" : "A timestamp recording when the task was started." } }, "required" : [ "elapsedRuntime", "id", "lastUpdate", "progress", "self", "status", "submitted", "submittedBy" ] }, "IssueTypeWorkflowMapping" : { "properties" : { "workflow" : { "type" : "string", "description" : "The name of the workflow." }, "updateDraftIfNeeded" : { "type" : "boolean", "description" : "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping." }, "issueType" : { "type" : "string", "description" : "The ID of the issue type. Not required if updating the issue type-workflow mapping." } }, "additionalProperties" : false, "description" : "Details about the mapping between an issue type and a workflow.", "type" : "object" }, "AssociatedItemBean" : { "type" : "object", "additionalProperties" : false, "description" : "Details of an item associated with the changed record.", "properties" : { "parentName" : { "type" : "string", "readOnly" : true, "description" : "The name of the associated parent record." }, "name" : { "description" : "The name of the associated record.", "readOnly" : true, "type" : "string" }, "parentId" : { "type" : "string", "description" : "The ID of the associated parent record.", "readOnly" : true }, "typeName" : { "type" : "string", "readOnly" : true, "description" : "The type of the associated record." }, "id" : { "type" : "string", "readOnly" : true, "description" : "The ID of the associated record." } } }, "JqlQueriesToParse" : { "description" : "A list of JQL queries to parse.", "additionalProperties" : false, "type" : "object", "writeOnly" : true, "properties" : { "queries" : { "items" : { "minLength" : 1, "type" : "string" }, "description" : "A list of queries to parse.", "type" : "array", "minLength" : 1 } }, "required" : [ "queries" ] }, "Locale" : { "properties" : { "locale" : { "type" : "string", "description" : "The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en\\_US represents a locale of English (United States). Required on create." } }, "type" : "object", "additionalProperties" : false, "description" : "Details of a locale." }, "MoveFieldBean" : { "type" : "object", "additionalProperties" : false, "properties" : { "position" : { "enum" : [ "Earlier", "Later", "First", "Last" ], "description" : "The named position to which the screen tab field should be moved. Required if `after` isn't provided.", "type" : "string" }, "after" : { "description" : "The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't provided.", "format" : "uri", "type" : "string" } } }, "IssueTypeWithStatus" : { "type" : "object", "description" : "Status details for an issue type.", "additionalProperties" : false, "required" : [ "id", "name", "self", "statuses", "subtask" ], "properties" : { "statuses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatusDetails" }, "description" : "List of status details for the issue type.", "readOnly" : true }, "id" : { "type" : "string", "readOnly" : true, "description" : "The ID of the issue type." }, "self" : { "type" : "string", "description" : "The URL of the issue type's status details.", "readOnly" : true }, "subtask" : { "description" : "Indicates whether this issue type represents subtasks.", "readOnly" : true, "type" : "boolean" }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the issue type." } } }, "JQLQueryWithUnknownUsers" : { "properties" : { "convertedQuery" : { "description" : "The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found", "type" : "string" }, "originalQuery" : { "type" : "string", "description" : "The original query, for reference" } }, "description" : "JQL queries that contained users that could not be found", "additionalProperties" : false, "type" : "object" }, "AttachmentMetadata" : { "type" : "object", "xml" : { "name" : "attachment" }, "additionalProperties" : false, "description" : "Metadata for an issue attachment.", "properties" : { "size" : { "description" : "The size of the attachment.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "properties" : { "description" : "Additional properties of the attachment.", "additionalProperties" : { "readOnly" : true }, "readOnly" : true, "type" : "object" }, "id" : { "description" : "The ID of the attachment.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "mimeType" : { "type" : "string", "readOnly" : true, "description" : "The MIME type of the attachment." }, "content" : { "type" : "string", "description" : "The URL of the attachment.", "readOnly" : true }, "filename" : { "description" : "The name of the attachment file.", "readOnly" : true, "type" : "string" }, "author" : { "description" : "Details of the user who attached the file.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/User" } ] }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true, "description" : "The datetime the attachment was created." }, "thumbnail" : { "description" : "The URL of a thumbnail representing the attachment.", "readOnly" : true, "type" : "string" }, "self" : { "description" : "The URL of the attachment metadata details.", "format" : "uri", "readOnly" : true, "type" : "string" } } }, "ErrorCollection" : { "properties" : { "errorMessages" : { "items" : { "type" : "string" }, "description" : "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"", "type" : "array" }, "errors" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"" }, "status" : { "format" : "int32", "type" : "integer" } }, "type" : "object", "description" : "Error messages from an operation.", "additionalProperties" : false }, "Permissions" : { "type" : "object", "description" : "Details about permissions.", "additionalProperties" : false, "properties" : { "permissions" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "$ref" : "#/components/schemas/UserPermission" }, "description" : "List of permissions." } } }, "RoleActor" : { "additionalProperties" : false, "description" : "Details about a user assigned to a project role.", "type" : "object", "xml" : { "name" : "projectRoleActor" }, "properties" : { "user" : { "type" : "string" }, "actorUser" : { "$ref" : "#/components/schemas/ProjectRoleUserBean" }, "id" : { "type" : "integer", "format" : "int64" }, "actorGroup" : { "$ref" : "#/components/schemas/ProjectRoleGroupBean" }, "type" : { "type" : "string" }, "avatarUrl" : { "format" : "uri", "type" : "string" }, "displayName" : { "type" : "string", "readOnly" : true, "description" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value." }, "name" : { "type" : "string", "readOnly" : true, "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." } } }, "TimeTrackingProvider" : { "required" : [ "key" ], "properties" : { "key" : { "description" : "The key for the time tracking provider. For example, *JIRA*.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the time tracking provider. For example, *JIRA provided time tracking*." }, "url" : { "type" : "string", "description" : "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app.", "readOnly" : true } }, "type" : "object", "additionalProperties" : false, "description" : "Details about the time tracking provider." }, "FoundGroups" : { "properties" : { "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FoundGroup" } }, "total" : { "format" : "int32", "description" : "The total number of groups found in the search.", "type" : "integer" }, "header" : { "description" : "Header text indicating the number of groups in the response and the total number of groups found in the search.", "type" : "string" } }, "description" : "The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups.", "additionalProperties" : false, "xml" : { "name" : "groupsuggestions" }, "type" : "object" }, "Transitions" : { "properties" : { "expand" : { "xml" : { "attribute" : true }, "type" : "string", "description" : "Expand options that include additional transitions details in the response.", "readOnly" : true }, "transitions" : { "items" : { "$ref" : "#/components/schemas/IssueTransition" }, "description" : "List of issue transitions.", "readOnly" : true, "type" : "array" } }, "additionalProperties" : false, "description" : "List of issue transitions.", "type" : "object" }, "NotificationRecipients" : { "properties" : { "assignee" : { "description" : "Indicates whether the notification should be sent to the issue's assignees.", "type" : "boolean" }, "groups" : { "description" : "List of groups to receive the notification.", "items" : { "$ref" : "#/components/schemas/GroupName" }, "type" : "array" }, "watchers" : { "type" : "boolean", "description" : "Indicates whether the notification should be sent to the issue's watchers." }, "voters" : { "description" : "Indicates whether the notification should be sent to the issue's voters.", "type" : "boolean" }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserDetails" }, "description" : "List of users to receive the notification." }, "reporter" : { "description" : "Indicates whether the notification should be sent to the issue's reporter.", "type" : "boolean" } }, "type" : "object", "additionalProperties" : true, "description" : "Details of the users and groups to receive the notification." }, "IssuesUpdateBean" : { "type" : "object", "additionalProperties" : true, "properties" : { "issueUpdates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IssueUpdateDetails" } } } }, "IssueFilterForBulkPropertySet" : { "type" : "object", "description" : "Bulk operation filter details.", "additionalProperties" : false, "properties" : { "hasProperty" : { "description" : "Indicates whether the bulk operation occurs only when the property is present on or absent from an issue.", "type" : "boolean" }, "currentValue" : { "description" : "The value of properties to perform the bulk operation on." }, "entityIds" : { "type" : "array", "description" : "List of issues to perform the bulk operation on.", "items" : { "type" : "integer", "format" : "int64" }, "uniqueItems" : true } } }, "PermissionGrants" : { "properties" : { "expand" : { "type" : "string", "readOnly" : true, "description" : "Expand options that include additional permission grant details in the response." }, "permissions" : { "items" : { "$ref" : "#/components/schemas/PermissionGrant" }, "description" : "Permission grants list.", "readOnly" : true, "type" : "array" } }, "type" : "object", "additionalProperties" : false, "description" : "List of permission grants." }, "ProjectRoleUserBean" : { "properties" : { "accountId" : { "type" : "string", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "readOnly" : true } }, "type" : "object", "additionalProperties" : false }, "Scope" : { "description" : "The scope of an entity. Indicated for entities associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", "additionalProperties" : true, "type" : "object", "properties" : { "project" : { "allOf" : [ { "$ref" : "#/components/schemas/ProjectForScope" } ], "readOnly" : true, "description" : "The project the entity has scope in." }, "type" : { "description" : "The type of scope.", "readOnly" : true, "type" : "string", "enum" : [ "PROJECT", "TEMPLATE" ] } } }, "SuggestedIssue" : { "additionalProperties" : false, "description" : "An issue suggested for use in the issue picker auto-completion.", "type" : "object", "properties" : { "id" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The id of the issue." }, "img" : { "description" : "The URL of the issue type's avatar.", "readOnly" : true, "type" : "string" }, "summary" : { "type" : "string", "readOnly" : true, "description" : "The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags." }, "summaryText" : { "type" : "string", "readOnly" : true, "description" : "The phrase containing the query string, as plain text." }, "key" : { "type" : "string", "description" : "The key of the issue.", "readOnly" : true }, "keyHtml" : { "readOnly" : true, "description" : "The key of the issue in HTML format.", "type" : "string" } } }, "GroupLabel" : { "properties" : { "type" : { "enum" : [ "ADMIN", "SINGLE", "MULTIPLE" ], "description" : "The type of the group label.", "type" : "string" }, "title" : { "type" : "string", "description" : "The title of the group label." }, "text" : { "description" : "The group label name.", "type" : "string" } }, "type" : "object", "xml" : { "name" : "grouplabel" }, "additionalProperties" : false, "description" : "A group label." }, "UpdateUserToGroupBean" : { "additionalProperties" : true, "type" : "object", "properties" : { "name" : { "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "type" : "string" }, "accountId" : { "type" : "string", "description" : "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." } } }, "ScreenID" : { "properties" : { "id" : { "type" : "string", "description" : "The ID of the screen." } }, "required" : [ "id" ], "description" : "ID of a screen.", "additionalProperties" : false, "type" : "object" }, "IssueFieldOption" : { "required" : [ "id", "value" ], "properties" : { "id" : { "type" : "integer", "description" : "The unique identifier for the option. This is only unique within the select field's set of options.", "format" : "int64" }, "config" : { "$ref" : "#/components/schemas/IssueFieldOptionConfiguration" }, "properties" : { "description" : "The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module.", "additionalProperties" : {}, "type" : "object" }, "value" : { "description" : "The option's name, which is displayed in Jira.", "type" : "string" } }, "type" : "object", "additionalProperties" : false, "description" : "Details of the options for a select list issue field." }, "JiraExpressionResult" : { "type" : "object", "additionalProperties" : false, "description" : "The result of evaluating a Jira expression.", "required" : [ "value" ], "properties" : { "value" : { "description" : "The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)" }, "meta" : { "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionEvaluationMetaDataBean" } ], "description" : "Contains various characteristics of the performed expression evaluation." } } }, "IssueTypeCreateBean" : { "properties" : { "name" : { "description" : "The unique name for the issue type. The maximum length is 60 characters. Required.", "type" : "string" }, "description" : { "type" : "string", "description" : "The description of the issue type." }, "type" : { "enum" : [ "subtask", "standard" ], "description" : "Whether the issue type is `subtype` or `standard`. Defaults to `standard`.", "type" : "string" } }, "required" : [ "name" ], "additionalProperties" : false, "type" : "object" }, "NotificationSchemeEvent" : { "description" : "Details about a notification scheme event.", "additionalProperties" : false, "type" : "object", "properties" : { "notifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventNotification" } }, "event" : { "$ref" : "#/components/schemas/NotificationEvent" } } }, "PageBeanVersion" : { "type" : "object", "additionalProperties" : false, "description" : "A page of items.", "properties" : { "total" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The number of items returned." }, "isLast" : { "description" : "Indicates whether this is the last page.", "readOnly" : true, "type" : "boolean" }, "self" : { "readOnly" : true, "format" : "uri", "description" : "The URL of the page.", "type" : "string" }, "values" : { "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/Version" }, "readOnly" : true, "type" : "array" }, "maxResults" : { "type" : "integer", "format" : "int32", "readOnly" : true, "description" : "The maximum number of items that could be returned." }, "nextPage" : { "description" : "If there is another page of results, the URL of the next page.", "format" : "uri", "readOnly" : true, "type" : "string" }, "startAt" : { "readOnly" : true, "format" : "int64", "description" : "The index of the first item returned.", "type" : "integer" } } }, "LinkGroup" : { "properties" : { "groups" : { "items" : { "$ref" : "#/components/schemas/LinkGroup" }, "type" : "array" }, "weight" : { "format" : "int32", "type" : "integer" }, "links" : { "items" : { "$ref" : "#/components/schemas/SimpleLink" }, "type" : "array" }, "header" : { "$ref" : "#/components/schemas/SimpleLink" }, "id" : { "type" : "string" }, "styleClass" : { "type" : "string" } }, "additionalProperties" : false, "description" : "Details a link group, which defines issue operations.", "type" : "object" }, "JexpIssues" : { "properties" : { "jql" : { "description" : "The JQL query that specifies the set of issues available in the Jira expression.", "allOf" : [ { "$ref" : "#/components/schemas/JexpJqlIssues" } ] } }, "type" : "object", "additionalProperties" : false, "description" : "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable." }, "PermissionHolder" : { "properties" : { "type" : { "type" : "string", "description" : "The type of permission holder." }, "expand" : { "type" : "string", "readOnly" : true, "description" : "Expand options that include additional permission holder details in the response." }, "parameter" : { "description" : "The identifier of permission holder.", "type" : "string" } }, "required" : [ "type" ], "description" : "Details of a user, group, field, or project role that holds a permission. See [Holder object](#holder-object) in *Get all permission schemes* for more information.", "additionalProperties" : false, "type" : "object" }, "ContextID" : { "type" : "object", "additionalProperties" : false, "description" : "ID of a context.", "required" : [ "id" ], "properties" : { "id" : { "type" : "string", "description" : "The ID of the context." } } }, "IconBean" : { "properties" : { "link" : { "description" : "The URL of the tooltip, used only for a status icon.", "type" : "string" }, "url16x16" : { "description" : "The URL of a 16x16 pixel icon.", "type" : "string" }, "title" : { "type" : "string", "description" : "The title of the icon, for use as a tooltip on the icon." } }, "type" : "object", "xml" : { "name" : "icon" }, "additionalProperties" : false, "description" : "An icon." }, "FilterSubscriptionsList" : { "additionalProperties" : false, "description" : "A paginated list of subscriptions to a filter.", "type" : "object", "properties" : { "size" : { "type" : "integer", "xml" : { "attribute" : true }, "format" : "int32", "readOnly" : true, "description" : "The number of items on the page." }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterSubscription" }, "description" : "The list of items.", "readOnly" : true }, "end-index" : { "description" : "The index of the last item returned on the page.", "format" : "int32", "readOnly" : true, "xml" : { "name" : "end-index", "attribute" : true }, "type" : "integer" }, "max-results" : { "xml" : { "attribute" : true, "name" : "max-results" }, "type" : "integer", "description" : "The maximum number of results that could be on the page.", "readOnly" : true, "format" : "int32" }, "start-index" : { "format" : "int32", "readOnly" : true, "description" : "The index of the first item returned on the page.", "type" : "integer", "xml" : { "name" : "start-index", "attribute" : true } } } }, "Version" : { "description" : "Details about a project version.", "additionalProperties" : false, "type" : "object", "xml" : { "name" : "version" }, "properties" : { "userStartDate" : { "readOnly" : true, "description" : "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.", "type" : "string" }, "self" : { "description" : "The URL of the version.", "readOnly" : true, "format" : "uri", "type" : "string" }, "operations" : { "description" : "If the expand option `operations` is used, returns the list of operations available for this version.", "items" : { "$ref" : "#/components/schemas/SimpleLink" }, "readOnly" : true, "type" : "array" }, "startDate" : { "format" : "date", "description" : "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.", "type" : "string" }, "name" : { "type" : "string", "description" : "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters." }, "expand" : { "xml" : { "attribute" : true }, "type" : "string", "description" : "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update." }, "projectId" : { "type" : "integer", "description" : "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.", "format" : "int64" }, "userReleaseDate" : { "type" : "string", "description" : "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format.", "readOnly" : true }, "project" : { "type" : "string", "description" : "Deprecated. Use `projectId`." }, "issuesStatusForFixVersion" : { "description" : "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/VersionIssuesStatus" } ] }, "moveUnfixedIssuesTo" : { "format" : "uri", "description" : "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.", "type" : "string" }, "id" : { "type" : "string", "description" : "The ID of the version.", "readOnly" : true }, "released" : { "type" : "boolean", "description" : "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version." }, "overdue" : { "type" : "boolean", "description" : "Indicates that the version is overdue.", "readOnly" : true }, "releaseDate" : { "type" : "string", "format" : "date", "description" : "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version." }, "description" : { "description" : "The description of the version. Optional when creating or updating a version.", "type" : "string" }, "archived" : { "description" : "Indicates that the version is archived. Optional when creating or updating a version.", "type" : "boolean" } } }, "NestedResponse" : { "properties" : { "status" : { "type" : "integer", "format" : "int32" }, "errorCollection" : { "$ref" : "#/components/schemas/ErrorCollection" } }, "type" : "object", "additionalProperties" : false }, "PageBeanComment" : { "properties" : { "total" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The number of items returned." }, "isLast" : { "description" : "Indicates whether this is the last page.", "readOnly" : true, "type" : "boolean" }, "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of the page." }, "values" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Comment" }, "description" : "The list of items." }, "nextPage" : { "format" : "uri", "readOnly" : true, "description" : "If there is another page of results, the URL of the next page.", "type" : "string" }, "maxResults" : { "type" : "integer", "description" : "The maximum number of items that could be returned.", "readOnly" : true, "format" : "int32" }, "startAt" : { "type" : "integer", "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true } }, "type" : "object", "additionalProperties" : false, "description" : "A page of items." }, "IdOrKeyBean" : { "type" : "object", "additionalProperties" : false, "properties" : { "key" : { "description" : "The key of the referenced item.", "type" : "string" }, "id" : { "format" : "int64", "description" : "The ID of the referenced item.", "type" : "integer" } } }, "IssueUpdateMetadata" : { "type" : "object", "description" : "A list of editable field details.", "properties" : { "fields" : { "additionalProperties" : { "$ref" : "#/components/schemas/FieldMetadata" }, "description" : "A list of editable field details.", "readOnly" : true, "type" : "object" } } }, "ProjectRole" : { "properties" : { "actors" : { "type" : "array", "description" : "The list of users who act in this role.", "items" : { "$ref" : "#/components/schemas/RoleActor" }, "readOnly" : true }, "self" : { "readOnly" : true, "format" : "uri", "description" : "The URL the project role details.", "type" : "string" }, "default" : { "type" : "boolean" }, "description" : { "type" : "string", "readOnly" : true, "description" : "The description of the project role." }, "admin" : { "type" : "boolean" }, "name" : { "description" : "The name of the project role.", "type" : "string" }, "scope" : { "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ], "description" : "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).", "readOnly" : true }, "id" : { "description" : "The ID of the project role.", "format" : "int64", "readOnly" : true, "type" : "integer" } }, "additionalProperties" : false, "description" : "Details about the roles in a project.", "type" : "object" }, "PageBeanScreen" : { "properties" : { "maxResults" : { "format" : "int32", "readOnly" : true, "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "nextPage" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "If there is another page of results, the URL of the next page." }, "startAt" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The index of the first item returned." }, "isLast" : { "type" : "boolean", "description" : "Indicates whether this is the last page.", "readOnly" : true }, "self" : { "readOnly" : true, "format" : "uri", "description" : "The URL of the page.", "type" : "string" }, "total" : { "type" : "integer", "description" : "The number of items returned.", "format" : "int64", "readOnly" : true }, "values" : { "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/Screen" }, "readOnly" : true, "type" : "array" } }, "type" : "object", "additionalProperties" : false, "description" : "A page of items." }, "IssuePickerSuggestions" : { "additionalProperties" : false, "description" : "A list of issues suggested for use in auto-completion.", "type" : "object", "properties" : { "sections" : { "items" : { "$ref" : "#/components/schemas/IssuePickerSuggestionsIssueType" }, "description" : "A list of issues for an issue type suggested for use in auto-completion.", "readOnly" : true, "type" : "array" } } }, "NotificationRecipientsRestrictions" : { "properties" : { "permissions" : { "items" : { "$ref" : "#/components/schemas/RestrictedPermission" }, "description" : "List of permissions required to receive the notification.", "type" : "array" }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupName" }, "description" : "List of group memberships required to receive the notification." } }, "additionalProperties" : false, "description" : "Details of the group membership or permissions needed to receive the notification.", "type" : "object" }, "BulkPermissionGrants" : { "type" : "object", "description" : "Details of global and project permissions granted to the user.", "additionalProperties" : false, "required" : [ "globalPermissions", "projectPermissions" ], "properties" : { "projectPermissions" : { "items" : { "$ref" : "#/components/schemas/BulkProjectPermissionGrants" }, "uniqueItems" : true, "description" : "List of project permissions and the projects and issues those permissions provide access to.", "type" : "array" }, "globalPermissions" : { "items" : { "type" : "string" }, "uniqueItems" : true, "description" : "List of permissions granted to the user.", "type" : "array" } } }, "WorkflowTransitionRules" : { "properties" : { "postFunctions" : { "description" : "The list of post functions within the workflow.", "items" : { "$ref" : "#/components/schemas/ConnectWorkflowTransitionRule" }, "type" : "array" }, "workflowId" : { "$ref" : "#/components/schemas/WorkflowId" }, "conditions" : { "description" : "The list of conditions within the workflow.", "items" : { "$ref" : "#/components/schemas/ConnectWorkflowTransitionRule" }, "type" : "array" }, "validators" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConnectWorkflowTransitionRule" }, "description" : "The list of validators within the workflow." } }, "additionalProperties" : false, "description" : "A workflow with transition rules.", "type" : "object" }, "FoundFilter" : { "description" : "Details of a filter identified as part of a search.", "additionalProperties" : false, "type" : "object", "properties" : { "viewUrl" : { "description" : "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*.", "readOnly" : true, "format" : "uri", "type" : "string" }, "favourite" : { "readOnly" : true, "description" : "Indicates whether the filter is selected as a favorite by any users, not including the filter owner.", "type" : "boolean" }, "subscriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterSubscription" }, "description" : "The users that are subscribed to the filter.", "readOnly" : true }, "self" : { "type" : "string", "description" : "The URL of the filter.", "format" : "uri", "readOnly" : true }, "searchUrl" : { "format" : "uri", "readOnly" : true, "description" : "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*.", "type" : "string" }, "owner" : { "allOf" : [ { "$ref" : "#/components/schemas/User" } ], "description" : "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.", "readOnly" : true }, "favouritedCount" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The count of how many users have selected this filter as a favorite, including the filter owner." }, "jql" : { "description" : "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.", "readOnly" : true, "type" : "string" }, "id" : { "type" : "string", "readOnly" : true, "description" : "The unique identifier for the filter." }, "description" : { "description" : "A description of the filter.", "type" : "string" }, "sharePermissions" : { "type" : "array", "description" : "The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.", "items" : { "$ref" : "#/components/schemas/SharePermission" } }, "name" : { "type" : "string", "description" : "The name of the filter. Must be unique." } }, "required" : [ "name" ] }, "UserList" : { "description" : "A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.", "additionalProperties" : false, "type" : "object", "properties" : { "items" : { "items" : { "$ref" : "#/components/schemas/User" }, "description" : "The list of items.", "readOnly" : true, "type" : "array" }, "size" : { "type" : "integer", "xml" : { "attribute" : true }, "format" : "int32", "readOnly" : true, "description" : "The number of items on the page." }, "end-index" : { "description" : "The index of the last item returned on the page.", "readOnly" : true, "format" : "int32", "xml" : { "name" : "end-index", "attribute" : true }, "type" : "integer" }, "start-index" : { "type" : "integer", "xml" : { "name" : "start-index", "attribute" : true }, "format" : "int32", "readOnly" : true, "description" : "The index of the first item returned on the page." }, "max-results" : { "type" : "integer", "xml" : { "name" : "max-results", "attribute" : true }, "readOnly" : true, "format" : "int32", "description" : "The maximum number of results that could be on the page." } } }, "IssueUpdateDetails" : { "type" : "object", "additionalProperties" : true, "description" : "Details of an issue update request.", "properties" : { "properties" : { "type" : "array", "description" : "Details of issue properties to be add or update.", "items" : { "$ref" : "#/components/schemas/EntityProperty" } }, "historyMetadata" : { "allOf" : [ { "$ref" : "#/components/schemas/HistoryMetadata" } ], "description" : "Additional issue history details." }, "transition" : { "description" : "Details of a transition. Required when performing a transition, optional when creating or editing an issue.", "allOf" : [ { "$ref" : "#/components/schemas/IssueTransition" } ] }, "fields" : { "type" : "object", "description" : "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.", "additionalProperties" : {} }, "update" : { "additionalProperties" : { "items" : { "$ref" : "#/components/schemas/FieldUpdateOperation" }, "type" : "array" }, "description" : "List of operations to perform on issue screen fields. Note that fields included in here cannot be included in `fields`.", "type" : "object" } } }, "UserBeanAvatarUrls" : { "properties" : { "24x24" : { "type" : "string", "format" : "uri", "description" : "The URL of the user's 24x24 pixel avatar." }, "16x16" : { "type" : "string", "description" : "The URL of the user's 16x16 pixel avatar.", "format" : "uri" }, "32x32" : { "type" : "string", "description" : "The URL of the user's 32x32 pixel avatar.", "format" : "uri" }, "48x48" : { "description" : "The URL of the user's 48x48 pixel avatar.", "format" : "uri", "type" : "string" } }, "additionalProperties" : false, "type" : "object" }, "RemoveOptionFromIssuesResult" : { "additionalProperties" : false, "type" : "object", "properties" : { "errors" : { "description" : "A collection of errors related to unchanged issues. The collection size is limited, which means not all errors may be returned.", "allOf" : [ { "$ref" : "#/components/schemas/SimpleErrorCollection" } ] }, "modifiedIssues" : { "description" : "The IDs of the modified issues.", "items" : { "type" : "integer", "format" : "int64" }, "type" : "array" }, "unmodifiedIssues" : { "type" : "array", "description" : "The IDs of the unchanged issues, those issues where errors prevent modification.", "items" : { "format" : "int64", "type" : "integer" } } } }, "JqlQueryField" : { "additionalProperties" : false, "description" : "A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL queries.", "type" : "object", "properties" : { "property" : { "items" : { "$ref" : "#/components/schemas/JqlQueryFieldEntityProperty" }, "description" : "When the field refers to a value in an entity property, details of the entity property value.", "type" : "array" }, "name" : { "description" : "The name of the field.", "type" : "string" } }, "required" : [ "name" ] }, "UserMigrationBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "key" : { "type" : "string" }, "username" : { "type" : "string" }, "accountId" : { "type" : "string" } } }, "PageBeanString" : { "description" : "A page of items.", "additionalProperties" : false, "type" : "object", "properties" : { "nextPage" : { "description" : "If there is another page of results, the URL of the next page.", "readOnly" : true, "format" : "uri", "type" : "string" }, "maxResults" : { "description" : "The maximum number of items that could be returned.", "format" : "int32", "readOnly" : true, "type" : "integer" }, "startAt" : { "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "self" : { "type" : "string", "description" : "The URL of the page.", "readOnly" : true, "format" : "uri" }, "isLast" : { "type" : "boolean", "description" : "Indicates whether this is the last page.", "readOnly" : true }, "total" : { "type" : "integer", "description" : "The number of items returned.", "readOnly" : true, "format" : "int64" }, "values" : { "description" : "The list of items.", "items" : { "readOnly" : true, "type" : "string" }, "readOnly" : true, "type" : "array" } } }, "Group" : { "properties" : { "users" : { "description" : "A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 50 users, use`?expand=users[51:100]`.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/PagedListUserDetailsApplicationUser" } ] }, "self" : { "readOnly" : true, "format" : "uri", "description" : "The URL for these group details.", "type" : "string" }, "expand" : { "readOnly" : true, "description" : "Expand options that include additional group details in the response.", "type" : "string", "xml" : { "attribute" : true } }, "name" : { "description" : "The name of group.", "type" : "string" } }, "type" : "object", "additionalProperties" : false }, "VersionIssuesStatus" : { "type" : "object", "additionalProperties" : true, "description" : "Counts of the number of issues in various statuses.", "properties" : { "done" : { "type" : "integer", "description" : "Count of issues with status *done*.", "readOnly" : true, "format" : "int64" }, "toDo" : { "readOnly" : true, "format" : "int64", "description" : "Count of issues with status *to do*.", "type" : "integer" }, "unmapped" : { "description" : "Count of issues with a status other than *to do*, *in progress*, and *done*.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "inProgress" : { "type" : "integer", "description" : "Count of issues with status *in progress*.", "format" : "int64", "readOnly" : true } } }, "TimeTrackingConfiguration" : { "properties" : { "timeFormat" : { "description" : "The format that will appear on an issue's *Time Spent* field.", "type" : "string", "enum" : [ "pretty", "days", "hours" ] }, "workingHoursPerDay" : { "format" : "double", "description" : "The number of hours in a working day.", "type" : "number" }, "defaultUnit" : { "enum" : [ "minute", "hour", "day", "week" ], "type" : "string", "description" : "The default unit of time applied to logged time." }, "workingDaysPerWeek" : { "type" : "number", "format" : "double", "description" : "The number of days in a working week." } }, "required" : [ "defaultUnit", "timeFormat", "workingDaysPerWeek", "workingHoursPerDay" ], "additionalProperties" : false, "description" : "Details of the time tracking configuration.", "type" : "object" }, "User" : { "description" : "A user.", "additionalProperties" : false, "xml" : { "name" : "user" }, "type" : "object", "properties" : { "active" : { "type" : "boolean", "description" : "Indicates whether the user is active.", "readOnly" : true }, "groups" : { "description" : "The groups that the user belongs to.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/SimpleListWrapperGroupName" } ] }, "timeZone" : { "readOnly" : true, "description" : "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.", "type" : "string" }, "self" : { "description" : "The URL of the user.", "readOnly" : true, "format" : "uri", "type" : "string" }, "avatarUrls" : { "description" : "The avatars of the user.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/AvatarUrlsBean" } ] }, "expand" : { "description" : "Expand options that include additional user details in the response.", "readOnly" : true, "xml" : { "attribute" : true }, "type" : "string" }, "name" : { "type" : "string", "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, "accountType" : { "description" : "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk", "readOnly" : true, "type" : "string", "enum" : [ "atlassian", "app", "customer", "unknown" ] }, "locale" : { "type" : "string", "description" : "The locale of the user. Depending on the user’s privacy setting, this may be returned as null.", "readOnly" : true }, "displayName" : { "description" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.", "readOnly" : true, "type" : "string" }, "key" : { "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "type" : "string" }, "applicationRoles" : { "allOf" : [ { "$ref" : "#/components/schemas/SimpleListWrapperApplicationRole" } ], "description" : "The application roles the user is assigned to.", "readOnly" : true }, "emailAddress" : { "readOnly" : true, "description" : "The email address of the user. Depending on the user’s privacy setting, this may be returned as null.", "type" : "string" }, "accountId" : { "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests.", "type" : "string" } } }, "WorkflowTransitionRulesUpdate" : { "properties" : { "workflows" : { "type" : "array", "description" : "The list of workflows with transition rules to update.", "items" : { "$ref" : "#/components/schemas/WorkflowTransitionRules" } } }, "additionalProperties" : false, "description" : "Details about a workflow configuration update request.", "type" : "object" }, "AuditRecords" : { "additionalProperties" : false, "description" : "Container for a list of audit records.", "type" : "object", "properties" : { "limit" : { "readOnly" : true, "format" : "int32", "description" : "The requested or default limit on the number of audit items to be returned.", "type" : "integer" }, "records" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/AuditRecordBean" }, "description" : "The list of audit items.", "type" : "array" }, "total" : { "description" : "The total number of audit items returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "offset" : { "description" : "The number of audit items skipped before the first item in this list.", "readOnly" : true, "format" : "int32", "type" : "integer" } } }, "SearchRequestBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "fields" : { "type" : "array", "items" : { "type" : "string" }, "description" : "A comma-separated list of fields to return for each issue, use it to retrieve a subset of fields. Allowed values\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nThe default is `*navigable`.\n\nExamples:\n\n * `summary,comment` Returns the summary and comments fields only.\n * `-description` Returns all navigable (default) fields except description.\n * `*all,-comment` Returns all fields except comments.\n\nMultiple `fields` parameters can be included in a request.\n\nNote: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields." }, "maxResults" : { "type" : "integer", "format" : "int32", "description" : "The maximum number of items to return per page. The default is `50` and the maximum is `100`." }, "validateQuery" : { "type" : "string", "description" : "Determines how to validate the JQL query and treat the validation results. Supported values:\n\n * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `warn` Returns all errors as warnings.\n * `none` No validation is performed.\n * `true` *Deprecated* A legacy synonym for `strict`.\n * `false` *Deprecated* A legacy synonym for `warn`.\n\nThe default is `strict`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.", "enum" : [ "strict", "warn", "none", "true", "false" ] }, "expand" : { "items" : { "type" : "string" }, "description" : "Use [expand](em>#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `operations` Returns all possible operations for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.", "type" : "array" }, "startAt" : { "type" : "integer", "description" : "The index of the first item to return in the page of results (page offset). The base index is `0`.", "format" : "int32" }, "fieldsByKeys" : { "description" : "Reference fields by their key (rather than ID). The default is `false`.", "type" : "boolean" }, "jql" : { "description" : "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.", "type" : "string" }, "properties" : { "type" : "array", "description" : "A comma-separated list of up to 5 issue properties to include in the results.", "items" : { "type" : "string" } } } }, "IssueTypeIssueCreateMetadata" : { "type" : "object", "description" : "Details of the issue creation metadata for an issue type.", "additionalProperties" : false, "properties" : { "self" : { "readOnly" : true, "description" : "The URL of these issue type details.", "type" : "string" }, "entityId" : { "description" : "project unique ID for next-gen entities", "format" : "uuid", "readOnly" : true, "type" : "string" }, "fields" : { "readOnly" : true, "additionalProperties" : { "$ref" : "#/components/schemas/FieldMetadata" }, "description" : "List of the fields available when creating an issue for the issue type.", "type" : "object" }, "avatarId" : { "description" : "The ID of the issue type's avatar.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "id" : { "type" : "string", "readOnly" : true, "description" : "The ID of the issue type." }, "scope" : { "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ], "readOnly" : true, "description" : "Details of the next-gen projects the issue type is available in." }, "iconUrl" : { "readOnly" : true, "description" : "The URL of the issue type's avatar.", "type" : "string" }, "expand" : { "readOnly" : true, "description" : "Expand options that include additional issue type metadata details in the response.", "type" : "string", "xml" : { "attribute" : true } }, "subtask" : { "description" : "Indicates whether this issue type is used to create subtasks.", "readOnly" : true, "type" : "boolean" }, "name" : { "description" : "The name of the issue type.", "readOnly" : true, "type" : "string" }, "description" : { "description" : "The description of the issue type.", "readOnly" : true, "type" : "string" } } }, "IssueEntityProperties" : { "description" : "Lists of issues and entity properties. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more information.", "additionalProperties" : false, "type" : "object", "properties" : { "properties" : { "maxProperties" : 10, "minProperties" : 1, "description" : "A list of entity property keys and values.", "additionalProperties" : { "$ref" : "#/components/schemas/JsonNode" }, "type" : "object" }, "entitiesIds" : { "items" : { "format" : "int64", "type" : "integer" }, "description" : "A list of entity IDs.", "uniqueItems" : true, "type" : "array", "maxItems" : 10000, "minItems" : 1 } } }, "ListWrapperCallbackApplicationRole" : { "type" : "object", "additionalProperties" : false }, "ProjectRoleGroupBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "name" : { "type" : "string" } } }, "RichText" : { "type" : "object", "properties" : { "emptyAdf" : { "type" : "boolean" }, "valueSet" : { "type" : "boolean" } } }, "SecurityScheme" : { "description" : "Details about a security scheme.", "additionalProperties" : false, "type" : "object", "properties" : { "defaultSecurityLevelId" : { "description" : "The ID of the default security level.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "levels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SecurityLevel" } }, "description" : { "readOnly" : true, "description" : "The description of the issue security scheme.", "type" : "string" }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the issue security scheme." }, "id" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The ID of the issue security scheme." }, "self" : { "type" : "string", "readOnly" : true, "description" : "The URL of the issue security scheme." } } }, "ServerInformation" : { "additionalProperties" : false, "description" : "Details about the Jira instance.", "type" : "object", "properties" : { "buildDate" : { "description" : "The timestamp when the Jira version was built.", "format" : "date-time", "type" : "string" }, "baseUrl" : { "type" : "string", "description" : "The base URL of the Jira instance." }, "serverTime" : { "type" : "string", "format" : "date-time", "description" : "The time in Jira when this request was responded to." }, "version" : { "description" : "The version of Jira.", "type" : "string" }, "serverTitle" : { "type" : "string", "description" : "The name of the Jira instance." }, "healthChecks" : { "items" : { "$ref" : "#/components/schemas/HealthCheckResult" }, "description" : "Jira instance health check results. Deprecated and no longer returned.", "type" : "array" }, "versionNumbers" : { "type" : "array", "description" : "The major, minor, and revision version numbers of the Jira version.", "items" : { "format" : "int32", "type" : "integer" } }, "deploymentType" : { "description" : "The type of server deployment. This is always returned as *Cloud*.", "type" : "string" }, "scmInfo" : { "description" : "The unique identifier of the Jira version.", "type" : "string" }, "buildNumber" : { "type" : "integer", "format" : "int32", "description" : "The build number of the Jira version." } } }, "ContainerOfWorkflowSchemeAssociations" : { "type" : "object", "additionalProperties" : false, "description" : "A container for a list of workflow schemes together with the projects they are associated with.", "required" : [ "values" ], "properties" : { "values" : { "type" : "array", "description" : "A list of workflow schemes together with projects they are associated with.", "items" : { "$ref" : "#/components/schemas/WorkflowSchemeAssociations" } } } }, "Workflow" : { "additionalProperties" : false, "description" : "Details about a workflow.", "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/PublishedWorkflowId" }, "statuses" : { "items" : { "$ref" : "#/components/schemas/WorkflowStatus" }, "description" : "The statuses of the workflow.", "type" : "array" }, "description" : { "description" : "The description of the workflow.", "type" : "string" }, "transitions" : { "description" : "The transitions of the workflow.", "items" : { "$ref" : "#/components/schemas/Transition" }, "type" : "array" } }, "required" : [ "description" ] }, "RemoteIssueLinkIdentifies" : { "properties" : { "id" : { "xml" : { "attribute" : true }, "type" : "integer", "description" : "The ID of the remote issue link, such as the ID of the item on the remote system.", "readOnly" : true, "format" : "int64" }, "self" : { "xml" : { "attribute" : true }, "type" : "string", "description" : "The URL of the remote issue link.", "readOnly" : true } }, "additionalProperties" : false, "description" : "Details of the identifiers for a created or updated remote issue link.", "type" : "object" }, "JexpJqlIssues" : { "additionalProperties" : false, "description" : "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query will be loaded, but only a portion of them, as described by the `startAt` and `maxResults` properties. Iterate over pages by inspecting the meta data included in the response.", "type" : "object", "properties" : { "maxResults" : { "type" : "integer", "format" : "int32", "description" : "The maximum number of issues that will be included on the list. This value is currently capped at 1000 but the cap may change without notice." }, "startAt" : { "type" : "integer", "format" : "int64", "description" : "The index of the first issue returned from the JQL query." }, "query" : { "description" : "The JQL query.", "type" : "string" }, "validation" : { "description" : "Determines how to validate the JQL query and treat the validation results.", "type" : "string", "default" : "strict", "enum" : [ "strict", "warn", "none" ] } } }, "JiraExpressionEvalRequestBean" : { "type" : "object", "additionalProperties" : false, "required" : [ "expression" ], "properties" : { "context" : { "description" : "The context in which the Jira expression is evaluated.", "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionEvalContextBean" } ] }, "expression" : { "example" : "{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }", "type" : "string", "description" : "The Jira expression to evaluate." } } }, "PageBeanUserKey" : { "type" : "object", "additionalProperties" : false, "description" : "A page of items.", "properties" : { "startAt" : { "type" : "integer", "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true }, "nextPage" : { "type" : "string", "description" : "If there is another page of results, the URL of the next page.", "format" : "uri", "readOnly" : true }, "maxResults" : { "type" : "integer", "readOnly" : true, "format" : "int32", "description" : "The maximum number of items that could be returned." }, "values" : { "type" : "array", "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/UserKey" }, "readOnly" : true }, "total" : { "type" : "integer", "description" : "The number of items returned.", "readOnly" : true, "format" : "int64" }, "isLast" : { "readOnly" : true, "description" : "Indicates whether this is the last page.", "type" : "boolean" }, "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of the page." } } }, "PageOfWorklogs" : { "properties" : { "startAt" : { "readOnly" : true, "format" : "int32", "description" : "The index of the first item returned on the page.", "type" : "integer" }, "maxResults" : { "description" : "The maximum number of results that could be on the page.", "format" : "int32", "readOnly" : true, "type" : "integer" }, "worklogs" : { "readOnly" : true, "description" : "List of worklogs.", "items" : { "$ref" : "#/components/schemas/Worklog" }, "type" : "array" }, "total" : { "format" : "int32", "readOnly" : true, "description" : "The number of results on the page.", "type" : "integer" } }, "description" : "Paginated list of worklog details", "additionalProperties" : true, "type" : "object" }, "PageBeanField" : { "properties" : { "nextPage" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "If there is another page of results, the URL of the next page." }, "maxResults" : { "type" : "integer", "format" : "int32", "readOnly" : true, "description" : "The maximum number of items that could be returned." }, "startAt" : { "description" : "The index of the first item returned.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "isLast" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether this is the last page." }, "self" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "The URL of the page." }, "total" : { "description" : "The number of items returned.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "values" : { "type" : "array", "readOnly" : true, "description" : "The list of items.", "items" : { "$ref" : "#/components/schemas/Field" } } }, "type" : "object", "additionalProperties" : false, "description" : "A page of items." }, "SimpleErrorCollection" : { "properties" : { "errorMessages" : { "items" : { "type" : "string" }, "description" : "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"", "type" : "array" }, "errors" : { "type" : "object", "description" : "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"", "additionalProperties" : { "type" : "string" } }, "httpStatusCode" : { "type" : "integer", "format" : "int32" } }, "additionalProperties" : false, "type" : "object" }, "ScreenableField" : { "type" : "object", "description" : "A screen tab field.", "additionalProperties" : false, "properties" : { "name" : { "description" : "The name of the screen tab field. Required on create and update. The maximum length is 255 characters.", "type" : "string" }, "id" : { "readOnly" : true, "description" : "The ID of the screen tab field.", "type" : "string" } } }, "StatusDetails" : { "properties" : { "iconUrl" : { "type" : "string", "readOnly" : true, "description" : "The URL of the icon used to represent the status." }, "description" : { "type" : "string", "readOnly" : true, "description" : "The description of the status." }, "statusCategory" : { "readOnly" : true, "description" : "The category assigned to the status.", "allOf" : [ { "$ref" : "#/components/schemas/StatusCategory" } ] }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the status." }, "self" : { "type" : "string", "description" : "The URL of the status.", "readOnly" : true }, "id" : { "description" : "The ID of the status.", "readOnly" : true, "type" : "string" } }, "additionalProperties" : true, "description" : "A status.", "type" : "object" }, "EntityProperty" : { "properties" : { "value" : { "description" : "The value of the property. Required on create and update." }, "key" : { "description" : "The key of the property. Required on create and update.", "type" : "string" } }, "type" : "object", "description" : "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).", "additionalProperties" : false }, "CreateUpdateRoleRequestBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "name" : { "description" : "The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.", "type" : "string" }, "description" : { "description" : "A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.", "type" : "string" } } }, "PagedListUserDetailsApplicationUser" : { "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserDetails" }, "description" : "The list of items.", "readOnly" : true }, "size" : { "description" : "The number of items on the page.", "readOnly" : true, "format" : "int32", "xml" : { "attribute" : true }, "type" : "integer" }, "end-index" : { "description" : "The index of the last item returned on the page.", "format" : "int32", "readOnly" : true, "xml" : { "name" : "end-index", "attribute" : true }, "type" : "integer" }, "start-index" : { "type" : "integer", "xml" : { "name" : "start-index", "attribute" : true }, "format" : "int32", "readOnly" : true, "description" : "The index of the first item returned on the page." }, "max-results" : { "xml" : { "name" : "max-results", "attribute" : true }, "type" : "integer", "description" : "The maximum number of results that could be on the page.", "readOnly" : true, "format" : "int32" } }, "description" : "A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40.", "additionalProperties" : false, "type" : "object" }, "PageBeanNotificationScheme" : { "properties" : { "startAt" : { "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "nextPage" : { "readOnly" : true, "format" : "uri", "description" : "If there is another page of results, the URL of the next page.", "type" : "string" }, "maxResults" : { "type" : "integer", "format" : "int32", "readOnly" : true, "description" : "The maximum number of items that could be returned." }, "values" : { "items" : { "$ref" : "#/components/schemas/NotificationScheme" }, "description" : "The list of items.", "readOnly" : true, "type" : "array" }, "self" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "The URL of the page." }, "isLast" : { "readOnly" : true, "description" : "Indicates whether this is the last page.", "type" : "boolean" }, "total" : { "type" : "integer", "description" : "The number of items returned.", "readOnly" : true, "format" : "int64" } }, "additionalProperties" : false, "description" : "A page of items.", "type" : "object" }, "WorkflowSchemeAssociations" : { "additionalProperties" : false, "description" : "A workflow scheme along with a list of projects that use it.", "type" : "object", "properties" : { "projectIds" : { "items" : { "type" : "string" }, "description" : "The list of projects that use the workflow scheme.", "type" : "array" }, "workflowScheme" : { "allOf" : [ { "$ref" : "#/components/schemas/WorkflowScheme" } ], "description" : "The workflow scheme." } }, "required" : [ "projectIds" ] }, "Notification" : { "additionalProperties" : true, "description" : "Details about a notification.", "type" : "object", "properties" : { "textBody" : { "type" : "string", "description" : "The plain text body of the email notification for the issue." }, "subject" : { "type" : "string", "description" : "The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary." }, "restrict" : { "allOf" : [ { "$ref" : "#/components/schemas/NotificationRecipientsRestrictions" } ], "description" : "Restricts the notifications to users with the specified permissions." }, "htmlBody" : { "description" : "The HTML body of the email notification for the issue.", "type" : "string" }, "to" : { "allOf" : [ { "$ref" : "#/components/schemas/NotificationRecipients" } ], "description" : "The recipients of the email notification for the issue." } } }, "FunctionOperand" : { "description" : "An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions.", "type" : "object", "properties" : { "function" : { "type" : "string", "description" : "The name of the function." }, "arguments" : { "items" : { "type" : "string" }, "description" : "The list of function arguments.", "type" : "array" } }, "required" : [ "function" ] }, "JsonNode" : { "type" : "object", "maxProperties" : 10, "minProperties" : 1, "additionalProperties" : false, "properties" : { "pojo" : { "type" : "boolean" }, "booleanValue" : { "type" : "boolean" }, "object" : { "type" : "boolean" }, "fields" : { "type" : "object" }, "valueAsInt" : { "type" : "integer", "format" : "int32" }, "textual" : { "type" : "boolean" }, "containerNode" : { "type" : "boolean" }, "array" : { "type" : "boolean" }, "intValue" : { "type" : "integer", "format" : "int32" }, "long" : { "type" : "boolean" }, "int" : { "type" : "boolean" }, "floatingPointNumber" : { "type" : "boolean" }, "null" : { "type" : "boolean" }, "integralNumber" : { "type" : "boolean" }, "elements" : { "type" : "object" }, "boolean" : { "type" : "boolean" }, "numberType" : { "type" : "string", "enum" : [ "INT", "LONG", "BIG_INTEGER", "FLOAT", "DOUBLE", "BIG_DECIMAL" ] }, "number" : { "type" : "boolean" }, "binary" : { "type" : "boolean" }, "double" : { "type" : "boolean" }, "bigIntegerValue" : { "type" : "integer" }, "valueAsLong" : { "format" : "int64", "type" : "integer" }, "bigDecimal" : { "type" : "boolean" }, "valueAsText" : { "type" : "string" }, "numberValue" : { "type" : "number" }, "missingNode" : { "type" : "boolean" }, "textValue" : { "type" : "string" }, "valueAsDouble" : { "format" : "double", "type" : "number" }, "decimalValue" : { "type" : "number" }, "binaryValue" : { "items" : { "format" : "byte", "type" : "string" }, "type" : "array" }, "valueAsBoolean" : { "type" : "boolean" }, "longValue" : { "type" : "integer", "format" : "int64" }, "bigInteger" : { "type" : "boolean" }, "valueNode" : { "type" : "boolean" }, "doubleValue" : { "type" : "number", "format" : "double" }, "fieldNames" : { "type" : "object" } } }, "SimpleListWrapperGroupName" : { "additionalProperties" : false, "xml" : { "name" : "list" }, "type" : "object", "properties" : { "pagingCallback" : { "$ref" : "#/components/schemas/ListWrapperCallbackGroupName" }, "size" : { "type" : "integer", "xml" : { "attribute" : true }, "format" : "int32" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupName" } }, "callback" : { "$ref" : "#/components/schemas/ListWrapperCallbackGroupName" }, "max-results" : { "xml" : { "attribute" : true, "name" : "max-results" }, "type" : "integer", "format" : "int32" } } }, "IssueLinkType" : { "description" : "This object is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get).\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types.", "additionalProperties" : false, "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only." }, "self" : { "type" : "string", "description" : "The URL of the issue link type. Read only.", "format" : "uri", "readOnly" : true }, "inward" : { "type" : "string", "description" : "The description of the issue link type inward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only." }, "name" : { "description" : "The name of the issue link type and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.", "type" : "string" }, "outward" : { "description" : "The description of the issue link type outward link and is used as follows:\n\n * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only.\n * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only.", "type" : "string" } } }, "ProjectType" : { "type" : "object", "description" : "Details about a project type.", "additionalProperties" : false, "properties" : { "key" : { "type" : "string", "description" : "The key of the project type.", "readOnly" : true }, "icon" : { "type" : "string", "description" : "The icon of the project type.", "readOnly" : true }, "formattedKey" : { "type" : "string", "description" : "The formatted key of the project type.", "readOnly" : true }, "color" : { "readOnly" : true, "description" : "The color of the project type.", "type" : "string" }, "descriptionI18nKey" : { "type" : "string", "readOnly" : true, "description" : "The key of the project type's description." } } }, "RemoteIssueLinkRequest" : { "properties" : { "application" : { "allOf" : [ { "$ref" : "#/components/schemas/Application" } ], "description" : "Details of the remote application the linked item is in. For example, trello." }, "object" : { "allOf" : [ { "$ref" : "#/components/schemas/RemoteObject" } ], "description" : "Details of the item linked to." }, "relationship" : { "description" : "Description of the relationship between the issue and the linked item. If not set, the relationship description \"links to\" is used in Jira.", "type" : "string" }, "globalId" : { "type" : "string", "description" : "An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`.\n\nSetting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.\n\nThe maximum length is 255 characters." } }, "additionalProperties" : true, "description" : "Details of a remote issue link.", "type" : "object" }, "LinkIssueRequestJsonBean" : { "properties" : { "comment" : { "$ref" : "#/components/schemas/Comment" }, "type" : { "$ref" : "#/components/schemas/IssueLinkType" }, "inwardIssue" : { "$ref" : "#/components/schemas/LinkedIssue" }, "outwardIssue" : { "$ref" : "#/components/schemas/LinkedIssue" } }, "type" : "object", "additionalProperties" : false }, "Fields" : { "description" : "Key fields from the linked issue.", "additionalProperties" : false, "type" : "object", "properties" : { "summary" : { "type" : "string", "description" : "The summary description of the linked issue.", "readOnly" : true }, "status" : { "allOf" : [ { "$ref" : "#/components/schemas/StatusDetails" } ], "description" : "The status of the linked issue.", "readOnly" : true }, "issueType" : { "allOf" : [ { "$ref" : "#/components/schemas/IssueTypeBean" } ], "readOnly" : true, "description" : "The type of the linked issue." }, "issuetype" : { "$ref" : "#/components/schemas/IssueTypeBean", "description" : "The type of the linked issue." }, "priority" : { "allOf" : [ { "$ref" : "#/components/schemas/Priority" } ], "description" : "The priority of the linked issue.", "readOnly" : true }, "assignee" : { "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ], "readOnly" : true, "description" : "The assignee of the linked issue." } } }, "FieldUpdateOperation" : { "properties" : { "add" : { "example" : { "labels" : "Training", "issuelinks" : { "id" : 10001 } }, "description" : "A map containing the name of a field and the value to add to it." }, "edit" : { "example" : { "timetracking" : { "key" : "JIRA" } }, "description" : "A map containing the name of a field and the value to edit in it." }, "remove" : { "description" : "A map containing the name of a field and the value to removed from it.", "example" : { "components" : { "id" : 10017 }, "labels" : "Training" } }, "set" : { "description" : "A map containing the name of a field and the value to set in it.", "example" : { "issuetype" : { "id" : 10010 }, "summary" : "A new summary" } } }, "additionalProperties" : false, "description" : "Details of an operation to perform on a field.", "type" : "object" }, "ChangeDetails" : { "type" : "object", "additionalProperties" : false, "description" : "A change item.", "properties" : { "fieldId" : { "readOnly" : true, "description" : "The ID of the field changed.", "type" : "string" }, "toString" : { "readOnly" : true, "description" : "The details of the new value as a string.", "type" : "string" }, "field" : { "readOnly" : true, "description" : "The name of the field changed.", "type" : "string" }, "to" : { "readOnly" : true, "description" : "The details of the new value.", "type" : "string" }, "fieldtype" : { "type" : "string", "description" : "The type of the field changed.", "readOnly" : true }, "from" : { "readOnly" : true, "description" : "The details of the original value.", "type" : "string" }, "fromString" : { "readOnly" : true, "description" : "The details of the original value as a string.", "type" : "string" } } }, "JQLReferenceData" : { "properties" : { "jqlReservedWords" : { "type" : "array", "items" : { "type" : "string" }, "description" : "List of JQL query reserved words." }, "visibleFieldNames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FieldReferenceData" }, "description" : "List of fields usable in JQL queries." }, "visibleFunctionNames" : { "type" : "array", "description" : "List of functions usable in JQL queries.", "items" : { "$ref" : "#/components/schemas/FunctionReferenceData" } } }, "type" : "object", "description" : "Lists of JQL reference data.", "additionalProperties" : false }, "SharePermissionInputBean" : { "properties" : { "projectRoleId" : { "type" : "string", "description" : "The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in." }, "groupname" : { "description" : "The name of the group to share the filter with. Set `type` to `group`.", "type" : "string" }, "type" : { "type" : "string", "description" : "The type of the share permission.Specify the type as follows:\n\n * `group` Share with a group. Specify `groupname` as well.\n * `project` Share with a project. Specify `projectId` as well.\n * `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well.\n * `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.\n * `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.", "enum" : [ "project", "group", "projectRole", "global", "authenticated" ] }, "projectId" : { "description" : "The ID of the project to share the filter with. Set `type` to `project`.", "type" : "string" } }, "required" : [ "type" ], "additionalProperties" : false, "type" : "object" }, "JiraExpressionEvalContextBean" : { "properties" : { "customerRequest" : { "description" : "The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.", "format" : "int64", "type" : "integer" }, "serviceDesk" : { "type" : "integer", "description" : "The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression.", "format" : "int64" }, "issues" : { "allOf" : [ { "$ref" : "#/components/schemas/JexpIssues" } ], "description" : "The collection of issues that is available under the `issues` variable when evaluating the expression." }, "project" : { "description" : "The project that is available under the `project` variable when evaluating the expression.", "allOf" : [ { "$ref" : "#/components/schemas/IdOrKeyBean" } ] }, "sprint" : { "format" : "int64", "description" : "The ID of the sprint that is available under the `sprint` variable when evaluating the expression.", "type" : "integer" }, "issue" : { "description" : "The issue that is available under the `issue` variable when evaluating the expression.", "allOf" : [ { "$ref" : "#/components/schemas/IdOrKeyBean" } ] }, "board" : { "type" : "integer", "description" : "The ID of the board that is available under the `board` variable when evaluating the expression.", "format" : "int64" } }, "additionalProperties" : false, "type" : "object" }, "WorkflowTransition" : { "type" : "object", "description" : "A workflow transition.", "additionalProperties" : false, "required" : [ "id", "name" ], "properties" : { "id" : { "format" : "int32", "description" : "The transition ID.", "type" : "integer" }, "name" : { "description" : "The transition name.", "type" : "string" } } }, "ChangedWorklog" : { "properties" : { "properties" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/EntityProperty" }, "description" : "Details of properties associated with the change." }, "updatedTime" : { "type" : "integer", "description" : "The datetime of the change.", "readOnly" : true, "format" : "int64" }, "worklogId" : { "type" : "integer", "description" : "The ID of the worklog.", "format" : "int64", "readOnly" : true } }, "description" : "Details of a changed worklog.", "additionalProperties" : false, "type" : "object" }, "Votes" : { "type" : "object", "description" : "The details of votes on an issue.", "additionalProperties" : false, "properties" : { "votes" : { "description" : "The number of votes on the issue.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of these issue vote details." }, "voters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" }, "description" : "List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the *View voters and watchers* project permission.", "readOnly" : true }, "hasVoted" : { "type" : "boolean", "description" : "Indicates whether the user making this request has voted on the issue.", "readOnly" : true } } }, "IssuePickerSuggestionsIssueType" : { "properties" : { "sub" : { "readOnly" : true, "description" : "If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned.", "type" : "string" }, "issues" : { "items" : { "$ref" : "#/components/schemas/SuggestedIssue" }, "description" : "A list of issues suggested for use in auto-completion.", "readOnly" : true, "type" : "array" }, "label" : { "description" : "The label of the type of issues suggested for use in auto-completion.", "readOnly" : true, "type" : "string" }, "id" : { "description" : "The ID of the type of issues suggested for use in auto-completion.", "readOnly" : true, "type" : "string" }, "msg" : { "type" : "string", "description" : "If no issue suggestions are found, returns a message indicating no suggestions were found,", "readOnly" : true } }, "type" : "object", "additionalProperties" : false, "description" : "A type of issue suggested for use in auto-completion." }, "FieldReferenceData" : { "properties" : { "operators" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The valid search operators for the field." }, "cfid" : { "description" : "If the item is a custom field, the ID of the custom field.", "type" : "string" }, "displayName" : { "description" : "The display name of the field.", "type" : "string" }, "orderable" : { "enum" : [ "true", "false" ], "type" : "string", "description" : "Indicates whether the field can be used in a query's `ORDER BY` clause." }, "types" : { "items" : { "type" : "string" }, "description" : "The data types of items in the field.", "type" : "array" }, "searchable" : { "description" : "Indicates whether the content of this field can be searched.", "type" : "string", "enum" : [ "true", "false" ] }, "value" : { "description" : "The field identifier.", "type" : "string" }, "auto" : { "description" : "Indicates whether the field provide auto-complete suggestions.", "type" : "string", "enum" : [ "true", "false" ] } }, "description" : "Details of a field that can be used in advanced searches.", "additionalProperties" : false, "type" : "object" }, "PermissionSchemes" : { "additionalProperties" : false, "description" : "List of all permission schemes.", "type" : "object", "properties" : { "permissionSchemes" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/PermissionScheme" }, "description" : "Permission schemes list." } } }, "JQLPersonalDataMigrationRequest" : { "description" : "The JQL queries to be converted.", "additionalProperties" : false, "type" : "object", "properties" : { "queryStrings" : { "type" : "array", "items" : { "type" : "string" }, "description" : "A list of queries with user identifiers. Maximum of 100 queries." } } }, "AttachmentArchiveMetadataReadable" : { "type" : "object", "additionalProperties" : false, "description" : "Metadata for an archive (for example a zip) and its contents.", "properties" : { "entries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AttachmentArchiveItemReadable" }, "description" : "The list of the items included in the archive.", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the archive file." }, "totalEntryCount" : { "type" : "integer", "description" : "The number of items included in the archive.", "format" : "int64", "readOnly" : true }, "mediaType" : { "type" : "string", "readOnly" : true, "description" : "The MIME type of the attachment." }, "id" : { "description" : "The ID of the attachment.", "readOnly" : true, "format" : "int64", "type" : "integer" } } }, "Avatars" : { "properties" : { "custom" : { "items" : { "$ref" : "#/components/schemas/Avatar" }, "description" : "Custom avatars list.", "readOnly" : true, "type" : "array" }, "system" : { "description" : "System avatars list.", "items" : { "$ref" : "#/components/schemas/Avatar" }, "readOnly" : true, "type" : "array" } }, "type" : "object", "additionalProperties" : false, "description" : "Details about system and custom avatars." }, "PageBeanChangelog" : { "properties" : { "isLast" : { "description" : "Indicates whether this is the last page.", "readOnly" : true, "type" : "boolean" }, "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of the page." }, "total" : { "description" : "The number of items returned.", "readOnly" : true, "format" : "int64", "type" : "integer" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Changelog" }, "description" : "The list of items.", "readOnly" : true }, "nextPage" : { "type" : "string", "description" : "If there is another page of results, the URL of the next page.", "format" : "uri", "readOnly" : true }, "maxResults" : { "format" : "int32", "readOnly" : true, "description" : "The maximum number of items that could be returned.", "type" : "integer" }, "startAt" : { "description" : "The index of the first item returned.", "readOnly" : true, "format" : "int64", "type" : "integer" } }, "description" : "A page of items.", "additionalProperties" : false, "type" : "object" }, "RuleConfiguration" : { "type" : "object", "additionalProperties" : false, "description" : "A rule configuration.", "required" : [ "value" ], "properties" : { "value" : { "type" : "string", "description" : "Configuration of the rule, as it is stored by the Connect app on the rule configuration page." } } }, "ConnectModules" : { "description" : "A list of app modules in the same format as the `modules` property in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/).", "additionalProperties" : { "description" : "A list of modules by type.", "items" : { "$ref" : "#/components/schemas/ConnectModule" }, "type" : "array" }, "type" : "object", "example" : { "jiraIssueFields" : [ { "key" : "dynamic-select-field", "extractions" : [ { "name" : "categoryName", "type" : "text", "path" : "category" } ], "description" : { "value" : "A dynamically added single-select field" }, "name" : { "value" : "Dynamic single select" }, "type" : "single_select" } ], "jiraEntityProperties" : [ { "entityType" : "issue", "keyConfigurations" : [ { "extractions" : [ { "alias" : "attachmentExtension", "type" : "text", "objectName" : "extension" } ], "propertyKey" : "attachment" } ], "key" : "dynamic-attachment-entity-property", "name" : { "value" : "Attachment Index Document" } } ] } }, "Worklog" : { "properties" : { "updated" : { "type" : "string", "readOnly" : true, "format" : "date-time", "description" : "The datetime on which the worklog was last updated." }, "issueId" : { "description" : "The ID of the issue this worklog is for.", "readOnly" : true, "type" : "string" }, "visibility" : { "allOf" : [ { "$ref" : "#/components/schemas/Visibility" } ], "description" : "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog." }, "updateAuthor" : { "readOnly" : true, "description" : "Details of the user who last updated the worklog.", "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ] }, "properties" : { "items" : { "$ref" : "#/components/schemas/EntityProperty" }, "description" : "Details of properties for the worklog. Optional when creating or updating a worklog.", "type" : "array" }, "id" : { "description" : "The ID of the worklog record.", "readOnly" : true, "type" : "string" }, "timeSpent" : { "description" : "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.", "type" : "string" }, "comment" : { "description" : "A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog." }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true, "description" : "The datetime on which the worklog was created." }, "author" : { "readOnly" : true, "description" : "Details of the user who created the worklog.", "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ] }, "started" : { "format" : "date-time", "description" : "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.", "type" : "string" }, "timeSpentSeconds" : { "format" : "int64", "description" : "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.", "type" : "integer" }, "self" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "The URL of the worklog item." } }, "type" : "object", "xml" : { "name" : "worklog" }, "description" : "Details of a worklog.", "additionalProperties" : true }, "UnrestrictedUserEmail" : { "additionalProperties" : false, "type" : "object", "properties" : { "accountId" : { "type" : "string", "description" : "The accountId of the user" }, "email" : { "type" : "string", "description" : "The email of the user" } } }, "JqlQueryClauseOperand" : { "description" : "Details of an operand in a JQL clause.", "type" : "object", "anyOf" : [ { "$ref" : "#/components/schemas/ListOperand" }, { "$ref" : "#/components/schemas/ValueOperand" }, { "$ref" : "#/components/schemas/FunctionOperand" }, { "$ref" : "#/components/schemas/KeywordOperand" } ] }, "RegisteredWebhook" : { "additionalProperties" : false, "description" : "ID of a registered webhook or error messages explaining why a webhook wasn't registered.", "type" : "object", "properties" : { "errors" : { "type" : "array", "description" : "Error messages specifying why the webhook creation failed.", "items" : { "type" : "string", "description" : "Error messages specifying why the webhook creation failed." } }, "createdWebhookId" : { "type" : "integer", "description" : "The ID of the webhook. Returned if the webhook is created.", "format" : "int64" } } }, "Dashboard" : { "additionalProperties" : false, "description" : "Details of a dashboard.", "type" : "object", "properties" : { "description" : { "type" : "string" }, "view" : { "readOnly" : true, "description" : "The URL of the dashboard.", "type" : "string" }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the dashboard." }, "sharePermissions" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/SharePermission" }, "description" : "The details of any share permissions for the dashboard.", "type" : "array" }, "popularity" : { "description" : "The number of users who have this dashboard as a favorite.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "id" : { "description" : "The ID of the dashboard.", "readOnly" : true, "type" : "string" }, "owner" : { "description" : "The owner of the dashboard.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/UserBean" } ] }, "rank" : { "type" : "integer", "readOnly" : true, "format" : "int32", "description" : "The rank of this dashboard." }, "self" : { "type" : "string", "description" : "The URL of these dashboard details.", "readOnly" : true, "format" : "uri" }, "isFavourite" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the dashboard is selected as a favorite by the user." } } }, "PropertyKeys" : { "additionalProperties" : false, "description" : "List of property keys.", "type" : "object", "properties" : { "keys" : { "type" : "array", "readOnly" : true, "description" : "Property key details.", "items" : { "$ref" : "#/components/schemas/PropertyKey" } } } }, "ParsedJqlQuery" : { "required" : [ "query" ], "minLength" : 1, "properties" : { "query" : { "type" : "string", "description" : "The JQL query that was parsed and validated." }, "errors" : { "uniqueItems" : true, "items" : { "type" : "string" }, "description" : "The list of syntax or validation errors.", "type" : "array" }, "structure" : { "allOf" : [ { "$ref" : "#/components/schemas/JqlQuery" } ], "description" : "The syntax tree of the query. Empty if the query was invalid." } }, "type" : "object", "description" : "Details of a parsed JQL query.", "additionalProperties" : false }, "HierarchyLevel" : { "properties" : { "aboveLevelId" : { "type" : "integer", "format" : "int64" }, "id" : { "type" : "integer", "format" : "int64" }, "issueTypeIds" : { "items" : { "type" : "integer", "format" : "int64" }, "type" : "array" }, "projectConfigurationId" : { "type" : "integer", "format" : "int64" }, "externalUuid" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "belowLevelId" : { "type" : "integer", "format" : "int64" } }, "additionalProperties" : false, "type" : "object" }, "SystemAvatars" : { "properties" : { "system" : { "description" : "A list of avatar details.", "items" : { "$ref" : "#/components/schemas/Avatar" }, "readOnly" : true, "type" : "array" } }, "description" : "List of system avatars.", "additionalProperties" : false, "type" : "object" }, "CreatedIssues" : { "type" : "object", "description" : "Details about the issues created and the errors for requests that failed.", "additionalProperties" : false, "properties" : { "errors" : { "type" : "array", "description" : "Error details for failed issue creation requests.", "items" : { "$ref" : "#/components/schemas/BulkOperationErrorResult" }, "readOnly" : true }, "issues" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/CreatedIssue" }, "description" : "Details of the issues created.", "type" : "array" } } }, "FunctionReferenceData" : { "properties" : { "displayName" : { "description" : "The display name of the function.", "type" : "string" }, "types" : { "items" : { "type" : "string" }, "description" : "The data types returned by the function.", "type" : "array" }, "isList" : { "type" : "string", "description" : "Indicates whether the function can take a list of arguments.", "enum" : [ "true", "false" ] }, "value" : { "description" : "The function identifier.", "type" : "string" } }, "type" : "object", "additionalProperties" : false, "description" : "Details of functions that can be used in advanced searches." }, "IssueLinkTypes" : { "properties" : { "issueLinkTypes" : { "xml" : { "name" : "issueLinkTypes" }, "type" : "array", "items" : { "$ref" : "#/components/schemas/IssueLinkType" }, "description" : "The issue link type bean.", "readOnly" : true } }, "xml" : { "name" : "issueLinkTypes" }, "type" : "object", "additionalProperties" : false, "description" : "A list of issue link type beans." }, "IssueTypesWorkflowMapping" : { "properties" : { "issueTypes" : { "items" : { "type" : "string" }, "description" : "The list of issue type IDs.", "type" : "array" }, "defaultMapping" : { "description" : "Indicates whether the workflow is the default workflow for the workflow scheme.", "type" : "boolean" }, "workflow" : { "type" : "string", "description" : "The name of the workflow. Optional if updating the workflow-issue types mapping." }, "updateDraftIfNeeded" : { "description" : "Indicates whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`.", "type" : "boolean" } }, "additionalProperties" : false, "description" : "Details about the mapping between issue types and a workflow.", "type" : "object" }, "IssueTransition" : { "additionalProperties" : true, "description" : "Details of an issue transition.", "type" : "object", "properties" : { "isInitial" : { "description" : "Indicates whether this is the initial issue transition for the workflow.", "readOnly" : true, "type" : "boolean" }, "hasScreen" : { "description" : "Indicates whether there is a screen associated with the issue transition.", "readOnly" : true, "type" : "boolean" }, "to" : { "description" : "Details of the issue status after the transition.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/StatusDetails" } ] }, "fields" : { "readOnly" : true, "description" : "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.", "additionalProperties" : { "$ref" : "#/components/schemas/FieldMetadata" }, "type" : "object" }, "isConditional" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the issue has to meet certain criteria before the issue transition is applied." }, "isGlobal" : { "description" : "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.", "readOnly" : true, "type" : "boolean" }, "id" : { "description" : "The ID of the issue transition. Required when specifying a transition to undertake.", "type" : "string" }, "expand" : { "description" : "Expand options that include additional transition details in the response.", "readOnly" : true, "type" : "string" }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the issue transition." } } }, "SharePermission" : { "description" : "Details of a share permission for the filter.", "additionalProperties" : false, "type" : "object", "properties" : { "project" : { "allOf" : [ { "$ref" : "#/components/schemas/Project" } ], "description" : "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project." }, "id" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The unique identifier of the share permission." }, "role" : { "allOf" : [ { "$ref" : "#/components/schemas/ProjectRole" } ], "description" : "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in." }, "group" : { "description" : "The group that the filter is shared with. For a request, specify the `name` property for the group.", "allOf" : [ { "$ref" : "#/components/schemas/GroupName" } ] }, "type" : { "description" : "The type of share permission:\n\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request.", "type" : "string", "enum" : [ "group", "project", "projectRole", "global", "loggedin", "authenticated", "project-unknown" ] } }, "required" : [ "type" ] }, "IssueMatches" : { "properties" : { "matches" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IssueMatchesForJQL" } } }, "required" : [ "matches" ], "additionalProperties" : false, "description" : "A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.", "type" : "object" }, "PageBeanWorkflow" : { "properties" : { "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of the page." }, "isLast" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether this is the last page." }, "total" : { "description" : "The number of items returned.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "values" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Workflow" }, "description" : "The list of items.", "type" : "array" }, "maxResults" : { "type" : "integer", "readOnly" : true, "format" : "int32", "description" : "The maximum number of items that could be returned." }, "nextPage" : { "format" : "uri", "readOnly" : true, "description" : "If there is another page of results, the URL of the next page.", "type" : "string" }, "startAt" : { "description" : "The index of the first item returned.", "format" : "int64", "readOnly" : true, "type" : "integer" } }, "type" : "object", "description" : "A page of items.", "additionalProperties" : false }, "JqlQueryOrderByClause" : { "description" : "Details of the order-by JQL clause.", "additionalProperties" : false, "type" : "object", "properties" : { "fields" : { "type" : "array", "description" : "The list of order-by clause fields and their ordering directives.", "items" : { "$ref" : "#/components/schemas/JqlQueryOrderByClauseElement" } } }, "required" : [ "fields" ] }, "PermissionsKeysBean" : { "type" : "object", "additionalProperties" : false, "required" : [ "permissions" ], "properties" : { "permissions" : { "type" : "array", "description" : "A list of permission keys.", "items" : { "type" : "string" } } } }, "JqlQueryClauseTimePredicate" : { "required" : [ "operand", "operator" ], "properties" : { "operator" : { "type" : "string", "description" : "The operator between the field and the operand.", "enum" : [ "before", "after", "from", "to", "on", "during", "by" ] }, "operand" : { "$ref" : "#/components/schemas/JqlQueryClauseOperand" } }, "type" : "object", "description" : "A time predicate for a temporal JQL clause." }, "DeleteAndReplaceVersionBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "customFieldReplacementList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomFieldReplacement" }, "description" : "An array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to update when the fields contain the deleted version." }, "moveFixIssuesTo" : { "type" : "integer", "format" : "int64", "description" : "The ID of the version to update `fixVersion` to when the field contains the deleted version." }, "moveAffectedIssuesTo" : { "format" : "int64", "description" : "The ID of the version to update `affectedVersion` to when the field contains the deleted version.", "type" : "integer" } } }, "ProjectIssueCreateMetadata" : { "properties" : { "expand" : { "readOnly" : true, "description" : "Expand options that include additional project issue create metadata details in the response.", "type" : "string", "xml" : { "attribute" : true } }, "issuetypes" : { "description" : "List of the issue types supported by the project.", "items" : { "$ref" : "#/components/schemas/IssueTypeIssueCreateMetadata" }, "readOnly" : true, "type" : "array" }, "key" : { "description" : "The key of the project.", "readOnly" : true, "type" : "string" }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the project." }, "avatarUrls" : { "allOf" : [ { "$ref" : "#/components/schemas/AvatarUrlsBean" } ], "readOnly" : true, "description" : "List of the project's avatars, returning the avatar size and associated URL." }, "id" : { "readOnly" : true, "description" : "The ID of the project.", "type" : "string" }, "self" : { "type" : "string", "readOnly" : true, "description" : "The URL of the project." } }, "description" : "Details of the issue creation metadata for a project.", "additionalProperties" : false, "type" : "object" }, "JiraExpressionsComplexityBean" : { "properties" : { "steps" : { "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionsComplexityValueBean" } ], "description" : "The number of steps it took to evaluate the expression." }, "beans" : { "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionsComplexityValueBean" } ], "description" : "The number of Jira REST API beans returned in the response." }, "primitiveValues" : { "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionsComplexityValueBean" } ], "description" : "The number of primitive values returned in the response." }, "expensiveOperations" : { "allOf" : [ { "$ref" : "#/components/schemas/JiraExpressionsComplexityValueBean" } ], "description" : "The number of expensive operations executed while evaluating the expression. Expensive operations are those that load additional data, such as entity properties, comments, or custom fields." } }, "type" : "object", "additionalProperties" : false }, "Webhook" : { "type" : "object", "description" : "A webhook.", "additionalProperties" : false, "required" : [ "expirationDate", "id", "jqlFilter" ], "properties" : { "jqlFilter" : { "type" : "string", "description" : "The JQL filter that specifies which issues the webhook is sent for." }, "events" : { "type" : "array", "description" : "The Jira events that trigger the webhook.", "items" : { "enum" : [ "jira:issue_created", "jira:issue_updated", "jira:issue_deleted", "comment_created", "comment_updated", "comment_deleted" ], "type" : "string" } }, "expirationDate" : { "format" : "int64", "readOnly" : true, "type" : "integer" }, "id" : { "type" : "integer", "description" : "The ID of the webhook.", "format" : "int64" } } }, "ListWrapperCallbackGroupName" : { "type" : "object", "additionalProperties" : false }, "WorkflowRules" : { "required" : [ "conditions", "postFunctions", "validators" ], "properties" : { "validators" : { "type" : "array", "description" : "The workflow validators.", "items" : { "$ref" : "#/components/schemas/WorkflowTransitionRule" } }, "conditions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WorkflowTransitionRule" }, "description" : "The workflow conditions." }, "postFunctions" : { "type" : "array", "description" : "The workflow post functions.", "items" : { "$ref" : "#/components/schemas/WorkflowTransitionRule" } } }, "type" : "object", "additionalProperties" : false, "description" : "A collection of transition rules." }, "IssuesMetaBean" : { "properties" : { "jql" : { "$ref" : "#/components/schemas/IssuesJqlMetaDataBean" } }, "description" : "Meta data describing the `issues` context variable.", "additionalProperties" : false, "type" : "object" }, "MinimalIssueTypeOutput" : { "properties" : { "name" : { "type" : "string" }, "avatarId" : { "format" : "int64", "type" : "integer" }, "id" : { "format" : "int64", "type" : "integer" } }, "type" : "object", "additionalProperties" : false }, "LinkedIssue" : { "properties" : { "fields" : { "description" : "The fields associated with the issue.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/Fields" } ] }, "key" : { "description" : "The key of an issue. Required if `id` isn't provided.", "type" : "string" }, "id" : { "description" : "The ID of an issue. Required if `key` isn't provided.", "type" : "string" }, "self" : { "type" : "string", "readOnly" : true, "format" : "uri", "description" : "The URL of the issue." } }, "description" : "The ID or key of a linked issue.", "additionalProperties" : false, "type" : "object" }, "Screen" : { "description" : "A screen.", "additionalProperties" : false, "type" : "object", "properties" : { "id" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The ID of the screen." }, "scope" : { "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ], "description" : "The scope of the screen." }, "name" : { "description" : "The name of the screen.", "readOnly" : true, "type" : "string" } } }, "NotificationEvent" : { "type" : "object", "additionalProperties" : false, "description" : "Details about a notification event.", "properties" : { "description" : { "description" : "The description of the event.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the event." }, "id" : { "format" : "int64", "description" : "The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg).", "type" : "integer" }, "templateEvent" : { "allOf" : [ { "$ref" : "#/components/schemas/NotificationEvent" } ], "description" : "The template of the event. Only custom events configured by Jira administrators have template." } } }, "KeywordOperand" : { "type" : "object", "description" : "An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) for more information about operand keywords.", "required" : [ "keyword" ], "properties" : { "keyword" : { "enum" : [ "empty" ], "type" : "string", "description" : "The keyword that is the operand value." } } }, "ComponentWithIssueCount" : { "properties" : { "issueCount" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "Count of issues for the component." }, "assignee" : { "description" : "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.", "allOf" : [ { "$ref" : "#/components/schemas/User" } ] }, "isAssigneeTypeValid" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned." }, "realAssigneeType" : { "type" : "string", "readOnly" : true, "description" : "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true.", "enum" : [ "PROJECT_DEFAULT", "COMPONENT_LEAD", "PROJECT_LEAD", "UNASSIGNED" ] }, "project" : { "type" : "string", "readOnly" : true, "description" : "The key of the project to which the component is assigned." }, "self" : { "type" : "string", "description" : "The URL for this count of the issues contained in the component.", "readOnly" : true, "format" : "uri" }, "projectId" : { "description" : "Not used.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "realAssignee" : { "description" : "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.", "allOf" : [ { "$ref" : "#/components/schemas/User" } ] }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name for the component." }, "description" : { "type" : "string", "readOnly" : true, "description" : "The description for the component." }, "id" : { "type" : "string", "description" : "The unique identifier for the component.", "readOnly" : true }, "lead" : { "description" : "The user details for the component's lead user.", "allOf" : [ { "$ref" : "#/components/schemas/User" } ] }, "assigneeType" : { "type" : "string", "description" : "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.", "readOnly" : true, "enum" : [ "PROJECT_DEFAULT", "COMPONENT_LEAD", "PROJECT_LEAD", "UNASSIGNED" ] } }, "additionalProperties" : false, "description" : "Details about a component with a count of the issues it contains.", "type" : "object" }, "ContainerForRegisteredWebhooks" : { "type" : "object", "additionalProperties" : false, "description" : "Container for a list of registered webhooks. Webhook details are returned in the same order as the request.", "properties" : { "webhookRegistrationResult" : { "items" : { "$ref" : "#/components/schemas/RegisteredWebhook" }, "description" : "A list of registered webhooks.", "type" : "array" } } }, "BulkOperationErrorResult" : { "additionalProperties" : false, "type" : "object", "properties" : { "failedElementNumber" : { "type" : "integer", "format" : "int32" }, "status" : { "format" : "int32", "type" : "integer" }, "elementErrors" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "Project" : { "properties" : { "components" : { "items" : { "$ref" : "#/components/schemas/Component" }, "description" : "List of the components contained in the project.", "readOnly" : true, "type" : "array" }, "roles" : { "additionalProperties" : { "type" : "string", "readOnly" : true, "format" : "uri" }, "description" : "The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post).", "readOnly" : true, "type" : "object" }, "avatarUrls" : { "readOnly" : true, "description" : "The URLs of the project's avatars.", "allOf" : [ { "$ref" : "#/components/schemas/AvatarUrlsBean" } ] }, "email" : { "type" : "string", "description" : "An email address associated with the project." }, "key" : { "description" : "The key of the project.", "readOnly" : true, "type" : "string" }, "description" : { "type" : "string", "readOnly" : true, "description" : "A brief description of the project." }, "uuid" : { "readOnly" : true, "format" : "uuid", "description" : "unique ID for next-gen projects", "type" : "string" }, "isPrivate" : { "type" : "boolean", "description" : "Indicates whether the project is private.", "readOnly" : true }, "projectCategory" : { "allOf" : [ { "$ref" : "#/components/schemas/ProjectCategory" } ], "readOnly" : true, "description" : "The category the project belongs to." }, "style" : { "type" : "string", "readOnly" : true, "description" : "The type of the project.", "enum" : [ "CLASSIC", "NEXTGEN", "classic", "next-gen" ] }, "issueTypeHierarchy" : { "allOf" : [ { "$ref" : "#/components/schemas/Hierarchy" } ], "description" : "The issue type hierarchy for the project", "readOnly" : true }, "lead" : { "allOf" : [ { "$ref" : "#/components/schemas/User" } ], "readOnly" : true, "description" : "The username of the project lead." }, "id" : { "description" : "The ID of the project.", "type" : "string" }, "properties" : { "description" : "Map of project properties", "additionalProperties" : { "readOnly" : true }, "readOnly" : true, "type" : "object" }, "projectTypeKey" : { "enum" : [ "software", "service_desk", "business" ], "readOnly" : true, "description" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", "type" : "string" }, "issueTypes" : { "items" : { "$ref" : "#/components/schemas/IssueTypeBean" }, "description" : "List of the issue types available in the project.", "readOnly" : true, "type" : "array" }, "simplified" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the project is simplified." }, "self" : { "type" : "string", "description" : "The URL of the project details.", "format" : "uri", "readOnly" : true }, "expand" : { "type" : "string", "xml" : { "attribute" : true }, "readOnly" : true, "description" : "Expand options that include additional project details in the response." }, "url" : { "type" : "string", "description" : "A link to information about this project, such as project documentation.", "readOnly" : true }, "name" : { "description" : "The name of the project.", "readOnly" : true, "type" : "string" }, "permissions" : { "allOf" : [ { "$ref" : "#/components/schemas/ProjectPermissions" } ], "readOnly" : true, "description" : "User permissions on the project" }, "versions" : { "description" : "The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post).", "items" : { "$ref" : "#/components/schemas/Version" }, "readOnly" : true, "type" : "array" }, "assigneeType" : { "enum" : [ "PROJECT_LEAD", "UNASSIGNED" ], "type" : "string", "description" : "The default assignee when creating issues for this project.", "readOnly" : true } }, "xml" : { "name" : "project" }, "type" : "object", "description" : "Details about a project.", "additionalProperties" : false }, "WorklogIdsRequestBean" : { "type" : "object", "additionalProperties" : false, "required" : [ "ids" ], "properties" : { "ids" : { "description" : "A list of worklog IDs.", "items" : { "format" : "int64", "type" : "integer" }, "uniqueItems" : true, "type" : "array" } } }, "AttachmentArchiveImpl" : { "additionalProperties" : false, "type" : "object", "properties" : { "totalEntryCount" : { "type" : "integer", "description" : "The number of items in the archive.", "format" : "int32" }, "entries" : { "description" : "The list of the items included in the archive.", "items" : { "$ref" : "#/components/schemas/AttachmentArchiveEntry" }, "type" : "array" } } }, "Changelog" : { "description" : "A changelog.", "additionalProperties" : false, "type" : "object", "properties" : { "items" : { "readOnly" : true, "items" : { "$ref" : "#/components/schemas/ChangeDetails" }, "description" : "The list of items changed.", "type" : "array" }, "author" : { "readOnly" : true, "description" : "The user who made the change.", "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ] }, "created" : { "readOnly" : true, "format" : "date-time", "description" : "The date on which the change took place.", "type" : "string" }, "id" : { "readOnly" : true, "description" : "The ID of the changelog.", "type" : "string" }, "historyMetadata" : { "allOf" : [ { "$ref" : "#/components/schemas/HistoryMetadata" } ], "description" : "The history metadata associated with the changed.", "readOnly" : true } } }, "FieldMetadata" : { "xml" : { "name" : "availableField" }, "type" : "object", "description" : "The metadata describing an issue field.", "additionalProperties" : false, "required" : [ "key", "name", "operations", "required" ], "properties" : { "schema" : { "allOf" : [ { "$ref" : "#/components/schemas/JsonTypeBean" } ], "readOnly" : true, "description" : "The data type of the field." }, "hasDefaultValue" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the field has a default value." }, "operations" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string", "readOnly" : true }, "description" : "The list of operations that can be performed on the field." }, "defaultValue" : { "readOnly" : true, "description" : "The default value of the field." }, "required" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the field is required." }, "name" : { "readOnly" : true, "description" : "The name of the field.", "type" : "string" }, "autoCompleteUrl" : { "type" : "string", "readOnly" : true, "description" : "The URL that can be used to automatically complete the field." }, "key" : { "type" : "string", "readOnly" : true, "description" : "The key of the field." }, "allowedValues" : { "type" : "array", "readOnly" : true, "items" : { "readOnly" : true }, "description" : "The list of values allowed in the field." } } }, "PermissionGrant" : { "additionalProperties" : false, "description" : "Details about a permission granted to a user or group.", "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "The ID of the permission granted details.", "readOnly" : true, "format" : "int64" }, "self" : { "type" : "string", "format" : "uri", "readOnly" : true, "description" : "The URL of the permission granted details." }, "holder" : { "description" : "The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](#holder-object) in *Get all permission schemes* for more information.", "allOf" : [ { "$ref" : "#/components/schemas/PermissionHolder" } ] }, "permission" : { "type" : "string", "description" : "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions." } } }, "CustomFieldReplacement" : { "properties" : { "moveTo" : { "description" : "The version number to use as a replacement for the deleted version.", "format" : "int64", "type" : "integer" }, "customFieldId" : { "format" : "int64", "description" : "The ID of the custom field in which to replace the version number.", "type" : "integer" } }, "type" : "object", "additionalProperties" : false, "description" : "Details about the replacement for a deleted version." }, "ActorsMap" : { "properties" : { "user" : { "type" : "array", "items" : { "type" : "string" }, "description" : "The user account ID of the user to add." }, "group" : { "description" : "The name of the group to add.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object", "additionalProperties" : false }, "ProjectScopeBean" : { "additionalProperties" : false, "type" : "object", "properties" : { "id" : { "format" : "int64", "description" : "The ID of the project that the option's behavior applies to.", "type" : "integer" }, "attributes" : { "type" : "array", "items" : { "enum" : [ "notSelectable", "defaultValue" ], "type" : "string" }, "description" : "Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.", "uniqueItems" : true } } }, "AutoCompleteSuggestions" : { "additionalProperties" : false, "description" : "The results from a JQL query.", "type" : "object", "properties" : { "results" : { "type" : "array", "description" : "The list of suggested item.", "items" : { "$ref" : "#/components/schemas/AutoCompleteSuggestion" } } } }, "GroupName" : { "type" : "object", "description" : "Details about a group name.", "additionalProperties" : false, "properties" : { "name" : { "type" : "string", "description" : "The name of group." }, "self" : { "type" : "string", "description" : "The URL for these group details.", "format" : "uri", "readOnly" : true } } }, "PageOfChangelogs" : { "description" : "A page of changelogs.", "additionalProperties" : false, "type" : "object", "properties" : { "total" : { "type" : "integer", "readOnly" : true, "format" : "int32", "description" : "The number of results on the page." }, "histories" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Changelog" }, "description" : "The list of changelogs." }, "startAt" : { "readOnly" : true, "format" : "int32", "description" : "The index of the first item returned on the page.", "type" : "integer" }, "maxResults" : { "type" : "integer", "format" : "int32", "readOnly" : true, "description" : "The maximum number of results that could be on the page." } } }, "EventNotification" : { "type" : "object", "additionalProperties" : false, "description" : "Details about a notification associated with an event.", "properties" : { "parameter" : { "type" : "string", "description" : "The value of the `notificationType`:\n\n * `User` The `parameter` is the user key.\n * `Group` The `parameter` is the group name.\n * `ProjectRole` The `parameter` is the project role ID.\n * `UserCustomField` The `parameter` is the ID of the custom field.\n * `GroupCustomField` The `parameter` is the ID of the custom field." }, "user" : { "description" : "The specified user.", "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ] }, "projectRole" : { "allOf" : [ { "$ref" : "#/components/schemas/ProjectRole" } ], "description" : "The specified project role." }, "expand" : { "description" : "Expand options that include additional event notification details in the response.", "type" : "string" }, "group" : { "description" : "The specified group.", "allOf" : [ { "$ref" : "#/components/schemas/GroupName" } ] }, "notificationType" : { "type" : "string", "description" : "Identifies the recipients of the notification.", "enum" : [ "CurrentAssignee", "Reporter", "CurrentUser", "ProjectLead", "ComponentLead", "User", "Group", "ProjectRole", "EmailAddress", "AllWatchers", "UserCustomField", "GroupCustomField" ] }, "emailAddress" : { "type" : "string", "description" : "The email address." }, "id" : { "type" : "integer", "description" : "The ID of the notification.", "format" : "int64" }, "field" : { "allOf" : [ { "$ref" : "#/components/schemas/FieldDeprecated" } ], "description" : "The custom user or group field." } } }, "OperationMessage" : { "properties" : { "statusCode" : { "type" : "integer", "format" : "int32", "description" : "The status code of the response." }, "message" : { "description" : "The human-readable message that describes the result.", "type" : "string" } }, "required" : [ "message", "statusCode" ], "example" : { "statusCode" : 200, "message" : "An example message." }, "additionalProperties" : false, "type" : "object" }, "DeprecatedWorkflow" : { "properties" : { "scope" : { "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ], "description" : "The scope where this workflow applies", "readOnly" : true }, "lastModifiedDate" : { "readOnly" : true, "description" : "The datetime the workflow was last modified.", "type" : "string" }, "lastModifiedUser" : { "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "readOnly" : true, "type" : "string" }, "description" : { "readOnly" : true, "description" : "The description of the workflow.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the workflow.", "readOnly" : true }, "default" : { "type" : "boolean" }, "steps" : { "readOnly" : true, "format" : "int32", "description" : "The number of steps included in the workflow.", "type" : "integer" }, "lastModifiedUserAccountId" : { "type" : "string", "description" : "The account ID of the user that last modified the workflow.", "readOnly" : true } }, "type" : "object", "description" : "Details about a workflow.", "additionalProperties" : false }, "UserKey" : { "properties" : { "key" : { "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "type" : "string" }, "accountId" : { "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "type" : "string" } }, "additionalProperties" : false, "description" : "List of user accountIds.", "type" : "object" }, "PermittedProjects" : { "properties" : { "projects" : { "type" : "array", "description" : "A list of projects.", "items" : { "$ref" : "#/components/schemas/ProjectIdentifierBean" }, "readOnly" : true } }, "type" : "object", "additionalProperties" : false, "description" : "A list of projects in which a user is granted permissions." }, "IssueFilterForBulkPropertyDelete" : { "properties" : { "entityIds" : { "items" : { "format" : "int64", "type" : "integer" }, "description" : "List of issues to perform the bulk delete operation on.", "uniqueItems" : true, "type" : "array" }, "currentValue" : { "description" : "The value of properties to perform the bulk operation on." } }, "description" : "Bulk operation filter details.", "additionalProperties" : false, "type" : "object" }, "ProjectForScope" : { "properties" : { "avatarUrls" : { "allOf" : [ { "$ref" : "#/components/schemas/AvatarUrlsBean" } ], "readOnly" : true, "description" : "The URLs of the project's avatars." }, "self" : { "type" : "string", "description" : "The URL of the project details.", "readOnly" : true }, "projectTypeKey" : { "enum" : [ "software", "service_desk", "business" ], "description" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.", "readOnly" : true, "type" : "string" }, "simplified" : { "description" : "Whether or not the project is simplified.", "readOnly" : true, "type" : "boolean" }, "projectCategory" : { "allOf" : [ { "$ref" : "#/components/schemas/UpdatedProjectCategory" } ], "description" : "The category the project belongs to.", "readOnly" : true }, "id" : { "type" : "string", "description" : "The ID of the project." }, "key" : { "readOnly" : true, "description" : "The key of the project.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the project.", "readOnly" : true } }, "description" : "Details about a next-gen project.", "additionalProperties" : false, "type" : "object" }, "UpdatedProjectCategory" : { "description" : "A project category.", "additionalProperties" : false, "type" : "object", "properties" : { "name" : { "type" : "string", "readOnly" : true, "description" : "The description of the project category." }, "description" : { "readOnly" : true, "description" : "The name of the project category.", "type" : "string" }, "id" : { "readOnly" : true, "description" : "The ID of the project category.", "type" : "string" }, "self" : { "readOnly" : true, "description" : "The URL of the project category.", "type" : "string" } } }, "IssueCreateMetadata" : { "properties" : { "projects" : { "items" : { "$ref" : "#/components/schemas/ProjectIssueCreateMetadata" }, "description" : "List of projects and their issue creation metadata.", "readOnly" : true, "type" : "array" }, "expand" : { "xml" : { "attribute" : true }, "type" : "string", "description" : "Expand options that include additional project details in the response.", "readOnly" : true } }, "description" : "The wrapper for the issue creation metadata for a list of projects.", "additionalProperties" : false, "type" : "object" }, "WorkflowTransitionRule" : { "type" : "object", "description" : "A workflow transition rule.", "additionalProperties" : false, "required" : [ "type" ], "properties" : { "type" : { "description" : "The type of the transition rule.", "type" : "string" }, "configuration" : { "description" : "The configuration of the transition rule. This is currently returned only for some of the rule types. Availability of this property is subject to change." } } }, "IdBean" : { "required" : [ "id" ], "properties" : { "id" : { "type" : "integer", "description" : "The ID of the permission scheme to associate with the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to get a list of permission scheme IDs.", "format" : "int64" } }, "type" : "object", "additionalProperties" : false }, "ProjectInputBean" : { "properties" : { "projectTypeKey" : { "enum" : [ "software", "service_desk", "business" ], "type" : "string", "description" : "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which dictates the application-specific feature set. Required when creating a project. Not applicable for the Update project resource." }, "categoryId" : { "description" : "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation.", "format" : "int64", "type" : "integer" }, "url" : { "type" : "string", "description" : "A link to information about this project, such as project documentation" }, "key" : { "description" : "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters. Required when creating a project. Optional when updating a project.", "type" : "string" }, "description" : { "description" : "A brief description of the project.", "type" : "string" }, "name" : { "type" : "string", "description" : "The name of the project. Required when creating a project. Optional when updating a project." }, "permissionScheme" : { "description" : "The ID of the permission scheme for the project. Use the [Get all permission schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs.", "format" : "int64", "type" : "integer" }, "notificationScheme" : { "type" : "integer", "format" : "int64", "description" : "The ID of the notification scheme for the project. Use the [Get notification schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs." }, "assigneeType" : { "enum" : [ "PROJECT_LEAD", "UNASSIGNED" ], "type" : "string", "description" : "The default assignee when creating issues for this project." }, "projectTemplateKey" : { "type" : "string", "description" : "A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource.", "enum" : [ "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban", "com.pyxis.greenhopper.jira:gh-simplified-agility-scrum", "com.pyxis.greenhopper.jira:gh-simplified-basic", "com.pyxis.greenhopper.jira:gh-simplified-kanban-classic", "com.pyxis.greenhopper.jira:gh-simplified-scrum-classic", "com.atlassian.servicedesk:simplified-it-service-desk", "com.atlassian.servicedesk:simplified-internal-service-desk", "com.atlassian.servicedesk:simplified-external-service-desk", "com.atlassian.jira-core-project-templates:jira-core-simplified-content-management", "com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval", "com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking", "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control", "com.atlassian.jira-core-project-templates:jira-core-simplified-procurement", "com.atlassian.jira-core-project-templates:jira-core-simplified-project-management", "com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment", "com.atlassian.jira-core-project-templates:jira-core-simplified-task-", "com.atlassian.jira.jira-incident-management-plugin:im-incident-management" ] }, "issueSecurityScheme" : { "type" : "integer", "format" : "int64", "description" : "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) resource to get all issue security scheme IDs." }, "avatarId" : { "description" : "An integer value for the project's avatar.", "format" : "int64", "type" : "integer" }, "leadAccountId" : { "description" : "The account id of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `lead`.", "type" : "string" }, "lead" : { "type" : "string", "description" : "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional when updating a project. Cannot be provided with `leadAccountId`." } }, "additionalProperties" : false, "type" : "object" }, "BulkIssuePropertyUpdateRequest" : { "additionalProperties" : false, "description" : "Bulk issue property update request details.", "type" : "object", "properties" : { "value" : { "description" : "The value of the property. The value must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters." }, "filter" : { "allOf" : [ { "$ref" : "#/components/schemas/IssueFilterForBulkPropertySet" } ], "description" : "The bulk operation filter." } } }, "WebhookDetails" : { "additionalProperties" : false, "description" : "A list of webhooks.", "type" : "object", "properties" : { "jqlFilter" : { "type" : "string", "description" : "The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:\n\n * Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `reporter`, `issue.property`, and `cf[id]` (for custom fields—only the epic label custom field is supported).\n * Operators: `=`, `!=`, `IN`, and `NOT IN`." }, "events" : { "description" : "The Jira events that trigger the webhook.", "items" : { "type" : "string", "enum" : [ "jira:issue_created", "jira:issue_updated", "jira:issue_deleted", "comment_created", "comment_updated", "comment_deleted" ] }, "type" : "array" } }, "required" : [ "jqlFilter" ] }, "Transition" : { "required" : [ "description", "from", "id", "name", "to", "type" ], "properties" : { "id" : { "type" : "string", "description" : "The ID of the transition." }, "rules" : { "$ref" : "#/components/schemas/WorkflowRules" }, "name" : { "description" : "The name of the transition.", "type" : "string" }, "description" : { "description" : "The description of the transition.", "type" : "string" }, "type" : { "description" : "The type of the transition.", "type" : "string", "enum" : [ "global", "initial", "directed" ] }, "to" : { "description" : "The status to which the transition leads.", "type" : "string" }, "screen" : { "$ref" : "#/components/schemas/ScreenID" }, "from" : { "items" : { "type" : "string", "description" : "The list of statuses from which the transition can be taken." }, "description" : "The list of statuses from which the transition can be taken.", "type" : "array" } }, "type" : "object", "additionalProperties" : false, "description" : "Details of a workflow transition." }, "AuditRecordBean" : { "type" : "object", "description" : "An audit record.", "additionalProperties" : false, "properties" : { "id" : { "description" : "The ID of the audit record.", "format" : "int64", "readOnly" : true, "type" : "integer" }, "summary" : { "type" : "string", "description" : "The summary of the audit record.", "readOnly" : true }, "description" : { "description" : "The description of the audit record.", "readOnly" : true, "type" : "string" }, "objectItem" : { "$ref" : "#/components/schemas/AssociatedItemBean" }, "associatedItems" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/AssociatedItemBean" }, "description" : "The list of items associated with the changed record." }, "authorKey" : { "description" : "The key of the user who created the audit record.", "readOnly" : true, "type" : "string" }, "category" : { "type" : "string", "description" : "The category of the audit record. For a list of these categories, see the help article [Auditing in Jira applications](https://confluence.atlassian.com/x/noXKM).", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", "readOnly" : true, "description" : "The date and time on which the audit record was created." }, "remoteAddress" : { "description" : "The URL of the computer where the creation of the audit record was initiated.", "readOnly" : true, "type" : "string" }, "changedValues" : { "items" : { "$ref" : "#/components/schemas/ChangedValueBean" }, "description" : "The list of values changed in the record event.", "readOnly" : true, "type" : "array" }, "eventSource" : { "type" : "string", "description" : "The event the audit record originated from.", "readOnly" : true } } }, "ContainerForWebhookIDs" : { "additionalProperties" : false, "description" : "Container for a list of webhook IDs.", "type" : "object", "properties" : { "webhookIds" : { "description" : "A list of webhook IDs.", "items" : { "format" : "int64", "description" : "A list of webhook IDs.", "type" : "integer" }, "type" : "array" } }, "required" : [ "webhookIds" ] }, "AttachmentSettings" : { "properties" : { "enabled" : { "readOnly" : true, "description" : "Whether the ability to add attachments is enabled.", "type" : "boolean" }, "uploadLimit" : { "description" : "The maximum size of attachments permitted, in bytes.", "readOnly" : true, "format" : "int64", "type" : "integer" } }, "description" : "Details of the instance's attachment settings.", "additionalProperties" : false, "type" : "object" }, "UserDetails" : { "properties" : { "timeZone" : { "type" : "string", "description" : "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.", "readOnly" : true }, "self" : { "description" : "The URL of the user.", "readOnly" : true, "type" : "string" }, "avatarUrls" : { "allOf" : [ { "$ref" : "#/components/schemas/AvatarUrlsBean" } ], "readOnly" : true, "description" : "The avatars of the user." }, "active" : { "description" : "Whether the user is active.", "readOnly" : true, "type" : "boolean" }, "accountId" : { "type" : "string", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." }, "emailAddress" : { "description" : "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.", "readOnly" : true, "type" : "string" }, "name" : { "type" : "string", "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "readOnly" : true }, "accountType" : { "readOnly" : true, "description" : "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)", "type" : "string" }, "key" : { "type" : "string", "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "readOnly" : true }, "displayName" : { "type" : "string", "readOnly" : true, "description" : "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value." } }, "type" : "object", "additionalProperties" : false, "description" : "User details." }, "ScreenableTab" : { "additionalProperties" : false, "description" : "A screen tab.", "type" : "object", "properties" : { "name" : { "description" : "The name of the screen tab. Required on create and update. The maximum length is 255 characters.", "type" : "string" }, "id" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The ID of the screen tab." } }, "required" : [ "name" ] }, "Operations" : { "type" : "object", "additionalProperties" : true, "description" : "Details of the operations that can be performed on the issue.", "properties" : { "linkGroups" : { "items" : { "$ref" : "#/components/schemas/LinkGroup" }, "description" : "Details of the link groups defining issue operations.", "readOnly" : true, "type" : "array" } } }, "RemoteIssueLink" : { "type" : "object", "description" : "Details of an issue remote link.", "additionalProperties" : false, "properties" : { "object" : { "description" : "Details of the item linked to.", "allOf" : [ { "$ref" : "#/components/schemas/RemoteObject" } ] }, "globalId" : { "type" : "string", "description" : "The global ID of the link, such as the ID of the item on the remote system." }, "relationship" : { "type" : "string", "description" : "Description of the relationship between the issue and the linked item." }, "id" : { "type" : "integer", "description" : "The ID of the link.", "format" : "int64" }, "self" : { "format" : "uri", "description" : "The URL of the link.", "type" : "string" }, "application" : { "description" : "Details of the remote application the linked item is in.", "allOf" : [ { "$ref" : "#/components/schemas/Application" } ] } } }, "CreatedIssue" : { "type" : "object", "additionalProperties" : false, "description" : "Details about a created issue or subtask.", "properties" : { "key" : { "type" : "string", "readOnly" : true, "description" : "The key of the created issue or subtask." }, "transition" : { "readOnly" : true, "description" : "The response code and messages related to any requested transition.", "allOf" : [ { "$ref" : "#/components/schemas/NestedResponse" } ] }, "self" : { "type" : "string", "description" : "The URL of the created issue or subtask.", "readOnly" : true }, "id" : { "readOnly" : true, "description" : "The ID of the created issue or subtask.", "type" : "string" } } }, "HistoryMetadataParticipant" : { "properties" : { "url" : { "description" : "The URL of the user or system associated with a history record.", "type" : "string" }, "type" : { "type" : "string", "description" : "The type of the user or system associated with a history record." }, "avatarUrl" : { "type" : "string", "description" : "The URL to an avatar for the user or system associated with a history record." }, "displayName" : { "description" : "The display name of the user or system associated with a history record.", "type" : "string" }, "id" : { "description" : "The ID of the user or system associated with a history record.", "type" : "string" }, "displayNameKey" : { "description" : "The key of the display name of the user or system associated with a history record.", "type" : "string" } }, "additionalProperties" : true, "description" : "Details of user or system associated with a issue history metadata item.", "type" : "object" }, "UserPickerUser" : { "additionalProperties" : false, "description" : "A user found in a search.", "type" : "object", "properties" : { "displayName" : { "description" : "The display name of the user. Depending on the user’s privacy setting, this may be returned as null.", "type" : "string" }, "key" : { "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "type" : "string" }, "name" : { "type" : "string", "description" : "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, "avatarUrl" : { "type" : "string", "description" : "The avatar URL of the user.", "format" : "uri" }, "html" : { "description" : "The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag.", "type" : "string" }, "accountId" : { "type" : "string", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." } } }, "ProjectIdentifiers" : { "properties" : { "key" : { "readOnly" : true, "description" : "The key of the created project.", "type" : "string" }, "self" : { "description" : "The URL of the created project.", "readOnly" : true, "format" : "uri", "type" : "string" }, "id" : { "type" : "integer", "description" : "The ID of the created project.", "readOnly" : true, "format" : "int64" } }, "required" : [ "id", "key", "self" ], "additionalProperties" : false, "description" : "Identifiers for a project.", "type" : "object" }, "BulkProjectPermissions" : { "required" : [ "permissions" ], "properties" : { "issues" : { "description" : "List of issue IDs.", "items" : { "type" : "integer", "format" : "int64" }, "uniqueItems" : true, "type" : "array" }, "permissions" : { "uniqueItems" : true, "items" : { "type" : "string" }, "description" : "List of project permissions.", "type" : "array" }, "projects" : { "type" : "array", "description" : "List of project IDs.", "items" : { "type" : "integer", "format" : "int64" }, "uniqueItems" : true } }, "type" : "object", "additionalProperties" : false, "description" : "Details of project permissions and associated issues and projects to look up." }, "WorkflowScheme" : { "type" : "object", "description" : "Details about a workflow scheme.", "additionalProperties" : false, "properties" : { "lastModified" : { "readOnly" : true, "description" : "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.", "type" : "string" }, "name" : { "description" : "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.", "type" : "string" }, "description" : { "type" : "string", "description" : "The description of the workflow scheme." }, "lastModifiedUser" : { "description" : "The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/User" } ] }, "id" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The ID of the workflow scheme." }, "draft" : { "description" : "Indicates whether the workflow scheme is a draft or not.", "readOnly" : true, "type" : "boolean" }, "defaultWorkflow" : { "description" : "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*.", "type" : "string" }, "issueTypeMappings" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme." }, "originalDefaultWorkflow" : { "type" : "string", "readOnly" : true, "description" : "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira." }, "originalIssueTypeMappings" : { "additionalProperties" : { "type" : "string", "readOnly" : true }, "description" : "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.", "readOnly" : true, "type" : "object" }, "issueTypes" : { "description" : "The issue types available in Jira.", "additionalProperties" : { "$ref" : "#/components/schemas/IssueTypeBean" }, "readOnly" : true, "type" : "object" }, "self" : { "format" : "uri", "readOnly" : true, "type" : "string" }, "updateDraftIfNeeded" : { "description" : "Indicates whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`.", "type" : "boolean" } } }, "HealthCheckResult" : { "additionalProperties" : false, "description" : "Jira instance health check results. Deprecated and no longer returned.", "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the Jira health check item." }, "description" : { "type" : "string", "description" : "The description of the Jira health check item." }, "passed" : { "type" : "boolean", "description" : "Indicates whether the Jira health check item passed or failed." } } }, "Application" : { "type" : "object", "description" : "The application the linked item is in.", "additionalProperties" : true, "properties" : { "type" : { "type" : "string", "description" : "The name-spaced type of the application, used by registered rendering apps." }, "name" : { "description" : "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last.", "type" : "string" } } }, "FoundUsersAndGroups" : { "properties" : { "groups" : { "$ref" : "#/components/schemas/FoundGroups" }, "users" : { "$ref" : "#/components/schemas/FoundUsers" } }, "description" : "List of users and groups found in a search.", "additionalProperties" : false, "type" : "object" }, "ActorInputBean" : { "type" : "object", "additionalProperties" : false, "properties" : { "user" : { "description" : "The account IDs of the users to add as default actors. You can add multiple account IDs separated by a comma. For example, `\"user\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`.", "items" : { "type" : "string" }, "type" : "array" }, "group" : { "description" : "The name of the group to add as a default actor. You can add multiple groups separated with a comma. For example, `\"group\":[\"project-admin\", \"jira-developers\"]`.", "items" : { "type" : "string" }, "type" : "array" } } }, "AddGroupBean" : { "required" : [ "name" ], "properties" : { "name" : { "type" : "string", "description" : "The name of the group." } }, "type" : "object", "additionalProperties" : true }, "VersionUsageInCustomField" : { "type" : "object", "description" : "List of custom fields using the version.", "additionalProperties" : false, "properties" : { "issueCountWithVersionInCustomField" : { "readOnly" : true, "format" : "int64", "description" : "Count of the issues where the custom field contains the version.", "type" : "integer" }, "customFieldId" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "The ID of the custom field." }, "fieldName" : { "description" : "The name of the custom field.", "readOnly" : true, "type" : "string" } } }, "VersionUnresolvedIssuesCount" : { "type" : "object", "xml" : { "name" : "version" }, "additionalProperties" : false, "description" : "Count of a version's unresolved issues.", "properties" : { "issuesUnresolvedCount" : { "type" : "integer", "readOnly" : true, "format" : "int64", "description" : "Count of unresolved issues." }, "self" : { "format" : "uri", "readOnly" : true, "description" : "The URL of these count details.", "type" : "string" }, "issuesCount" : { "description" : "Count of issues.", "format" : "int64", "readOnly" : true, "type" : "integer" } } }, "IssueTypeBean" : { "additionalProperties" : false, "description" : "Details about an issue type.", "type" : "object", "properties" : { "self" : { "description" : "The URL of these issue type details.", "readOnly" : true, "type" : "string" }, "entityId" : { "type" : "string", "description" : "project unique ID for next-gen entities", "format" : "uuid", "readOnly" : true }, "avatarId" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The ID of the issue type's avatar." }, "id" : { "type" : "string", "readOnly" : true, "description" : "The ID of the issue type." }, "scope" : { "allOf" : [ { "$ref" : "#/components/schemas/Scope" } ], "readOnly" : true, "description" : "Details of the next-gen projects the issue type is available in." }, "name" : { "type" : "string", "readOnly" : true, "description" : "The name of the issue type." }, "subtask" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether this issue type is used to create subtasks." }, "description" : { "type" : "string", "readOnly" : true, "description" : "The description of the issue type." }, "iconUrl" : { "type" : "string", "description" : "The URL of the issue type's avatar.", "readOnly" : true } } }, "BulkProjectPermissionGrants" : { "type" : "object", "description" : "List of project permissions and the projects and issues those permissions grant access to.", "additionalProperties" : false, "required" : [ "issues", "permission", "projects" ], "properties" : { "permission" : { "type" : "string", "description" : "A project permission," }, "projects" : { "uniqueItems" : true, "items" : { "format" : "int64", "type" : "integer" }, "description" : "IDs of the projects the user has the permission for.", "type" : "array" }, "issues" : { "uniqueItems" : true, "items" : { "format" : "int64", "type" : "integer" }, "description" : "IDs of the issues the user has the permission for.", "type" : "array" } } }, "IssueFieldOptionCreateBean" : { "additionalProperties" : true, "type" : "object", "properties" : { "value" : { "description" : "The option's name, which is displayed in Jira.", "type" : "string" }, "properties" : { "description" : "The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.", "additionalProperties" : {}, "type" : "object" }, "config" : { "$ref" : "#/components/schemas/IssueFieldOptionConfiguration" } }, "required" : [ "value" ] }, "FoundGroup" : { "properties" : { "name" : { "type" : "string", "description" : "The name of the group." }, "labels" : { "items" : { "$ref" : "#/components/schemas/GroupLabel" }, "type" : "array" }, "html" : { "type" : "string", "description" : "The group name with the matched query string highlighted with the HTML bold tag." } }, "type" : "object", "xml" : { "name" : "group" }, "description" : "A group found in a search.", "additionalProperties" : false }, "AttachmentArchiveItemReadable" : { "properties" : { "mediaType" : { "type" : "string", "readOnly" : true, "description" : "The MIME type of the archive item." }, "label" : { "type" : "string", "description" : "The label for the archive item.", "readOnly" : true }, "path" : { "description" : "The path of the archive item.", "readOnly" : true, "type" : "string" }, "index" : { "type" : "integer", "format" : "int64", "readOnly" : true, "description" : "The position of the item within the archive." }, "size" : { "type" : "string", "description" : "The size of the archive item.", "readOnly" : true } }, "type" : "object", "description" : "Metadata for an item in an attachment archive.", "additionalProperties" : false }, "DefaultShareScope" : { "xml" : { "name" : "defaultShareScope" }, "type" : "object", "additionalProperties" : false, "description" : "Details of the scope of the default sharing for new filters and dashboards.", "required" : [ "scope" ], "properties" : { "scope" : { "enum" : [ "GLOBAL", "AUTHENTICATED", "PRIVATE" ], "type" : "string", "description" : "The scope of the default sharing for new filters and dashboards:\n\n * `AUTHENTICATED` Shared with all logged-in users.\n * `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n * `PRIVATE` Not shared with any users." } } }, "AddFieldBean" : { "required" : [ "fieldId" ], "properties" : { "fieldId" : { "type" : "string", "description" : "The ID of the field to add." } }, "type" : "object", "additionalProperties" : false }, "BulkPermissionsRequestBean" : { "properties" : { "projectPermissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BulkProjectPermissions" }, "uniqueItems" : true, "description" : "Project permissions with associated projects and issues to look up." }, "globalPermissions" : { "type" : "array", "items" : { "type" : "string" }, "description" : "Global permissions to look up.", "uniqueItems" : true } }, "description" : "Details of global permissions to look up and project permissions with associated projects and issues to look up.", "additionalProperties" : false, "type" : "object" }, "AttachmentArchiveEntry" : { "properties" : { "size" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "entryIndex" : { "format" : "int64", "type" : "integer" }, "abbreviatedName" : { "type" : "string" }, "mediaType" : { "type" : "string" } }, "type" : "object", "additionalProperties" : false }, "JqlQuery" : { "properties" : { "where" : { "$ref" : "#/components/schemas/JqlQueryClause" }, "orderBy" : { "$ref" : "#/components/schemas/JqlQueryOrderByClause" } }, "type" : "object", "additionalProperties" : false, "description" : "A parsed JQL query." }, "HierarchyOutputFragment" : { "properties" : { "hierarchy" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HierarchyLevelOutput" } }, "projectId" : { "format" : "int64", "type" : "integer" } }, "type" : "object", "additionalProperties" : false }, "SimpleLink" : { "type" : "object", "xml" : { "name" : "link" }, "additionalProperties" : false, "description" : "Details about the operations available in this version.", "properties" : { "href" : { "type" : "string" }, "weight" : { "type" : "integer", "format" : "int32" }, "title" : { "type" : "string" }, "label" : { "type" : "string" }, "id" : { "type" : "string" }, "styleClass" : { "type" : "string" }, "iconClass" : { "type" : "string" } } }, "VersionMoveBean" : { "properties" : { "position" : { "description" : "An absolute position in which to place the moved version. Cannot be used with `after`.", "type" : "string", "enum" : [ "Earlier", "Later", "First", "Last" ] }, "after" : { "type" : "string", "description" : "The URL (self link) of the version after which to place the moved version. Cannot be used with `position`.", "format" : "uri" } }, "additionalProperties" : false, "type" : "object", "xml" : { "name" : "version" } }, "UserBean" : { "properties" : { "accountId" : { "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "type" : "string" }, "self" : { "type" : "string", "description" : "The URL of the user.", "format" : "uri" }, "avatarUrls" : { "allOf" : [ { "$ref" : "#/components/schemas/UserBeanAvatarUrls" } ], "description" : "The avatars of the user." }, "name" : { "description" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.", "type" : "string" }, "key" : { "type" : "string", "description" : "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user." }, "displayName" : { "description" : "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.", "type" : "string" }, "active" : { "description" : "Indicates whether the user is active.", "type" : "boolean" } }, "type" : "object", "additionalProperties" : false }, "RemoteObject" : { "description" : "The linked item.", "additionalProperties" : true, "type" : "object", "properties" : { "url" : { "description" : "The URL of the item.", "type" : "string" }, "icon" : { "allOf" : [ { "$ref" : "#/components/schemas/Icon" } ], "description" : "Details of the icon for the item. If no icon is defined, the default link icon is used in Jira." }, "summary" : { "type" : "string", "description" : "The summary details of the item." }, "status" : { "description" : "The status of the item.", "allOf" : [ { "$ref" : "#/components/schemas/Status" } ] }, "title" : { "type" : "string", "description" : "The title of the item." } }, "required" : [ "title", "url" ] }, "FieldValueClause" : { "properties" : { "field" : { "$ref" : "#/components/schemas/JqlQueryField" }, "operator" : { "description" : "The operator between the field and operand.", "type" : "string", "enum" : [ "=", "!=", ">", "<", ">=", "<=", "in", "not in", null, "~=", "is", "is not" ] }, "operand" : { "$ref" : "#/components/schemas/JqlQueryClauseOperand" } }, "required" : [ "field", "operand", "operator" ], "description" : "A clause that asserts the current value of a field. For example, `summary ~ test`.", "type" : "object" }, "ProjectRoleActorsUpdateBean" : { "properties" : { "categorisedActors" : { "description" : "The actors to add to the project role. Add groups using `atlassian-group-role-actor` and a list of group names. For example, `\"atlassian-group-role-actor\":[\"another\",\"administrators\"]}`. Add users using `atlassian-user-role-actor` and a list of account IDs. For example, `\"atlassian-user-role-actor\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`.", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } }, "type" : "object" }, "id" : { "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "readOnly" : true, "format" : "int64", "type" : "integer" } }, "additionalProperties" : false, "xml" : { "name" : "actor" }, "type" : "object" }, "WorkflowStatusProperties" : { "properties" : { "issueEditable" : { "type" : "boolean", "description" : "Whether issues are editable in this status." } }, "required" : [ "issueEditable" ], "additionalProperties" : false, "description" : "Properties of a workflow status.", "type" : "object" }, "AutoCompleteSuggestion" : { "description" : "A field auto-complete suggestion.", "additionalProperties" : false, "type" : "object", "properties" : { "value" : { "type" : "string", "description" : "The value of a suggested item." }, "displayName" : { "description" : "The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag.", "type" : "string" } } }, "Comment" : { "type" : "object", "description" : "A comment.", "additionalProperties" : true, "properties" : { "updateAuthor" : { "description" : "The ID of the user who updated the comment last.", "readOnly" : true, "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ] }, "id" : { "type" : "string", "readOnly" : true, "description" : "The ID of the comment." }, "properties" : { "items" : { "$ref" : "#/components/schemas/EntityProperty" }, "description" : "A list of comment properties. Optional on create and update.", "type" : "array" }, "updated" : { "type" : "string", "format" : "date-time", "readOnly" : true, "description" : "The date and time at which the comment was updated last." }, "visibility" : { "allOf" : [ { "$ref" : "#/components/schemas/Visibility" } ], "description" : "The group or role to which this comment is visible. Optional on create and update." }, "body" : { "description" : "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)." }, "self" : { "readOnly" : true, "description" : "The URL of the comment.", "type" : "string" }, "renderedBody" : { "type" : "string", "readOnly" : true, "description" : "The rendered version of the comment." }, "jsdPublic" : { "type" : "boolean", "readOnly" : true, "description" : "Indicates whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation." }, "created" : { "description" : "The date and time at which the comment was created.", "readOnly" : true, "format" : "date-time", "type" : "string" }, "author" : { "allOf" : [ { "$ref" : "#/components/schemas/UserDetails" } ], "readOnly" : true, "description" : "The ID of the user who created the comment." } } }, "ApplicationProperty" : { "description" : "Details of an application property.", "additionalProperties" : false, "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The data type of the application property." }, "name" : { "type" : "string", "description" : "The name of the application property." }, "key" : { "description" : "The key of the application property. The ID and key are the same.", "type" : "string" }, "defaultValue" : { "type" : "string", "description" : "The default value of the application property." }, "desc" : { "type" : "string", "description" : "The description of the application property." }, "id" : { "type" : "string", "description" : "The ID of the application property. The ID and key are the same." }, "value" : { "type" : "string", "description" : "The new value." }, "example" : { "type" : "string" }, "allowedValues" : { "type" : "array", "description" : "The allowed values, if applicable.", "items" : { "type" : "string" } } } }, "CompoundClause" : { "description" : "A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, \"A OR B AND C\" is parsed as \"(A OR B) AND C\". See Setting the precedence of operators for more information about precedence in JQL queries.`", "type" : "object", "properties" : { "operator" : { "description" : "The operator between the clauses.", "type" : "string", "enum" : [ "and", "or", "not" ] }, "clauses" : { "type" : "array", "description" : "The list of nested clauses.", "items" : { "$ref" : "#/components/schemas/JqlQueryClause" } } }, "required" : [ "clauses", "operator" ] }, "Avatar" : { "type" : "object", "additionalProperties" : false, "description" : "Details of an avatar.", "properties" : { "id" : { "type" : "string", "description" : "The ID of the avatar. Required when setting the project avatar." }, "fileName" : { "type" : "string", "description" : "The file name of the avatar icon. Returned for system avatars.", "readOnly" : true }, "urls" : { "type" : "object", "readOnly" : true, "description" : "The list of avatar icon URLs.", "additionalProperties" : { "type" : "string", "readOnly" : true, "format" : "uri" } }, "isSystemAvatar" : { "description" : "Indicates whether the avatar is a system avatar.", "readOnly" : true, "type" : "boolean" }, "owner" : { "description" : "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the accountId for a user.", "readOnly" : true, "type" : "string" }, "isDeletable" : { "type" : "boolean", "description" : "Indicates whether the avatar can be deleted.", "readOnly" : true }, "isSelected" : { "type" : "boolean", "description" : "Indicates whether the avatar is used in Jira. For example, shown as a project's avatar.", "readOnly" : true } } }, "SearchResults" : { "description" : "The result of a JQL search.", "additionalProperties" : false, "type" : "object", "properties" : { "warningMessages" : { "readOnly" : true, "items" : { "type" : "string", "readOnly" : true }, "description" : "Any warnings related to the JQL query.", "type" : "array" }, "expand" : { "description" : "Expand options that include additional search result details in the response.", "readOnly" : true, "type" : "string" }, "startAt" : { "format" : "int32", "readOnly" : true, "description" : "The index of the first item returned on the page.", "type" : "integer" }, "names" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "readOnly" : true, "type" : "string" }, "description" : "The ID and name of each field in the search results." }, "schema" : { "type" : "object", "readOnly" : true, "description" : "The schema describing the field types in the search results.", "additionalProperties" : { "$ref" : "#/components/schemas/JsonTypeBean" } }, "maxResults" : { "format" : "int32", "readOnly" : true, "description" : "The maximum number of results that could be on the page.", "type" : "integer" }, "issues" : { "type" : "array", "readOnly" : true, "description" : "The list of issues found by the search.", "items" : { "$ref" : "#/components/schemas/IssueBean" } }, "total" : { "type" : "integer", "description" : "The number of results on the page.", "format" : "int32", "readOnly" : true } } } }, "securitySchemes" : { "basicAuth" : { "description" : "You can access this resource via basic auth.", "type" : "http", "scheme" : "basic" }, "OAuth2" : { "description" : "OAuth2 scopes for Jira", "flows" : { "authorizationCode" : { "tokenUrl" : "https://auth.atlassian.com/oauth/token", "authorizationUrl" : "https://auth.atlassian.com/authorize", "scopes" : { "read:jira-work" : "Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).", "manage:jira-project" : "Create and edit project settings and create new project-level objects, for example, versions, components.", "manage:jira-configuration" : "Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.", "write:jira-work" : "Create and edit issues in Jira, post comments, create worklogs, and delete issues.", "read:jira-user" : "View user information in Jira that you have access to, including usernames, email addresses, and avatars." } } }, "type" : "oauth2" } } }, "tags" : [ { "name" : "Application roles", "description" : "This resource represents application roles. Use it to get details of an application role or all application roles." }, { "name" : "Audit records", "description" : "This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records." }, { "name" : "Avatars", "description" : "This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars as well as add and remove avatars from a project or issue type." }, { "name" : "Dashboards", "description" : "This resource represents dashboards. Use it to obtain the details of dashboards as well as add and remove item properties from dashboards." }, { "description" : "This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.", "name" : "Filters" }, { "name" : "Filter sharing", "description" : "This resource represents options for sharing [filters](#api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters." }, { "name" : "Group and user picker", "description" : "This resource represents a list of users and a list of groups. Use it to obtain the details to populate user and group picker suggestions list." }, { "description" : "This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups.", "name" : "Groups" }, { "description" : "This resource represents Jira issues. Use it to:\n\n * create or edit issues, individually or in bulk.\n * retrieve metadata about the options for creating or editing issues.\n * delete an issue.\n * assign a user to an issue.\n * get issue changelogs.\n * send notifications about an issue.\n * get details of the transitions available for an issue.\n * transition an issue.", "name" : "Issues" }, { "name" : "Issue attachments", "description" : "This resource represents issue attachments and the attachment settings for Jira. Use it to get the metadata for an attachment, delete an attachment, and view the metadata for the contents of an attachment. Also, use it to get the attachment settings for Jira." }, { "name" : "Issue comments", "description" : "This resource represents issue comments. Used it to:\n\n * get, create, update, and delete a comment from an issue.\n * get all comments from issue.\n * get a list of comments by comment ID." }, { "description" : "This resource represents [issue comment](#api-group-Issue-comments) properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issue comment properties as well as obtain the keys of all properties on a comment. Comment properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).", "name" : "Issue comment properties" }, { "name" : "Issue fields", "description" : "This resource represents issue fields, both system and custom fields, including options on custom fields. Use it to get fields, create and update fields (custom fields only), and get an option from a custom field." }, { "name" : "Issue field options", "description" : "This resource represents the options for a select list issue field.\n\nA select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select an option from a list. Use this resource to add, remove, and update the options of a select list issue field.\n\nNote that this resource **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps." }, { "name" : "Issue links", "description" : "This resource represents links between issues. Use it to get, create, and delete links between issues.\n\nTo use this resource, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled." }, { "name" : "Issue link types", "description" : "This resource represents [issue link](#api-group-Issue-links) types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.\n\nTo use this resource, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled." }, { "name" : "Issue navigator settings", "description" : "This resource represents issue navigator settings. Use it to get and set issue navigator default columns." }, { "description" : "This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use this resource to get details of a notification scheme and a list of notification schemes.", "name" : "Issue notification schemes" }, { "name" : "Issue priorities", "description" : "This resource represents issue priorities. Use it to obtain a list of issue priorities and details for individual issue priorities." }, { "description" : "This resource represents [issue](#api-group-Issues) properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as obtain details of all properties on an issue. Operations to bulk update and delete issue properties are also provided. Issue properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).", "name" : "Issue properties" }, { "description" : "This resource represents remote issue links, a way of linking Jira to information in other systems. Use this resource to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier.", "name" : "Issue remote links" }, { "name" : "Issue resolutions", "description" : "This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values." }, { "name" : "Issue search", "description" : "This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker." }, { "name" : "Issue security level", "description" : "This resource represents issue security levels. Use it to obtain the details of any issue security level. For more information about issue security levels, see [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg)." }, { "description" : "This resource represents issue security schemes. Use it to get an issue security scheme or list of issues security schemes.\n\nIssue security schemes control which users or groups of users can view an issue. When an issue security scheme is associated with a project, its security levels can be applied to issues in that project. Sub-tasks also inherit the security level of their parent issue.", "name" : "Issue security schemes" }, { "name" : "Issue types", "description" : "This resource represents issues types. Use it to:\n\n * get, create, update, and delete issue types.\n * get all issue types for a user.\n * get alternative issue types.\n * set an avatar for an issue type." }, { "description" : "This resource represents issues type hierarchies. Use it to:\n\n * get the hierarchy.", "name" : "Issue type hierarchy" }, { "description" : "This resource represents [issue type](#api-group-Issue-types) properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).", "name" : "Issue type properties" }, { "name" : "Issue votes", "description" : "This resource represents votes cast by users on an issue. Use it to get details of votes on an issue as well as cast and withdrawal votes." }, { "name" : "Issue watchers", "description" : "This resource represents users watching an issue. Use it to get details of users watching an issue as well as start and stop a user watching an issue." }, { "name" : "Issue worklogs", "description" : "This resource represents issue worklogs. Use it to:\n\n * get, create, update, and delete worklogs.\n * obtain lists of updated or deleted worklogs." }, { "name" : "Issue worklog properties", "description" : "This resource represents [issue worklog](#api-group-Issue-worklogs) properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete issue worklog properties as well as obtain the keys of all properties on a issue worklog. Issue worklog properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "description" : "This resource is a collection of operations for [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).", "name" : "Jira expressions" }, { "name" : "Jira settings", "description" : "This resource represents various settings in Jira. Use it to get and update Jira settings and properties." }, { "description" : "This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom query builders. It also provides an operation to convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.", "name" : "JQL" }, { "name" : "Labels", "description" : "This resource represents available labels. Use it to get available labels for the global label field." }, { "name" : "Myself", "description" : "This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale." }, { "description" : "This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.", "name" : "Permissions" }, { "name" : "Permission schemes", "description" : "This resource represents permission schemes. Use it to get, create, update, and delete permission schemes as well as get, create, update, and delete details of the permissions granted in those schemes." }, { "name" : "Projects", "description" : "This resource represents projects. Use this resource to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type." }, { "name" : "Project avatars", "description" : "This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars." }, { "name" : "Project categories", "description" : "This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories. For more information on managing project categories, see [Adding, assigning, and deleting project categories](https://confluence.atlassian.com/x/-A5WMg)." }, { "description" : "This resource represents project components. Uses to get, create, update, and delete project components. Also get components for project and get a count of issues by component.", "name" : "Project components" }, { "name" : "Project key and name validation", "description" : "This resource provides validation for project keys and names." }, { "description" : "This resource represents permission schemes for a project. Use this resource to:\n\n * get details of a project's issue security levels available to the calling user.\n * get the permission scheme associated with the project or assign different permission scheme to the project.\n * get details of a project's issue security scheme.\n\nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes.", "name" : "Project permission schemes" }, { "description" : "This resource represents [project](#api-group-Projects) properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).", "name" : "Project properties" }, { "description" : "This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles.", "name" : "Project roles" }, { "name" : "Project role actors", "description" : "This resource represents the users assigned to [project roles](#api-group-Issue-comments). Use this resource to get, add, and remove default users from project roles. Also use this resource to add and remove users from a project role associated with a project." }, { "name" : "Project types", "description" : "This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type." }, { "description" : "This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by version.", "name" : "Project versions" }, { "description" : "This resource represents the screens used to record issue details. Use this resource to:\n\n * get details of all screens.\n * get details of all the fields available for use on screens.\n * add a field to the default screen.\n * get, create, update, move, and delete screen tabs.\n * get, add, move, and remove fields from screen tabs.", "name" : "Screens" }, { "description" : "This resource provides information about the Jira instance.", "name" : "Server info" }, { "description" : "This resource represents a [long-running asynchronous tasks](#async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task.", "name" : "Tasks" }, { "name" : "Time tracking", "description" : "This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking." }, { "description" : "This resource represent users. Use this resource to:\n\n * get, get a list of, create, and delete users.\n * get, set, and reset a user's default issue table columns.\n * get a list of the groups the user belongs to.\n * get a list of user account IDs for a list of usernames or user keys.", "name" : "Users" }, { "name" : "User properties", "description" : "This resource represents [user](#api-group-Users) properties, which provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a list of property keys for a user. User properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "description" : "This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. If you want to get a list of all users please use the https:///rest/api/3/users/search endpoint instead.", "name" : "User search" }, { "description" : "This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect apps can register webhooks. For more information, see [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps).", "name" : "Webhooks" }, { "name" : "Workflows", "description" : "This resource represents workflows. Use it to get a list of workflows." }, { "name" : "Workflow transition rules", "description" : "This resource represents workflow transition rules. Workflow transition rules define a Connect app routine, such as a [workflow post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) that is executed in association with the workflow. Use this resource to read and modify configuration of workflow transition rules." }, { "name" : "Workflow schemes", "description" : "This resource represents workflow schemes. Use this resource to manage workflow schemes and the workflow scheme's workflows and issue types.\n\nA workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.\n\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme).\n\nSee [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information." }, { "name" : "Workflow scheme project associations", "description" : "This resource represents the associations between workflow schemes and projects.\n\nFor more information, see [Managing your workflows](https://confluence.atlassian.com/x/q4hKLg)." }, { "description" : "This resource represents draft workflow schemes. Use this resource to manage drafts of workflow schemes.\n\nA workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.\n\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. Edting an active workflow scheme creates a draft copy of the scheme. The draft workflow scheme can then be edited and published (replacing the active scheme).\n\nSee [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information.", "name" : "Workflow scheme drafts" }, { "description" : "This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status.", "name" : "Workflow statuses" }, { "name" : "Workflow status categories", "description" : "This resource represents status categories. Use it to obtain a list of all status categories and the details of a category. Status categories provided a mechanism for categorizing [statuses](#api-group-Workflow-statuses)." }, { "description" : "This resource represents workflow transition properties, which provides for storing custom data against a workflow transition. Use it to get, create, and delete workflow transition properties as well as get a list of property keys for a workflow transition. Workflow transition properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).", "name" : "Workflow transition properties" }, { "description" : "This resource represents app properties. Use it to store arbitrary data for your\n[Connect app](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect).", "name" : "App properties" }, { "name" : "Dynamic modules", "description" : "This resource represents [modules registered dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)\nby [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect)." } ], "info" : { "contact" : { "email" : "ecosystem@atlassian.com" }, "license" : { "url" : "http://www.apache.org/licenses/LICENSE-2.0.html", "name" : "Apache 2.0" }, "title" : "The Jira Cloud platform REST API", "version" : "1001.0.0-SNAPSHOT", "termsOfService" : "http://atlassian.com/terms/", "description" : "Jira Cloud platform REST API documentation" }, "paths" : { "/api/3/issuetype" : { "post" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypeBean" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the request is invalid because:\n\n * no content is sent.\n * the issue type name exceeds 60 characters.\n * a subtask issue type is requested on an instance where subtasks are disabled." }, "409" : { "description" : "Returned if the issue type name is in use." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Creates an issue type and adds it to the default issue type scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.createIssueType_post", "summary" : "Create issue type", "tags" : [ "Issue types" ], "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "ADMIN", "requestBody" : { "content" : { "application/json" : { "example" : { "type" : "standard", "description" : "description", "name" : "name" }, "schema" : { "$ref" : "#/components/schemas/IssueTypeCreateBean" } } }, "required" : true } }, "get" : { "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue types" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all issue types.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Issue types are only returned as follows:\n\n * if the user has the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), all issue types are returned.\n * if the user has the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, the issue types associated with the projects the user has permission to browse are returned.", "responses" : { "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]", "schema" : { "items" : { "$ref" : "#/components/schemas/IssueTypeBean" }, "type" : "array" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.getIssueAllTypes_get", "summary" : "Get all issue types for user" } }, "/api/3/version/{id}/move" : { "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.moveVersion_post", "summary" : "Move version", "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"overdue\":true,\"userReleaseDate\":\"6/Jul/2010\",\"projectId\":10000}", "schema" : { "$ref" : "#/components/schemas/Version" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if:\n\n * the authentication credentials are incorrect or missing\n * the user does not have the required commissions." }, "404" : { "description" : "Returned if the version or move after version are not found." }, "400" : { "description" : "Returned if:\n\n * no body parameters are provided.\n * `after` and `position` are provided.\n * `position` is invalid." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Modifies the version's sequence within the project, which affects the display order of the versions in Jira.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version.", "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "after" : "http://your-domain.atlassian.net/rest/api/~ver~/version/10000" }, "schema" : { "$ref" : "#/components/schemas/VersionMoveBean" } } } }, "tags" : [ "Project versions" ], "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "id", "description" : "The ID of the version to be moved." } ], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN" } }, "/api/3/projectvalidate/key" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectValidateResource.validateProjectKey_get", "summary" : "Validate project key", "security" : [ { "basicAuth" : [] } ], "description" : "Validates a project key by confirming the key is a valid string and not in use.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "200" : { "content" : { "application/json" : { "example" : "{\"errorMessages\":[],\"errors\":{\"projectKey\":\"A project with that project key already exists.\"}}", "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the request is successful." } }, "parameters" : [ { "in" : "query", "schema" : { "type" : "string", "example" : "HSP" }, "x-showInExample" : "true", "description" : "The project key.", "name" : "key" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Project key and name validation" ] } }, "/api/3/groups/picker" : { "get" : { "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"header\":\"Showing 20 of 25 matching groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"jdog-developers\"},{\"name\":\"juvenal-bot\",\"html\":\"juvenal-bot\"}]}", "schema" : { "$ref" : "#/components/schemas/FoundGroups" } } }, "description" : "Returned if the request is successful." } }, "description" : "Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results.\n\nThe primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the `html` field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically *Showing X of Y matching groups*.\n\nThe list returns with the groups sorted. If no groups match the list criteria, an empty list is returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Anonymous calls and calls by users without the required permission return an empty list.", "security" : [ { "basicAuth" : [] }, {} ], "summary" : "Find groups", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupPickerResource.findGroups_get", "tags" : [ "Groups" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "description" : "This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get).", "name" : "accountId" }, { "schema" : { "example" : "query", "type" : "string" }, "in" : "query", "name" : "query", "description" : "The string to find in group names." }, { "name" : "exclude", "description" : "A group to exclude from the result. To exclude multiple groups, provide multiple copies of this parameter. For example, `exclude=group1&exclude=group2`.", "in" : "query", "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "name" : "maxResults", "description" : "The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property `jira.ajax.autocomplete.limit`.", "schema" : { "type" : "integer", "format" : "int32" }, "in" : "query" }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "userName", "in" : "query", "schema" : { "type" : "string" } } ] } }, "/api/3/user/email" : { "get" : { "responses" : { "400" : { "description" : "Returned if the calling app is not approved to use this API." }, "503" : { "description" : "Indicates the API is not currently enabled" }, "404" : { "description" : "Returned if a user with the given `accountId` doesn't exist" }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnrestrictedUserEmail" }, "example" : "name@example.com" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing from the request (for example if a user is trying to access this API)." } }, "description" : "Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).", "security" : [ { "basicAuth" : [] } ], "summary" : "Get user email", "operationId" : "com.atlassian.jira.rest.v2.user.UnrestrictedUserEmailResource.getUserEmail_get", "tags" : [ "Users" ], "x-atlassian-connect-scope" : "ACCESS_EMAIL_ADDRESSES", "deprecated" : false, "parameters" : [ { "name" : "accountId", "description" : "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value). Required.", "in" : "query", "required" : true, "schema" : { "type" : "string" } } ], "x-experimental" : true } }, "/api/3/project" : { "get" : { "description" : "Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-rest-api-3-project-search-get) that supports search and pagination.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Project" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}]" } }, "description" : "Returned if the request is successful." } }, "summary" : "Get all projects", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getAllProjects_get", "x-atlassian-connect-scope" : "READ", "parameters" : [ { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `description` Returns the project description.\n * `issueTypes` Returns all issue types associated with the project.\n * `lead` Returns information about the the project lead.\n * `projectKeys` Returns all project keys associated with the project.", "name" : "expand" }, { "name" : "recent", "description" : "Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session.", "in" : "query", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "name" : "properties", "description" : "A comma-separated list of project properties to return for the project." } ], "deprecated" : true, "tags" : [ "Projects" ] }, "post" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "201" : { "description" : "Returned if the project is created.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectIdentifiers" }, "example" : "{\"self\":\"http://example/jira/rest/api/3/project/10042\",\"id\":10010,\"key\":\"EX\"}" } } }, "400" : { "description" : "Returned if the request is not valid and the project could not be created." }, "403" : { "description" : "Returned if the user does not have permission to create projects." } }, "description" : "Creates a project based on a project type template, as shown in the following table:\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Project Type KeyProject Template Key
businesscom.atlassian.jira-core-project-templates:jira-core-simplified-content-management, com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval, com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking, com.atlassian.jira-core-project-templates:jira-core-simplified-process-control, com.atlassian.jira-core-project-templates:jira-core-simplified-procurement, com.atlassian.jira-core-project-templates:jira-core-simplified-project-management, com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment, com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking
service_deskcom.atlassian.servicedesk:simplified-it-service-desk, com.atlassian.servicedesk:simplified-internal-service-desk, com.atlassian.servicedesk:simplified-external-service-desk
softwarecom.pyxis.greenhopper.jira:gh-simplified-agility-kanban, com.pyxis.greenhopper.jira:gh-simplified-agility-scrum, com.pyxis.greenhopper.jira:gh-simplified-basic, com.pyxis.greenhopper.jira:gh-simplified-kanban-classic, com.pyxis.greenhopper.jira:gh-simplified-scrum-classic
\n\nThe project types are available according to the installed Jira features as follows:\n\n * Jira Core, the default, enables `business` projects.\n * Jira Service Desk enables `service_desk` projects.\n * Jira Software enables `software` projects.\n\nTo determine which features are installed, go to **Jira settings** > **Apps** > **Manage apps** and review the System Apps list. To add JIRA Software or JIRA Service Desk into a JIRA instance, use **Jira settings** > **Apps** > **Finding new apps**. For more information, see [ Managing add-ons](https://confluence.atlassian.com/x/S31NLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "summary" : "Create project", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.createProject_post", "tags" : [ "Projects" ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "parameters" : [], "deprecated" : false, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectInputBean" }, "example" : { "projectTypeKey" : "business", "categoryId" : 10120, "url" : "http://atlassian.com", "description" : "Example Project description", "key" : "EX", "name" : "Example", "permissionScheme" : 10011, "notificationScheme" : 10021, "assigneeType" : "PROJECT_LEAD", "projectTemplateKey" : "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control", "issueSecurityScheme" : 10001, "lead" : "Charlie", "avatarId" : 10200 } } }, "description" : "The JSON representation of the project being created." } } }, "/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectIssueSecurityLevelSchemeResource.getIssueSecurityScheme_get", "summary" : "Get project issue security scheme", "responses" : { "403" : { "description" : "Returned if the project is visible to the user but the user doesn't have administrative permissions." }, "400" : { "description" : "Returned if the request is invalid." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000\",\"id\":10000,\"name\":\"Default Issue Security Scheme\",\"description\":\"Description for the default issue security scheme\",\"defaultSecurityLevelId\":10021,\"levels\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"}]}", "schema" : { "$ref" : "#/components/schemas/SecurityScheme" } } }, "description" : "Returned if the request is successful." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg) associated with the project.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or the *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).", "tags" : [ "Project permission schemes" ], "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The project ID or project key (case sensitive).", "name" : "projectKeyOrId" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ" } }, "/api/3/issue/{issueIdOrKey}/editmeta" : { "get" : { "responses" : { "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"fields\":{\"summary\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"}}}", "schema" : { "$ref" : "#/components/schemas/IssueUpdateMetadata" } } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user uses an override parameter but doesn't have permission to do so." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in [Edit issue](#api-rest-api-3-issue-issueIdOrKey-put).\n\nConnect app users with admin permissions (from user permissions and app scopes) can return additional details using:\n\n * `overrideScreenSecurity` Returns hidden fields.\n * `overrideEditableFlag` Returns uneditable fields. For example, where an issue has a workflow status of closed none of its fields are editable.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\nNote: For any fields to be editable the user must have the *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getEditIssueMeta_get", "summary" : "Get edit issue metadata", "tags" : [ "Issues" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" }, { "name" : "overrideScreenSecurity", "description" : "Indicates whether hidden fields should be returned. Available to connect app users with admin permissions.", "in" : "query", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Indicates whether non-editable fields should be returned. Available to connect app users with admin permissions.", "name" : "overrideEditableFlag", "schema" : { "type" : "boolean", "default" : false }, "in" : "query" } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/filter/{id}" : { "delete" : { "parameters" : [ { "name" : "id", "description" : "The ID of the filter to delete.", "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true } ], "deprecated" : false, "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Filters" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Delete a filter.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "401" : { "description" : "Returned if the user does not have permission to delete the filter." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the filter is not found." } }, "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.deleteFilter_delete", "summary" : "Delete filter" }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getFilter_get", "summary" : "Get filter", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a filter.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, the filter is only returned where it is:\n\n * owned by the user.\n * shared with a group that the user is a member of.\n * shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * shared with a public project.\n * shared with the public.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}", "schema" : { "$ref" : "#/components/schemas/Filter" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the filter is not found or the user does not have permission to view it." } }, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "The ID of the filter to return.", "name" : "id" }, { "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`.", "name" : "expand", "schema" : { "type" : "string" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Filters" ] }, "put" : { "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Filter" }, "example" : { "description" : "Lists all open bugs", "name" : "All Open Bugs", "jql" : "type = Bug and resolution is empty" } } }, "description" : "The filter to update.", "required" : true }, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the filter to update.", "name" : "id" }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`.", "schema" : { "type" : "string" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Filters" ], "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.updateFilter_put", "summary" : "Update filter", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however the user must own the filter.", "responses" : { "400" : { "description" : "Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Filter" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}" } } } } } }, "/api/3/settings/columns" : { "get" : { "tags" : [ "Issue navigator settings" ], "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.admin.SettingsResource.getIssueNavigatorDefaultColumns_get", "summary" : "Get issue navigator default columns", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "[{\"label\":\"Key\",\"value\":\"issuekey\"},{\"label\":\"Summary\",\"value\":\"summary\"}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnItem" } } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns the default issue navigator columns.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, "put" : { "requestBody" : { "description" : "A navigable field value.", "content" : { "multipart/form-data" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "tags" : [ "Issue navigator settings" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.admin.SettingsResource.setIssueNavigatorDefaultColumns_put", "summary" : "Set issue navigator default columns", "responses" : { "404" : { "description" : "Returned if a navigable field value is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if invalid parameters are passed." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Sets the default issue navigator columns.\n\nThe `columns` parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple `columns` parameters. For example, in curl:\n\n`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns`\n\nIf no column details are sent, then all default columns are removed.\n\nA navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using [Get fields](#api-rest-api-3-field-get).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } }, "/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}" : { "delete" : { "summary" : "Remove screen tab field", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.removeScreenTabField_delete", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the screen, screen tab, or field is not found." }, "400" : { "description" : "Returned if the request is invalid." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "description" : "Removes a field from a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, {} ], "tags" : [ "Screens" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "name" : "screenId", "description" : "The ID of the screen.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true }, { "description" : "The ID of the screen tab.", "name" : "tabId", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" }, { "description" : "The ID of the field.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false } }, "/api/3/component/{id}" : { "delete" : { "responses" : { "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the component is not found.\n * the replacement component is not found.\n * the user does not have permission to browse the project containing the component." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Deletes a component.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.ComponentResource.deleteComponent_delete", "summary" : "Delete component", "tags" : [ "Project components" ], "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the component.", "name" : "id" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "moveIssuesTo", "description" : "The ID of the component to replace the deleted component. If this value is null no replacement is made." } ], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN" }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ComponentResource.getComponent_get", "summary" : "Get component", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a component.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for project containing the component.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}", "schema" : { "$ref" : "#/components/schemas/Component" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the component is not found or the user does not have permission to browse the project containing the component." } }, "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the component.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Project components" ] }, "put" : { "tags" : [ "Project components" ], "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the component.", "name" : "id" } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component" }, "example" : { "assigneeType" : "PROJECT_LEAD", "leadAccountId" : "5b10a2844c20165700ede21g", "description" : "This is a Jira component", "isAssigneeTypeValid" : false, "name" : "Component 1" } } }, "required" : true }, "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}", "schema" : { "$ref" : "#/components/schemas/Component" } } } }, "404" : { "description" : "Returned if the component is not found or the user does not have permission to browse the project containing the component." }, "400" : { "description" : "Returned if:\n\n * the user is not found.\n * `assigneeType` is an invalid value.\n * `name` is over 255 characters in length." }, "403" : { "description" : "Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Updates a component. Any fields included in the request are overwritten. If `leadAccountId` is an empty string (\"\") the component lead is removed.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the component or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.ComponentResource.updateComponent_put", "summary" : "Update component" } }, "/api/3/permissions/project" : { "post" : { "x-experimental" : true, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionsKeysBean" } } }, "required" : true }, "tags" : [ "Permissions" ], "x-atlassian-connect-scope" : "READ", "parameters" : [], "deprecated" : false, "summary" : "Get permitted projects", "operationId" : "com.atlassian.jira.rest.v2.permission.PermissionsResource.getPermittedProjects_post", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"projects\":[{\"id\":10000,\"key\":\"DEMO\"},{\"id\":10101,\"key\":\"TEST\"}]}", "schema" : { "$ref" : "#/components/schemas/PermittedProjects" } } } }, "400" : { "description" : "Returned if a project permission is not found.", "content" : { "application/json" : { "example" : "{\"errorMessages\":[\"Could not find permission with key: NOT_EXISTING_PERMISSION_KEY\"],\"errors\":{}}" } } } }, "description" : "Returns all the projects where the user is granted a list of project permissions.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [] }, {} ] } }, "/api/3/issue/{issueIdOrKey}/remotelink/{linkId}" : { "put" : { "responses" : { "403" : { "description" : "Returned if the user does not have permission to link issues." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if:\n\n * the link ID is invalid.\n * the remote issue link does not belong to the issue.\n * the request body is invalid.", "content" : { "application/json" : { "example" : "{\"errorMessages\":[],\"errors\":{\"title\":\"'title' is required.\"}}" } } }, "404" : { "description" : "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Updates a remote issue link for an issue.\n\nNote: Fields without values in the request are set to null.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.updateRemoteIssueLink_put", "summary" : "Update remote issue link by ID", "tags" : [ "Issue remote links" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string", "example" : "10000" }, "in" : "path", "required" : true, "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "x-showInExample" : "true" }, { "description" : "The ID of the remote issue link.", "name" : "linkId", "x-showInExample" : "true", "schema" : { "example" : "10000", "type" : "string" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "WRITE", "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RemoteIssueLinkRequest" }, "example" : { "application" : { "name" : "My Acme Tracker", "type" : "com.acme.tracker" }, "relationship" : "causes", "globalId" : "system=http://www.mycompany.com/support&id=1", "object" : { "url" : "http://www.mycompany.com/support?id=1", "title" : "TSTSUP-111", "status" : { "icon" : { "url16x16" : "http://www.mycompany.com/support/resolved.png", "link" : "http://www.mycompany.com/support?id=1&details=closed", "title" : "Case Closed" }, "resolved" : true }, "icon" : { "url16x16" : "http://www.mycompany.com/support/ticket.png", "title" : "Support Ticket" }, "summary" : "Customer support issue" } } } } } }, "get" : { "tags" : [ "Issue remote links" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "x-showInExample" : "true", "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "example" : "10000", "type" : "string" } }, { "schema" : { "example" : "10000", "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the remote issue link.", "name" : "linkId", "x-showInExample" : "true" } ], "deprecated" : false, "responses" : { "404" : { "description" : "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RemoteIssueLink" }, "example" : "{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000\",\"globalId\":\"system=http://www.mycompany.com/support&id=1\",\"application\":{\"type\":\"com.acme.tracker\",\"name\":\"My Acme Tracker\"},\"relationship\":\"causes\",\"object\":{\"url\":\"http://www.mycompany.com/support?id=1\",\"title\":\"TSTSUP-111\",\"summary\":\"Customer support issue\",\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/ticket.png\",\"title\":\"Support Ticket\"},\"status\":{\"resolved\":true,\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/resolved.png\",\"title\":\"Case Closed\",\"link\":\"http://www.mycompany.com/support?id=1&details=closed\"}}}}" } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if issue linking is disabled." }, "400" : { "description" : "Returned if the link ID is invalid or the remote issue link does not belong to the issue." } }, "description" : "Returns a remote issue link for an issue.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get remote issue link by ID", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getRemoteIssueLinkById_get" }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.deleteRemoteIssueLinkById_delete", "summary" : "Delete remote issue link by ID", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes a remote issue link from an issue.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects*, *Edit issues*, and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "responses" : { "403" : { "description" : "Returned if the user does not have permission to link issues." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the link ID is invalid or the remote issue link does not belong to the issue." }, "404" : { "description" : "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "deprecated" : false, "parameters" : [ { "x-showInExample" : "true", "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "example" : "10000", "type" : "string" } }, { "schema" : { "example" : "10000", "type" : "string" }, "in" : "path", "required" : true, "name" : "linkId", "description" : "The ID of a remote issue link.", "x-showInExample" : "true" } ], "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Issue remote links" ] } }, "/api/3/application-properties/{id}" : { "put" : { "security" : [ { "basicAuth" : [] } ], "description" : "Changes the value of an application property. For example, you can change the value of the `jira.clone.prefix` from its default value of *CLONE -* to *Clone -* if you prefer sentence case capitalization. Editable properties are described below along with their default values.\n\n#### Advanced settings ####\n\nThe advanced settings below are also accessible in [Jira](https://confluence.atlassian.com/x/vYXKM).\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
KeyDescriptionDefault value
jira.clone.prefixA string of text that automatically precedes the title of a cloned issue.CLONE -
jira.date.picker.java.formatThe date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting.d/MMM/yy
jira.date.picker.javascript.formatThis date format is for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting.%e/%b/%y
jira.date.time.picker.java.formatThe date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting.dd/MMM/yy h:mm a
jira.date.time.picker.javascript.formatThis date format is for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting.%e/%b/%y %I:%M %p
jira.issue.actions.orderThe default order of actions (such as Comments or Change history) displayed on the issue view.asc
jira.table.cols.subtasksThe columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.issuetype, status, assignee, progress
jira.view.issue.links.sort.orderThe sort order of the list of issue links on the issue view.type, status, priority
jira.comment.collapsing.minimum.hiddenThe minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing.4
jira.newsletter.tip.delay.daysThe number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this functionality.7
\n\n#### Look and feel ####\n\nThe settings listed below adjust the [look and feel](https://confluence.atlassian.com/x/VwCLLg).\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
KeyDescriptionDefault value
jira.lf.date.timeLook and feel of the time format.h:mm a
jira.lf.date.dayLook and feel of the day format.EEEE h:mm a
jira.lf.date.completeLook and feel of the date and time format.dd/MMM/yy h:mm a
jira.lf.date.dmyLook and feel of the date format.dd/MMM/yy
jira.date.time.picker.use.iso8061When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.false
jira.lf.logo.urlThe URL of the logo image file./images/icon-jira-logo.png
jira.lf.logo.show.application.titleControls the visibility of the application title on the sidebar.false
jira.lf.favicon.urlThe URL of the favicon./favicon.ico
jira.lf.favicon.hires.urlThe URL of the high resolution favicon./images/64jira.png
jira.lf.top.adg3.bgcolourThe background color of the sidebar.#0747A6
jira.lf.top.adg3.textcolourThe color of the text and logo of the sidebar.#DEEBFF
jira.lf.hero.button.base.bg.colour#3b7fc4
jira.titleThe text for the application title. The application title can also be set in General settings.Jira
jira.option.globalsharingbooleantrue
xflow.product.suggestions.enabledIndicates whether to expose product suggestions for other Atlassian products within Jira.true
\n\n#### Other settings ####\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
KeyDescriptionDefault value
jira.issuenav.criteria.autoupdateSupports instant updates to search criteria.true
\n\n*Note: Be careful when changing [application properties and advanced settings](https://confluence.atlassian.com/x/vYXKM).*\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationProperty" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the property is not found or the user does not have permission to view it." }, "403" : { "description" : "Returned if the user does not have permission to edit the property." }, "400" : { "description" : "Returned if the data type of the `value` does not match the application property's data type. For example, a string is provided instead of an integer." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource.setApplicationProperty_put", "summary" : "Set application property", "parameters" : [ { "description" : "The key of the application property to update.", "name" : "id", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Jira settings" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SimpleApplicationPropertyBean" }, "example" : { "value" : "/var/jira/jira-home", "id" : "jira.home" } } } } } }, "/api/3/user/assignable/multiProjectSearch" : { "get" : { "description" : "Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "responses" : { "400" : { "description" : "Returned if:\n\n * `projectKeys` is missing.\n * neither of `query` or `accountId` are provided.\n * both `query` and `accountId` are provided." }, "404" : { "description" : "Returned if one or more of the projects is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5\",\"key\":\"\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32\"},\"displayName\":\"Emma Richards\",\"active\":false}]" } }, "description" : "Returned if the request is successful." } }, "summary" : "Find users assignable to projects", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.findBulkAssignableUsers_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "query", "description" : "A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` is specified.", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "query" }, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username" }, { "name" : "accountId", "description" : "A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless `query` is specified.", "schema" : { "type" : "string" }, "in" : "query" }, { "description" : "A comma-separated list of project keys (case sensitive).", "name" : "projectKeys", "schema" : { "type" : "string" }, "required" : true, "in" : "query" }, { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "in" : "query", "schema" : { "format" : "int32", "type" : "integer", "default" : 0 } }, { "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `1000`." } ], "tags" : [ "User search" ] } }, "/api/3/issue/{issueIdOrKey}/watchers" : { "post" : { "requestBody" : { "description" : "The account ID of the user. Note that username cannot be used due to privacy changes.", "content" : { "application/json" : { "schema" : { "type" : "string" } } }, "required" : true }, "tags" : [ "Issue watchers" ], "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" } ], "deprecated" : false, "summary" : "Add watcher", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.addWatcher_post", "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the permission to manage the watcher list." }, "204" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if the issue or the user is not found or the user does not have permission to view the issue." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Adds a user as a watcher of an issue by passing the account ID of the user. For example, `\"5b10ac8d82e05b22cc7d4ef5\"`. If no user is specified the calling user is added.\n\nThis operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * To add users other than themselves to the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ] }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.removeWatcher_delete", "summary" : "Delete watcher", "responses" : { "404" : { "description" : "Returned if the issue or the user is not found or the user does not have permission to view the issue." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have the permission to manage the watcher list." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if `accountId` is not supplied." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes a user as a watcher of an issue.\n\nThis operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * To remove users other than themselves from the watchlist, *Manage watcher list* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.", "tags" : [ "Issue watchers" ], "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "schema" : { "type" : "string" }, "in" : "query" }, { "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "DELETE" }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getIssueWatchers_get", "summary" : "Get issue watchers", "responses" : { "200" : { "description" : "Returned if the request is successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Watchers" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the watchers for an issue.\n\nThis operation requires the **Allow users to watch issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * To see details of users on the watchlist other than themselves, *View voters and watchers* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.", "tags" : [ "Issue watchers" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/screens/{screenId}/tabs" : { "post" : { "description" : "Creates a tab for a screen.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the screen is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenableTab" }, "example" : "{\"id\":10000,\"name\":\"Fields Tab\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "summary" : "Create screen tab", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.addScreenTab_post", "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "name" : "screenId", "description" : "The ID of the screen.", "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true } ], "deprecated" : false, "tags" : [ "Screens" ], "requestBody" : { "content" : { "application/json" : { "example" : { "name" : "Fields Tab" }, "schema" : { "$ref" : "#/components/schemas/ScreenableTab" } } }, "required" : true } }, "get" : { "tags" : [ "Screens" ], "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "name" : "screenId", "description" : "The ID of the screen.", "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" } }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "projectKey", "description" : "The key of the project." } ], "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if the screen ID is invalid." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ScreenableTab" }, "type" : "array" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the screen is not found." } }, "description" : "Returns the list of tabs for a screen.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "summary" : "Get all screen tabs", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.getAllScreenTabs_get" } }, "/api/3/version/{id}/relatedIssueCounts" : { "get" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VersionIssueCounts" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"issuesFixedCount\":23,\"issuesAffectedCount\":101,\"issueCountWithCustomFieldsShowingVersion\":54,\"customFieldUsage\":[{\"fieldName\":\"Field1\",\"customFieldId\":10000,\"issueCountWithVersionInCustomField\":2},{\"fieldName\":\"Field2\",\"customFieldId\":10010,\"issueCountWithVersionInCustomField\":3}]}" } } }, "404" : { "description" : "Returned if:\n\n * the version is not found.\n * the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the following counts for a version:\n\n * Number of issues where the `fixVersion` is set to the version.\n * Number of issues where the `affectedVersion` is set to the version.\n * Number of issues where a version custom field is set to the version.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version.", "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.getVersionRelatedIssues_get", "summary" : "Get version's related issues count", "tags" : [ "Project versions" ], "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the version." } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ" } }, "/api/3/group/member" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.GroupResource.getUsersFromGroup_get", "summary" : "Get users from group", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Returns all users in a group.\n\nNote that users are ordered by username, however the username is not returned in the results due to privacy reasons.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if the calling user does not have the Administer Jira global permission." }, "400" : { "description" : "Returned if the group name is not specified." }, "404" : { "description" : "Returned if the group is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanUserDetails" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/group/member?groupname=jira-administrators&includeInactiveUsers=false&startAt=2&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/group/member?groupname=jira-administrators&includeInactiveUsers=false&startAt=4&maxResults=2\",\"maxResults\":2,\"startAt\":3,\"total\":5,\"isLast\":false,\"values\":[{\"self\":\"http://example/jira/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"name\":\"\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{},\"displayName\":\"Mia\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"accountType\":\"atlassian\"},{\"self\":\"http://example/jira/rest/api/3/user?accountId=5b10a0effa615349cb016cd8\",\"name\":\"\",\"key\":\"\",\"accountId\":\"5b10a0effa615349cb016cd8\",\"emailAddress\":\"will@example.com\",\"avatarUrls\":{},\"displayName\":\"Will\",\"active\":false,\"timeZone\":\"Australia/Sydney\",\"accountType\":\"atlassian\"}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "deprecated" : false, "parameters" : [ { "required" : true, "in" : "query", "schema" : { "type" : "string" }, "description" : "The name of the group.", "name" : "groupname" }, { "description" : "Include inactive users.", "name" : "includeInactiveUsers", "schema" : { "type" : "boolean", "default" : false }, "in" : "query" }, { "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" }, "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "schema" : { "format" : "int32", "type" : "integer", "default" : 50 }, "in" : "query", "description" : "The maximum number of items to return per page. The maximum is `50`.", "name" : "maxResults" } ], "x-atlassian-connect-scope" : "ADMIN", "tags" : [ "Groups" ] } }, "/api/3/status/{idOrName}" : { "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a status. The status must be associated with a workflow to be returned.\n\nIf a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.\n\nThis operation can be accessed anonymously.\n\n[Permissions](#permissions) required: None.", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StatusDetails" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the status is not found.\n * the status is not associated with a workflow.\n * the user does not have the required permissions." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.StatusResource.getStatus_get", "summary" : "Get status", "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID or name of the status.", "name" : "idOrName" } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Workflow statuses" ] } }, "/api/3/workflowscheme/{id}/default" : { "delete" : { "tags" : [ "Workflow schemes" ], "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the workflow scheme.", "name" : "id" }, { "name" : "updateDraftIfNeeded", "description" : "Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to `false`.", "schema" : { "type" : "boolean" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "responses" : { "404" : { "description" : "Returned if the workflow scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } } }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "400" : { "description" : "Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).\n\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteDefaultWorkflow_delete", "summary" : "Delete default workflow" }, "get" : { "summary" : "Get default workflow", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getDefaultWorkflow_get", "responses" : { "403" : { "description" : "Returned if the user is not permitted to access workflows." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DefaultWorkflow" }, "example" : "{\"workflow\":\"jira\"}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the workflow scheme is not found." } }, "description" : "Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "tags" : [ "Workflow schemes" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "description" : "The ID of the workflow scheme.", "name" : "id", "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" } }, { "in" : "query", "schema" : { "default" : false, "type" : "boolean" }, "name" : "returnDraftIfExists", "description" : "Set to `true` to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned." } ], "deprecated" : false }, "put" : { "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.updateDefaultWorkflow_put", "summary" : "Update default workflow", "security" : [ { "basicAuth" : [] } ], "description" : "Sets the default workflow for a workflow scheme.\n\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "404" : { "description" : "Returned if the workflow scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`." }, "403" : { "description" : "Returned if the user is not permitted to create workflows." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "workflow" : "jira", "updateDraftIfNeeded" : false }, "schema" : { "$ref" : "#/components/schemas/DefaultWorkflow" } } }, "description" : "The new default workflow." }, "deprecated" : false, "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path", "description" : "The ID of the workflow scheme.", "name" : "id" } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow schemes" ] } }, "/api/3/dashboard" : { "get" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageOfDashboards" }, "example" : "{\"startAt\":10,\"maxResults\":10,\"total\":143,\"prev\":\"http://your-domain.atlassian.net/rest/api/3/dashboard?startAt=0\",\"next\":\"http://your-domain.atlassian.net/rest/api/3/dashboard?startAt=10\",\"dashboards\":[{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"http://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"},{\"id\":\"20000\",\"isFavourite\":true,\"name\":\"Build Engineering\",\"owner\":{\"key\":\"Mia\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"name\":\"mia\",\"displayName\":\"Mia Krystof\",\"avatarUrls\":{\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\",\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\"}},\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/20000\",\"sharePermissions\":[{\"id\":10105,\"type\":\"group\",\"group\":{\"name\":\"administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=administrators\"}}],\"view\":\"http://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=20000\"}]}" } } }, "400" : { "description" : "Returned if the request is invalid." } }, "description" : "Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, {} ], "summary" : "Get all dashboards", "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardResource.getAllDashboards_get", "tags" : [ "Dashboards" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "name" : "filter", "description" : "The filter applied to the list of dashboards. Valid values are:\n\n * `favourite` Returns dashboards the user has marked as favorite.\n * `my` Returns dashboards owned by the user.", "in" : "query", "schema" : { "type" : "string", "enum" : [ "my", "favourite" ] } }, { "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt", "schema" : { "default" : 0, "type" : "integer", "format" : "int32" }, "in" : "query" }, { "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `1000`.", "in" : "query", "schema" : { "format" : "int32", "type" : "integer", "default" : 20 } } ] } }, "/api/3/issue/{issueIdOrKey}/notify" : { "post" : { "summary" : "Send notification for issue", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.notify_post", "description" : "Creates an email notification for an issue and adds it to the mail queue.\n\n**[Permissions](#permissions) required:**\n\n * *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the issue is not found." }, "400" : { "description" : "Returned if:\n\n * the recipient is the same as the calling user.\n * the recipient is invalid. For example, the recipient is set to the assignee, but the issue is unassigned.\n * the request is invalid. For example, required fields are missing or have invalid values." }, "403" : { "description" : "Returned if:\n\n * outgoing emails are disabled.\n * no SMTP server is configured." }, "204" : { "description" : "Returned if the email is queued for sending.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Notification" }, "example" : { "textBody" : "The latest test results for this ticket are now available.", "htmlBody" : "The latest test results for this ticket are now available.", "restrict" : { "groups" : [ { "name" : "notification-group" } ], "permissions" : [ { "key" : "BROWSE" } ] }, "to" : { "watchers" : true, "assignee" : false, "groups" : [ { "name" : "notification-group" } ], "voters" : true, "users" : [ { "accountId" : "5b10a2844c20165700ede21g", "active" : false } ], "reporter" : false }, "subject" : "Latest test results" } } }, "description" : "The request object for the notification and recipients.", "required" : true }, "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "ID or key of the issue that the notification is sent for.", "name" : "issueIdOrKey" } ], "deprecated" : false, "tags" : [ "Issues" ] } }, "/api/3/user" : { "delete" : { "x-experimental" : true, "tags" : [ "Users" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" }, "required" : true, "in" : "query", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "name" : "accountId", "x-showInExample" : "true" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username" }, { "name" : "key", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "schema" : { "type" : "string" }, "in" : "query" } ], "summary" : "Delete user", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.removeUser_delete", "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the user cannot be removed." }, "404" : { "description" : "Returned if:\n\n * `accountId` is missing.\n * the user is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Deletes a user.\n\n**[Permissions](#permissions) required:** Site administration (that is, membership of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).", "security" : [ { "basicAuth" : [] }, {} ] }, "get" : { "responses" : { "404" : { "description" : "Returned if:\n\n * `accountId` is missing.\n * the user is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}", "schema" : { "$ref" : "#/components/schemas/User" } } } } }, "description" : "Returns a user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "summary" : "Get user", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.getUser_get", "tags" : [ "Users" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "x-showInExample" : "true", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "in" : "query", "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" } }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "username", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details." }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "key", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) for details." }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about users in the response. This parameter accepts multiple values separated by a comma:\n\n * `groups` includes all groups and nested groups to which the user belongs.\n * `applicationRoles` includes details of all the applications to which the user has access." } ], "deprecated" : false }, "post" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [], "tags" : [ "Users" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "password" : "abracadabra", "emailAddress" : "mia@atlassian.com", "displayName" : "Mia Krystof", "name" : "" }, "schema" : { "$ref" : "#/components/schemas/UserWriteBean" } } } }, "x-experimental" : true, "description" : "Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated.\n\nThe option is provided to set or generate a password for the user. When using the option to generate a password, by omitting `password` from the request, include `\"notification\": \"true\"` to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn't sent for a generated password, the user will need to be sent a reset password request from Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, {} ], "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if the request is invalid or the number of licensed users is exceeded." }, "201" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}", "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "summary" : "Create user", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.createUser_post" } }, "/api/3/configuration/timetracking" : { "put" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if the time tracking provider is not found." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Selects a time tracking provider.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.selectTimeTrackingImplementation_put", "summary" : "Select time tracking provider", "tags" : [ "Time tracking" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "ADMIN", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TimeTrackingProvider" }, "example" : { "key" : "Jira" } } }, "required" : true } }, "get" : { "tags" : [ "Time tracking" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "operationId" : "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.getSelectedTimeTrackingImplementation_get", "summary" : "Get selected time tracking provider", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TimeTrackingProvider" }, "example" : "{\"key\":\"Jira\",\"name\":\"JIRA provided time tracking\",\"url\":\"/example/config/url\"}" } }, "description" : "Returned if the request is successful and time tracking is enabled." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful but time tracking is disabled." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, "delete" : { "tags" : [ "Time tracking" ], "deprecated" : true, "parameters" : [], "x-atlassian-connect-scope" : "ADMIN", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Disables time tracking.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.disableTimeTracking_delete", "summary" : "Disable time tracking" } }, "/api/3/issueLinkType/{issueLinkTypeId}" : { "get" : { "summary" : "Get issue link type", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueLinkTypeResource.getIssueLinkType_get", "description" : "Returns an issue link type.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "400" : { "description" : "Returned if the issue link type ID is invalid." }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the issue link type is not found.\n * the user does not have the required permissions." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueLinkType" }, "example" : "{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "x-atlassian-connect-scope" : "READ", "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the issue link type.", "name" : "issueLinkTypeId" } ], "deprecated" : false, "tags" : [ "Issue link types" ] }, "delete" : { "tags" : [ "Issue link types" ], "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the issue link type.", "name" : "issueLinkTypeId" } ], "deprecated" : false, "summary" : "Delete issue link type", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueLinkTypeResource.deleteIssueLinkType_delete", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the issue link type is not found.\n * the user does not have the required permissions." }, "400" : { "description" : "Returned if the issue link type ID is invalid." }, "204" : { "description" : "Returned if the request is successful." } }, "description" : "Deletes an issue link type.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ] }, "put" : { "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueLinkType" }, "example" : { "name" : "Duplicate", "outward" : "Duplicates", "inward" : "Duplicated by" } } }, "required" : true }, "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "description" : "The ID of the issue link type.", "name" : "issueLinkTypeId", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "tags" : [ "Issue link types" ], "summary" : "Update issue link type", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueLinkTypeResource.updateIssueLinkType_put", "description" : "Updates an issue link type.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, {} ], "responses" : { "400" : { "description" : "Returned if the issue link type ID or the request body are invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}", "schema" : { "$ref" : "#/components/schemas/IssueLinkType" } } } }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the issue link type is not found.\n * the user does not have the required permissions." } } } }, "/api/3/field/{fieldKey}/option/suggestions/edit" : { "get" : { "summary" : "Get selectable issue field options", "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.getSelectableIssueFieldOptions_get", "description" : "Returns options defined for a select list issue field that can be viewed and selected by the user.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "responses" : { "404" : { "description" : "Returned if the field is not found or does not support options." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"}}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanIssueFieldOption" } } } } }, "x-atlassian-connect-scope" : "NONE", "parameters" : [ { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" } }, { "description" : "The maximum number of items to return per page. The maximum is `100`.", "name" : "maxResults", "in" : "query", "schema" : { "default" : 50, "type" : "integer", "format" : "int32" } }, { "in" : "query", "schema" : { "format" : "int64", "type" : "integer" }, "name" : "projectId", "description" : "Filters the results to options that are only available in the specified project." }, { "name" : "fieldKey", "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "Issue field options" ] } }, "/api/3/attachment/meta" : { "get" : { "description" : "Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.\n\nNote that there are also [project permissions](https://confluence.atlassian.com/x/yodKLg) that restrict whether users can create and delete attachments.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentSettings" }, "example" : "{\"enabled\":true,\"uploadLimit\":1000000}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "summary" : "Get Jira attachment settings", "operationId" : "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.getAttachmentMeta_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [], "tags" : [ "Issue attachments" ] } }, "/api/3/field/search" : { "get" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanField" }, "example" : "{\"maxResults\":50,\"startAt\":0,\"total\":2,\"isLast\":false,\"values\":[{\"id\":\"customfield_10000\",\"name\":\"Approvers\",\"description\":\"Contains users needed for approval. This custom field was created by Jira Service Desk.\",\"key\":\"customfield_10000\",\"screens\":[{\"id\":\"10200\"},{\"id\":\"10201\"}],\"contexts\":[{\"id\":\"10100\"},{\"id\":\"10101\"}],\"lastUsed\":\"2019-09-12T10:10:00.082+0000\"},{\"id\":\"customfield_10001\",\"name\":\"Change reason\",\"description\":\"Choose the reason for the change request\",\"key\":\"customfield_10001\",\"screens\":[{\"id\":\"10204\"},{\"id\":\"10208\"}],\"contexts\":[{\"id\":\"10105\"},{\"id\":\"10109\"}]}]}" } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if parameter isCustom is not set to true.", "content" : { "application/json" : { "example" : "{\"errorMessages\":[\"Only custom fields can be queried.\"],\"errors\":{}}", "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "403" : { "content" : { "application/json" : { "example" : "{\"errorMessages\":[\"Only Jira administrators can access fields.\"],\"errors\":{}}", "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the user does not have the necessary permission." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns a [paginated](#pagination) list of fields for Classic Jira projects. Only custom fields can be queried, `isCustom` must be set to `true`.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.field.FieldSearchResource.getFieldsPaginated_get", "summary" : "Get fields paginated", "tags" : [ "Issue fields" ], "parameters" : [ { "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt", "in" : "query", "schema" : { "default" : 0, "format" : "int64", "type" : "integer" } }, { "name" : "maxResults", "description" : "The maximum number of items to return per page.", "schema" : { "default" : 50, "type" : "integer", "format" : "int32" }, "in" : "query" }, { "schema" : { "type" : "boolean" }, "in" : "query", "name" : "isCustom", "description" : "Should endpoint return Custom Fields (true), System Fields (false), or both (unset)" }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `key` Returns the key for each field.\n * `lastUsed` Returns the date when the value of the field last changed.\n * `screens` Returns information about the screens a field is used in.\n * `contexts` Returns information about the contexts a field is used in.", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE", "x-experimental" : true } }, "/api/3/dashboard/{id}" : { "get" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The ID of the dashboard.", "name" : "id", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "tags" : [ "Dashboards" ], "summary" : "Get dashboard", "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardResource.getDashboard_get", "description" : "Returns a dashboard.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.\n\nHowever, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.", "security" : [ { "basicAuth" : [] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":\"10000\",\"isFavourite\":false,\"name\":\"System Dashboard\",\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/10000\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"http://your-domain.atlassian.net/secure/Dashboard.jspa?selectPageId=10000\"}", "schema" : { "$ref" : "#/components/schemas/Dashboard" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the dashboard is not found or the dashboard is not owned by or shared with the user." } } } }, "/api/3/search" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.search.SearchResource.searchForIssuesUsingJql_get", "summary" : "Search for issues using JQL (GET)", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchResults" }, "example" : "{\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10002\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"ED-1\",\"fields\":{\"watcher\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:30.888+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"ED-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/ED-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Main order flow broken\"}]}]},\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PR-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}},{\"id\":\"10002\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PR-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-3\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"remainingEstimate\":\"3m\",\"timeSpent\":\"6m\",\"originalEstimateSeconds\":600,\"remainingEstimateSeconds\":200,\"timeSpentSeconds\":400}}}],\"warningMessages\":[\"The value 'bar' does not exist for the field 'foo'.\"]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the JQL query is invalid." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).\n\nIf the JQL query expression is too large to be encoded as a query parameter, use the [POST](#api-rest-api-3-search-post) version of this resource.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Issues are included in the response where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "tags" : [ "Issue search" ], "deprecated" : false, "parameters" : [ { "description" : "The [JQL](https://confluence.atlassian.com/x/egORLQ) that defines the search. Note:\n\n * If no JQL expression is provided, all issues are returned.\n * `username` and `userkey` cannot be used as search terms due to privacy reasons. Use `accountId` instead.\n * If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.", "name" : "jql", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "project = HSP" }, "in" : "query" }, { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "in" : "query" }, { "description" : "The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only.", "name" : "maxResults", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "in" : "query" }, { "in" : "query", "schema" : { "default" : "strict", "enum" : [ "strict", "warn", "none", "true", "false" ], "type" : "string" }, "name" : "validateQuery", "description" : "Determines how to validate the JQL query and treat the validation results. Supported values are:\n\n * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `warn` Returns all errors as warnings.\n * `none` No validation is performed.\n * `true` *Deprecated* A legacy synonym for `strict`.\n * `false` *Deprecated* A legacy synonym for `warn`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value." }, { "schema" : { "type" : "array", "items" : { "default" : "*navigable", "type" : "string" } }, "in" : "query", "name" : "fields", "description" : "A comma-separated list of fields to return for each issue, use it to retrieve a subset of fields. Allowed values:\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nExamples:\n\n * `summary,comment` Returns only the summary and comments fields.\n * `-description` Returns all navigable (default) fields except description.\n * `*all,-comment` Returns all fields except comments.\n\nThis parameter may be specified multiple times. For example, `fields=field1,field2&fields=field3`.\n\nNote: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields." }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts multiple values separated by a comma:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `operations` Returns all possible operations for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.", "in" : "query", "schema" : { "type" : "string" } }, { "schema" : { "type" : "array", "items" : { "type" : "string" } }, "in" : "query", "description" : "A comma-separated list of issue property keys for issue properties to include in the results. This parameter may be specified multiple times. For example, `properties=prop1,prop2&properties=prop3`. A maximum of 5 issue property keys can be specified.", "name" : "properties" }, { "description" : "Reference fields by their key (rather than ID).", "name" : "fieldsByKeys", "schema" : { "type" : "boolean", "default" : false }, "in" : "query" } ], "x-atlassian-connect-scope" : "READ" }, "post" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"expand\":\"names,schema\",\"startAt\":0,\"maxResults\":50,\"total\":1,\"issues\":[{\"expand\":\"\",\"id\":\"10002\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"ED-1\",\"fields\":{\"watcher\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:30.888+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"ED-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/ED-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Main order flow broken\"}]}]},\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PR-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}},{\"id\":\"10002\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PR-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-3\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"remainingEstimate\":\"3m\",\"timeSpent\":\"6m\",\"originalEstimateSeconds\":600,\"remainingEstimateSeconds\":200,\"timeSpentSeconds\":400}}}],\"warningMessages\":[\"The value 'bar' does not exist for the field 'foo'.\"]}", "schema" : { "$ref" : "#/components/schemas/SearchResults" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the JQL query is invalid." } }, "description" : "Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).\n\nThere is a [GET](#api-rest-api-3-search-get) version of this resource that can be used for smaller JQL query expressions.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Issues are included in the response where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Search for issues using JQL (POST)", "operationId" : "com.atlassian.jira.rest.v2.search.SearchResource.searchForIssuesUsingJql_post", "tags" : [ "Issue search" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "fieldsByKeys" : false, "jql" : "project = HSP", "fields" : [ "summary", "status", "assignee" ], "expand" : [ "names", "schema", "operations" ], "maxResults" : 15, "startAt" : 0 }, "schema" : { "$ref" : "#/components/schemas/SearchRequestBean" } } }, "description" : "A JSON object containing the search request." } } }, "/api/3/resolution" : { "get" : { "tags" : [ "Issue resolutions" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [], "summary" : "Get resolutions", "operationId" : "com.atlassian.jira.rest.v2.issue.ResolutionResource.getResolutions_get", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/resolution/1\",\"id\":\"10000\",\"description\":\"A fix for this issue is checked into the tree and tested.\",\"name\":\"Fixed\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/resolution/3\",\"id\":\"10001\",\"description\":\"This is what it is supposed to do.\",\"name\":\"Works as designed\"}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Resolution" } } } }, "description" : "Returned if the request is successful." } }, "description" : "Returns a list of all issue resolution values.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ] } }, "/api/3/workflow/rule/config" : { "put" : { "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [], "tags" : [ "Workflow transition rules" ], "requestBody" : { "content" : { "application/json" : { "example" : { "workflows" : [ { "validators" : [ { "configuration" : { "value" : "{ \"shape\": \"square\" }" }, "id" : "11e9-59f5-b4d6cbdc-8647-d663bd873d93" } ], "workflowId" : { "draft" : false, "name" : "My Workflow name" }, "postFunctions" : [ { "id" : "b4d6cbdc-59f5-11e9-8647-d663bd873d93", "configuration" : { "value" : "{ \"color\": \"red\" }" } } ], "conditions" : [ { "id" : "d663bd873d93-59f5-11e9-8647-b4d6cbdc", "configuration" : { "value" : "{ \"size\": \"medium\" }" } } ] } ] }, "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionRulesUpdate" } } }, "required" : true }, "description" : "Updates configuration of workflow transition rules. The following rule types are supported:\n\n * [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)\n * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/)\n * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/)\n\nOnly rules created by the calling Connect app can be updated.\n\n**[Permissions](#permissions) required:** Only Connect apps can use this operation.", "security" : [ { "basicAuth" : [] } ], "responses" : { "400" : { "description" : "Returned if the request is invalid.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "403" : { "description" : "Returned if the caller is not a Connect app.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "200" : { "content" : { "application/json" : { "example" : "{\"updateResults\":[{\"workflowId\":{\"name\":\"Workflow with one rule not updated\",\"draft\":false},\"ruleUpdateErrors\":{\"example-rule-id\":[\"The rule with this id does not exist: example-rule-id\"]},\"updateErrors\":[]},{\"workflowId\":{\"name\":\"Workflow with all rules successfully updated\",\"draft\":true},\"ruleUpdateErrors\":{},\"updateErrors\":[]},{\"workflowId\":{\"name\":\"Non-existing workflow\",\"draft\":false},\"ruleUpdateErrors\":{},\"updateErrors\":[\"Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}\"]}]}", "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionRulesUpdateErrors" } } }, "description" : "Returned if the request is successful." } }, "summary" : "Update workflow transition rule configurations", "operationId" : "com.atlassian.jira.rest.v2.admin.workflow.WorkflowRuleConfigResource.updateWorkflowTransitionRuleConfigurations_put" }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.admin.workflow.WorkflowRuleConfigResource.getWorkflowTransitionRuleConfigurations_get", "summary" : "Get workflow transition rule configurations", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanWorkflowTransitionRules" }, "example" : "{\"maxResults\":10,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"workflowId\":{\"name\":\"My Workflow name\",\"draft\":false},\"postFunctions\":[{\"id\":\"b4d6cbdc-59f5-11e9-8647-d663bd873d93\",\"key\":\"postfunction-key\",\"configuration\":{\"value\":\"{ \\\"color\\\": \\\"red\\\" }\"},\"transition\":{\"id\":1,\"name\":\"Open\"}}],\"conditions\":[{\"id\":\"d663bd873d93-59f5-11e9-8647-b4d6cbdc\",\"key\":\"condition-key\",\"configuration\":{\"value\":\"{ \\\"size\\\": \\\"medium\\\" }\"},\"transition\":{\"id\":1,\"name\":\"Open\"}}],\"validators\":[{\"id\":\"11e9-59f5-b4d6cbdc-8647-d663bd873d93\",\"key\":\"validator-key\",\"configuration\":{\"value\":\"\\\"{ \\\\\\\"shape\\\\\\\": \\\\\\\"square\\\\\\\" }\\\"\"},\"transition\":{\"id\":1,\"name\":\"Open\"}}]}]}" } } }, "404" : { "description" : "Returned if the any transition rule type is not supported." }, "400" : { "description" : "Returned if the request is invalid.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "403" : { "description" : "Returned if the caller is not a Connect app.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:\n\n * of one or more transition rule types, such as [workflow post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/).\n * matching one or more transition rule keys.\n\nOnly workflows containing transition rules created by the calling Connect app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow.\n\nDue to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.\n\n**[Permissions](#permissions) required:** Only Connect apps can use this operation.", "tags" : [ "Workflow transition rules" ], "deprecated" : false, "parameters" : [ { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "format" : "int64", "type" : "integer", "default" : 0 }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 10 }, "description" : "The maximum number of items to return per page.", "name" : "maxResults" }, { "description" : "The types of the transition rules to return.", "name" : "types", "schema" : { "items" : { "enum" : [ "postfunction", "condition", "validator" ], "type" : "string" }, "uniqueItems" : true, "type" : "array" }, "required" : true, "in" : "query" }, { "description" : "The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.", "name" : "keys", "schema" : { "type" : "array", "items" : { "type" : "string" }, "uniqueItems" : true }, "in" : "query" }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `transition` For each rule, returns information about the transition the rule is assigned to.", "schema" : { "type" : "string" }, "in" : "query" } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/issue/{issueIdOrKey}/worklog/{id}" : { "put" : { "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key the issue.", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the worklog.", "name" : "id" }, { "schema" : { "default" : true, "type" : "boolean" }, "in" : "query", "name" : "notifyUsers", "description" : "Indicates whether users watching the issue are notified by email." }, { "in" : "query", "schema" : { "type" : "string", "default" : "auto", "enum" : [ "new", "leave", "manual", "auto" ] }, "description" : "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or `timeSpentSeconds`.", "name" : "adjustEstimate" }, { "description" : "The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `new`.", "name" : "newEstimate", "schema" : { "type" : "string" }, "in" : "query" }, { "description" : "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:\n\n * `properties` Returns worklog properties.", "name" : "expand", "in" : "query", "schema" : { "type" : "string", "default" : "" } }, { "in" : "query", "schema" : { "type" : "boolean", "default" : false }, "description" : "Indicates whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Only connect app users with admin permissions can use this flag.", "name" : "overrideEditableFlag" } ], "deprecated" : false, "tags" : [ "Issue worklogs" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Worklog" }, "example" : { "visibility" : { "type" : "group", "value" : "jira-developers" }, "comment" : { "version" : 1, "type" : "doc", "content" : [ { "content" : [ { "text" : "I did some work here.", "type" : "text" } ], "type" : "paragraph" } ] }, "timeSpentSeconds" : 12000, "started" : "2019-09-20T13:24:29.950+0000" } } }, "required" : true }, "description" : "Updates a worklog.\n\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or *Edit own worklogs* to update worklogs created by the user.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "400" : { "description" : "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * the user does not have permission to update the worklog.\n * the request JSON is malformed." }, "404" : { "description" : "Returned if:\n\n * the issue is not found or user does not have permission to view the issue.\n * the worklog is not found or the user does not have permission to view it.\n * time tracking is disabled." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "200" : { "description" : "Returned if the request is successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Worklog" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}" } } } }, "summary" : "Update worklog", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueWorklogsResource.updateWorklog_put" }, "delete" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if:\n\n * the issue is not found or user does not have permission to view the issue.\n * the worklog is not found or the user does not have permission to view it.\n * time tracking is disabled." }, "400" : { "description" : "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n * the user does not have permission to delete the worklog." }, "204" : { "description" : "Returned if the request is successful." } }, "description" : "Deletes a worklog from an issue.\n\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Delete all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any worklog or *Delete own worklogs* to delete worklogs created by the user,\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "summary" : "Delete worklog", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueWorklogsResource.deleteWorklog_delete", "tags" : [ "Issue worklogs" ], "x-atlassian-connect-scope" : "DELETE", "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the worklog." }, { "schema" : { "default" : true, "type" : "boolean" }, "in" : "query", "name" : "notifyUsers", "description" : "Indicates whether users watching the issue are notified by email." }, { "schema" : { "enum" : [ "new", "leave", "manual", "auto" ], "default" : "auto", "type" : "string" }, "in" : "query", "name" : "adjustEstimate", "description" : "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Increases the estimate by amount specified in `increaseBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog." }, { "description" : "The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `new`.", "name" : "newEstimate", "schema" : { "type" : "string" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "The amount to increase the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `manual`.", "name" : "increaseBy" }, { "schema" : { "type" : "boolean", "default" : false }, "in" : "query", "description" : "Indicates whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin permissions can use this flag.", "name" : "overrideEditableFlag" } ] }, "get" : { "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "issueIdOrKey", "description" : "The ID or key of the issue." }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the worklog.", "name" : "id" }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:\n\n * `properties` Returns worklog properties.", "schema" : { "type" : "string", "default" : "" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue worklogs" ], "operationId" : "com.atlassian.jira.rest.v2.issue.IssueWorklogsResource.getWorklog_get", "summary" : "Get worklog", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a worklog.\n\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "responses" : { "404" : { "description" : "Returned if:\n\n * the issue is not found or the user does not have permission to view it.\n * the worklog is not found or the user does not have permission to view it.\n * time tracking is disabled.\n\n." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Worklog" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } } } }, "/api/3/field/{fieldKey}/option" : { "post" : { "summary" : "Create issue field option", "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.createIssueFieldOption_post", "description" : "Creates an option for a select list issue field.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueFieldOption" }, "example" : "{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the field is not found or does not support options." }, "400" : { "description" : "Returned if the option is invalid." }, "403" : { "description" : "Returned if the request is not authenticated as a Jira administrator or the app that provided the field." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueFieldOptionCreateBean" }, "example" : { "config" : { "attributes" : [], "scope" : { "global" : {}, "projects2" : [ { "attributes" : [ "notSelectable" ], "id" : 1002 }, { "id" : 1001, "attributes" : [ "notSelectable" ] } ], "projects" : [] } }, "properties" : { "members" : 42, "description" : "The team's description", "leader" : { "email" : "lname@example.com", "name" : "Leader Name" }, "founded" : "2016-06-06T00:00:00.000Z" }, "value" : "Team 1" } } } }, "x-atlassian-connect-scope" : "NONE", "deprecated" : false, "parameters" : [ { "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*.", "name" : "fieldKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "tags" : [ "Issue field options" ] }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.getAllIssueFieldOptions_get", "summary" : "Get all issue field options", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Returns all options defined for a select list issue field. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that allows a user to select n value from a list of options.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanIssueFieldOption" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=0&maxResults=1\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}]}" } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the field is not found or does not support options." }, "403" : { "description" : "Returned if the request is not authenticated as a Jira administrator or the app that provided the field." } }, "deprecated" : false, "parameters" : [ { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "format" : "int64", "type" : "integer", "default" : 0 }, "in" : "query" }, { "schema" : { "format" : "int32", "type" : "integer", "default" : 50 }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `100`." }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "fieldKey", "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*." } ], "x-atlassian-connect-scope" : "NONE", "tags" : [ "Issue field options" ] } }, "/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}" : { "put" : { "operationId" : "com.atlassian.jira.rest.v2.issue.WorklogPropertyResource.setWorklogProperty_put", "summary" : "Set worklog property", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Sets the value of a worklog property. Use this operation to store custom data against the worklog.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Edit all worklogs*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or *Edit own worklogs* to update worklogs created by the user.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "responses" : { "201" : { "description" : "Returned if the worklog property is created.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the worklog property is updated.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if:\n\n * the issue or worklog is not found.\n * the user does not have permission to view the issue or worklog." }, "403" : { "description" : "Returned if the user does not have permission to edit the worklog." }, "400" : { "description" : "Returned if the worklog ID is invalid." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : {} } } }, "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the worklog.", "name" : "worklogId" }, { "description" : "The key of the issue property. The maximum length is 255 characters.", "name" : "propertyKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Issue worklog properties" ] }, "get" : { "tags" : [ "Issue worklog properties" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" }, { "description" : "The ID of the worklog.", "name" : "worklogId", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "propertyKey", "description" : "The key of the property." } ], "deprecated" : false, "responses" : { "400" : { "description" : "Returned if the worklog ID is invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}", "schema" : { "$ref" : "#/components/schemas/EntityProperty" } } } }, "404" : { "description" : "Returned if:\n\n * the issue, worklog, or property is not found.\n * the user does not have permission to view the issue or worklog." } }, "description" : "Returns the value of a worklog property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get worklog property", "operationId" : "com.atlassian.jira.rest.v2.issue.WorklogPropertyResource.getWorklogProperty_get" }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.WorklogPropertyResource.deleteWorklogProperty_delete", "summary" : "Delete worklog property", "responses" : { "404" : { "description" : "Returned if:\n\n * the issue, worklog, or property is not found.\n * the user does not have permission to view the issue or worklog." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have permission to edit the worklog." }, "204" : { "description" : "Returned if the worklog property is removed." }, "400" : { "description" : "Returned if the worklog key or id is invalid." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes a worklog property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "tags" : [ "Issue worklog properties" ], "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "worklogId", "description" : "The ID of the worklog.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "propertyKey", "description" : "The key of the property.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "x-atlassian-connect-scope" : "DELETE" } }, "/api/3/user/properties" : { "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "x-showInExample" : "true", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "name" : "accountId", "in" : "query", "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" } }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "userKey", "schema" : { "type" : "string" }, "in" : "query" }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "in" : "query", "schema" : { "type" : "string" } } ], "tags" : [ "User properties" ], "description" : "Returns the keys of all properties for a user.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to access the property keys on any user.\n * Access to Jira, to access the calling user's property keys.\n\nNote: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/8YxjL) that are set in Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "responses" : { "403" : { "description" : "Returned if the calling user does not have the *Administer Jira* permission or is not accessing their user record." }, "400" : { "description" : "Returned if `accountId` is missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}", "schema" : { "$ref" : "#/components/schemas/PropertyKeys" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the user is not found." } }, "summary" : "Get user property keys", "operationId" : "com.atlassian.jira.rest.v2.userproperty.UserPropertyResource.getUserPropertyKeys_get" } }, "/api/3/auditing/record" : { "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "format" : "int32", "type" : "integer", "default" : 0 }, "in" : "query", "name" : "offset", "description" : "The number of records to skip before returning the first result." }, { "schema" : { "format" : "int32", "type" : "integer", "default" : 1000 }, "in" : "query", "description" : "The maximum number of results to return. The maximum is `1000`.", "name" : "limit" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "filter", "description" : "The query string." }, { "name" : "from", "description" : "The date and time on or after which returned audit records must have been created. If `to` is provided `from` must be before `to` or no audit records are returned.", "in" : "query", "schema" : { "format" : "date-time", "type" : "string" } }, { "in" : "query", "schema" : { "format" : "date-time", "type" : "string" }, "description" : "The date and time on or before which returned audit results must have been created. If `from` is provided `to` must be after `from` or no audit records are returned.", "name" : "to" } ], "tags" : [ "Audit records" ], "description" : "Returns a list of audit records. The list can be filtered to include items:\n\n * containing a string in at least one field. For example, providing *up* will return all audit records where one or more fields contains words such as *update*.\n * created on or after a date and time.\n * created or or before a date and time.\n * created during a time period.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "403" : { "description" : "Returned if:\n\n * the user does not have the required permissions.\n * all Jira products are on Free plans. Audit logs are available when at least one Jira product is not on a Free plan." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuditRecords" }, "example" : "{\"offset\":0,\"limit\":1000,\"total\":1,\"records\":[{\"id\":1,\"summary\":\"User created\",\"remoteAddress\":\"192.168.1.1\",\"authorKey\":\"administrator\",\"created\":\"2014-03-19T18:45:42.967+0000\",\"category\":\"user management\",\"eventSource\":\"Jira Connect Plugin\",\"description\":\"Optional description\",\"objectItem\":{\"id\":\"user\",\"name\":\"user\",\"typeName\":\"USER\",\"parentId\":\"1\",\"parentName\":\"Jira Internal Directory\"},\"changedValues\":[{\"fieldName\":\"email\",\"changedFrom\":\"user@atlassian.com\",\"changedTo\":\"newuser@atlassian.com\"}],\"associatedItems\":[{\"id\":\"jira-software-users\",\"name\":\"jira-software-users\",\"typeName\":\"GROUP\",\"parentId\":\"1\",\"parentName\":\"Jira Internal Directory\"}]}]}" } }, "description" : "Returned if the request is successful." } }, "summary" : "Get audit records", "operationId" : "com.atlassian.jira.rest.v2.admin.auditing.AuditingResource.getAuditRecords_get" } }, "/api/3/priority/{id}" : { "get" : { "summary" : "Get priority", "operationId" : "com.atlassian.jira.rest.v2.issue.PriorityResource.getPriority_get", "responses" : { "404" : { "description" : "Returned if the issue priority is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"}", "schema" : { "$ref" : "#/components/schemas/Priority" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } }, "description" : "Returns an issue priority.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "tags" : [ "Issue priorities" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the issue priority.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] } }, "/api/3/filter/{id}/columns" : { "put" : { "summary" : "Set columns", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.setColumns_put", "description" : "Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.\n\nThe parameters for this resource are expressed as HTML form data. For example, in curl:\n\n`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns`\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, columns are only set for:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "Returned if:\n\n * a non-navigable field is set as a column.\n * the user does not have permission to view the filter." } }, "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "The IDs of the fields to set as columns. In the form data, specify each field as `columns=id`, where `id` is the *id* of a field (as seen in the response for [Get fields](#api-rest-api--field-get)). For example, `columns=summary`." }, "x-atlassian-connect-scope" : "WRITE", "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the filter.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "tags" : [ "Filters" ] }, "delete" : { "deprecated" : false, "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the filter.", "name" : "id" } ], "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Filters" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Reset the user's column configuration for the filter to the default.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, columns are only reset for:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter." }, "204" : { "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.resetColumns_delete", "summary" : "Reset columns" }, "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, column details are only returned for:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "responses" : { "200" : { "content" : { "application/json" : { "example" : "[{\"label\":\"Key\",\"value\":\"issuekey\"},{\"label\":\"Summary\",\"value\":\"summary\"}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnItem" } } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if a column configuration is not set for the filter." }, "400" : { "description" : "Returned if the user does not have permission to view the filter." } }, "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getColumns_get", "summary" : "Get columns", "parameters" : [ { "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "name" : "id", "description" : "The ID of the filter." } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Filters" ] } }, "/api/3/project/{projectKeyOrId}/permissionscheme" : { "put" : { "operationId" : "com.atlassian.jira.rest.v2.permission.ProjectPermissionSchemeResource.assignPermissionScheme_put", "summary" : "Assign permission scheme", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] } ], "description" : "Assigns a permission scheme with a project. See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)", "responses" : { "403" : { "description" : "Returned if:\n\n * the user is not permitted to edit the project's configuration.\n * the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be assigned to projects on Free plans." }, "404" : { "description" : "Returned if the project or permission scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionScheme" }, "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\"}" } }, "description" : "Returned if the request is successful." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IdBean" }, "example" : { "id" : 10000 } } } }, "deprecated" : false, "parameters" : [ { "name" : "projectKeyOrId", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission." } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Project permission schemes" ] }, "get" : { "summary" : "Get assigned permission scheme", "operationId" : "com.atlassian.jira.rest.v2.permission.ProjectPermissionSchemeResource.getAssignedPermissionScheme_get", "description" : "Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg) associated with the project.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "responses" : { "404" : { "description" : "Returned if the project is not found or the user does not have permission to view the project." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\"}", "schema" : { "$ref" : "#/components/schemas/PermissionScheme" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have permission to view the project's configuration." } }, "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "projectKeyOrId", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission.", "schema" : { "type" : "string" }, "in" : "query" } ], "deprecated" : false, "tags" : [ "Project permission schemes" ] } }, "/api/3/version/{id}/unresolvedIssueCount" : { "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns counts of the issues and unresolved issues for the project version.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* project permission for the project that contains the version.", "responses" : { "404" : { "description" : "Returned if:\n\n * the version is not found.\n * the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"issuesUnresolvedCount\":23,\"issuesCount\":30}", "schema" : { "$ref" : "#/components/schemas/VersionUnresolvedIssuesCount" } } }, "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.getVersionUnresolvedIssues_get", "summary" : "Get version's unresolved issues count", "parameters" : [ { "description" : "The ID of the version.", "name" : "id", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Project versions" ] } }, "/api/3/filter/favourite" : { "get" : { "description" : "Returns the visible favorite filters of the user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** A favorite filter is only visible to the user where the filter is:\n\n * owned by the user.\n * shared with a group that the user is a member of.\n * shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * shared with a public project.\n * shared with the public.\n\nFor example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/Filter" }, "type" : "array" }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}}],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}]" } } } }, "summary" : "Get favorite filters", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getFavouriteFilters_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." } ], "tags" : [ "Filters" ] } }, "/api/3/workflowscheme/{id}/draft/issuetype/{issueType}" : { "put" : { "requestBody" : { "description" : "The issue type-project mapping.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypeWorkflowMapping" }, "example" : { "issueType" : "10000", "workflow" : "jira", "updateDraftIfNeeded" : false } } }, "required" : true }, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "The ID of the workflow scheme that the draft belongs to.", "name" : "id" }, { "name" : "issueType", "description" : "The ID of the issue type.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow scheme drafts" ], "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.setWorkflowSchemeDraftIssueType_put", "summary" : "Set workflow for issue type in draft workflow scheme", "security" : [ { "basicAuth" : [] } ], "description" : "Sets the workflow for an issue type in a workflow scheme's draft.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } } }, "404" : { "description" : "Returned if the workflow scheme or issue type is not found." }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "400" : { "description" : "Returned if the request is invalid." } } }, "get" : { "summary" : "Get workflow for issue type in draft workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getWorkflowSchemeDraftIssueType_get", "description" : "Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "404" : { "description" : "Returned if the workflow scheme or issue type is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"issueType\":\"10000\",\"workflow\":\"jira\"}", "schema" : { "$ref" : "#/components/schemas/IssueTypeWorkflowMapping" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user is not permitted to create workflow schemes." } }, "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The ID of the workflow scheme that the draft belongs to.", "name" : "id", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" }, { "description" : "The ID of the issue type.", "name" : "issueType", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "tags" : [ "Workflow scheme drafts" ] }, "delete" : { "tags" : [ "Workflow scheme drafts" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "name" : "id", "description" : "The ID of the workflow scheme that the draft belongs to." }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the issue type.", "name" : "issueType" } ], "summary" : "Delete workflow for issue type in draft workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteWorkflowSchemeDraftIssueType_delete", "responses" : { "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "404" : { "description" : "Returned if the workflow scheme or issue type is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } }, "description" : "Returned if the request is successful." } }, "description" : "Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ] } }, "/api/3/task/{taskId}" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.task.TaskResource.getTask_get", "summary" : "Get task", "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "404" : { "description" : "Returned if the task is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaskProgressBeanObject" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/task/1\",\"id\":\"1\",\"description\":\"Task description\",\"status\":\"COMPLETE\",\"result\":\"the task result, this may be any JSON\",\"submittedBy\":10000,\"progress\":100,\"elapsedRuntime\":156,\"submitted\":1568985872742,\"started\":1568985872861,\"finished\":1568985872961,\"lastUpdate\":1568985872961}" } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [] } ], "description" : "Returns the status of a [long-running asynchronous task](#async).\n\nWhen a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days although this period may change without notice.\n\n**[Permissions](#permissions) required:** either of:\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * Creator of the task.", "x-experimental" : true, "tags" : [ "Tasks" ], "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the task.", "name" : "taskId" } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE" } }, "/api/3/workflowscheme/{id}" : { "put" : { "requestBody" : { "content" : { "application/json" : { "example" : { "issueTypeMappings" : { "10000" : "scrum workflow" }, "defaultWorkflow" : "jira", "description" : "The description of the example workflow scheme.", "name" : "Example workflow scheme", "updateDraftIfNeeded" : false }, "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } }, "required" : true }, "tags" : [ "Workflow schemes" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "summary" : "Update workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.updateWorkflowScheme_put", "responses" : { "403" : { "description" : "Returned if the user is not permitted to modify workflow schemes." }, "400" : { "description" : "Returned if the request is invalid." }, "404" : { "description" : "Returned if the workflow scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}" } }, "description" : "Returned if the request is successful." } }, "description" : "Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that `updateDraftIfNeeded` is set to `true`.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ] }, "delete" : { "tags" : [ "Workflow schemes" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*.", "name" : "id", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" } ], "summary" : "Delete workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteWorkflowScheme_delete", "responses" : { "404" : { "description" : "Returned if the workflow scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user is not permitted to delete workflow schemes." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the scheme is active." } }, "description" : "Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ] }, "get" : { "responses" : { "403" : { "description" : "Returned if the user is not permitted to access workflows." }, "404" : { "description" : "Returned if the workflow scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } }, "description" : "Returned if the request is successful." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns a workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getWorkflowScheme_get", "summary" : "Get workflow scheme", "tags" : [ "Workflow schemes" ], "parameters" : [ { "name" : "id", "description" : "The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true }, { "description" : "Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.", "name" : "returnDraftIfExists", "schema" : { "default" : false, "type" : "boolean" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE" } }, "/api/3/issue/{issueIdOrKey}" : { "put" : { "responses" : { "403" : { "description" : "Returned if the user uses `overrideScreenSecurity` or `overrideEditableFlag` but doesn't have the necessary permissions." }, "204" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "Returned if:\n\n * the request body is missing.\n * the user does not have the necessary permissions to edit one or more fields.\n * the request includes one or more fields that are not found or are not associated with the issue's edit screen.\n * the request includes an invalid transition." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Edits an issue. A transition may be applied and issue properties updated as part of the edit.\n\nThe edits to the issue's fields are defined using `update` and `fields`. The fields that can be edited are determined using [ Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get). Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.\n\nConnect app users with admin permissions (from user permissions and app scopes) can override the screen security configuration using `overrideScreenSecurity` and `overrideEditableFlag`.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "summary" : "Edit issue", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.editIssue_put", "tags" : [ "Issues" ], "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "description" : "Indicates whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.", "name" : "notifyUsers", "schema" : { "type" : "boolean", "default" : true }, "in" : "query" }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "description" : "Indicates whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.", "name" : "overrideScreenSecurity" }, { "in" : "query", "schema" : { "default" : false, "type" : "boolean" }, "name" : "overrideEditableFlag", "description" : "Indicates whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions." } ], "deprecated" : false, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueUpdateDetails" }, "example" : { "historyMetadata" : { "type" : "myplugin:type", "actor" : { "id" : "tony", "url" : "http://mysystem/users/tony", "avatarUrl" : "http://mysystem/avatar/tony.jpg", "type" : "mysystem-user", "displayName" : "Tony" }, "cause" : { "type" : "mysystem-event", "id" : "myevent" }, "description" : "From the order testing process", "extraData" : { "Iteration" : "10a", "Step" : "4" }, "activityDescription" : "Complete order processing", "generator" : { "id" : "mysystem-1", "type" : "mysystem-application" } }, "properties" : [ { "value" : "Order number 10784", "key" : "key1" }, { "value" : "Order number 10923", "key" : "key2" } ], "fields" : { "summary" : "Completed orders still displaying in pending", "customfield_10010" : 1, "customfield_10000" : { "version" : 1, "content" : [ { "content" : [ { "text" : "Investigation underway", "type" : "text" } ], "type" : "paragraph" } ], "type" : "doc" } }, "update" : { "components" : [ { "set" : "" } ], "labels" : [ { "add" : "triaged" }, { "remove" : "blocker" } ], "summary" : [ { "set" : "Bug in business logic" } ], "timetracking" : [ { "edit" : { "originalEstimate" : "1w 1d", "remainingEstimate" : "4d" } } ] } } } }, "required" : true } }, "delete" : { "tags" : [ "Issues" ], "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" }, { "description" : "Indicates whether the issue's subtasks are deleted when the issue is deleted.", "name" : "deleteSubtasks", "in" : "query", "schema" : { "type" : "string", "default" : "false", "enum" : [ "true", "false" ] } } ], "x-atlassian-connect-scope" : "DELETE", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.deleteIssue_delete", "summary" : "Delete issue", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view the issue." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have permission to delete the issue." }, "400" : { "description" : "Returned if the issue has subtasks and `deleteSubtasks` is not set to *true*." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes an issue.\n\nAn issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be deleted with the issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Delete issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, "get" : { "x-atlassian-connect-scope" : "READ", "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "issueIdOrKey", "description" : "The ID or key of the issue." }, { "name" : "fields", "description" : "A comma-separated list of fields to return for the issue. Use it to retrieve a subset of fields. Allowed values:\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nExamples:\n\n * `summary,comment` Returns only the summary and comments fields.\n * `-description` Returns all (default) fields except description.\n * `*navigable,-comment` Returns all navigable fields except comment.\n\nThis parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`.\n\nNote: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields.", "in" : "query", "schema" : { "type" : "array", "items" : { "default" : "*all", "type" : "string" } } }, { "name" : "fieldsByKeys", "description" : "Indicates whether fields in `fields` are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.", "schema" : { "type" : "boolean", "default" : false }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts multiple values separated by a comma:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the `fields` parameter is ignored.", "name" : "expand" }, { "in" : "query", "schema" : { "items" : { "type" : "string", "default" : null }, "type" : "array" }, "description" : "A comma-separated list of issue properties to return for the issue. Allowed values:\n\n * `*all` Returns all issue properties.\n * Any issue property key, prefixed with a minus to exclude.\n\nExamples:\n\n * `*all` Returns all properties.\n * `*all,-prop1` Returns all properties except `prop1`.\n * `prop1,prop2` Returns `prop1` and `prop2` properties.\n\nThis parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`.", "name" : "properties" }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "name" : "updateHistory", "description" : "Indicates whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-3-search-get) `lastViewed` field." } ], "deprecated" : false, "tags" : [ "Issues" ], "description" : "Returns the details for an issue.\n\nThe issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is **not** returned. The issue key returned in the response is the key of the issue found.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueBean" }, "example" : "{\"id\":\"10002\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10002\",\"key\":\"ED-1\",\"fields\":{\"watcher\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:30.888+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"ED-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/ED-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Main order flow broken\"}]}]},\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}],\"issuelinks\":[{\"id\":\"10001\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PR-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-2\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}},{\"id\":\"10002\",\"type\":{\"id\":\"10000\",\"name\":\"Dependent\",\"inward\":\"depends on\",\"outward\":\"is depended by\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PR-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-3\",\"fields\":{\"status\":{\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"remainingEstimate\":\"3m\",\"timeSpent\":\"6m\",\"originalEstimateSeconds\":600,\"remainingEstimateSeconds\":200,\"timeSpentSeconds\":400}}}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." } }, "summary" : "Get issue", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getIssue_get" } }, "/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}" : { "post" : { "tags" : [ "Screens" ], "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the screen.", "name" : "screenId" }, { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the screen tab.", "name" : "tabId" }, { "description" : "The position of tab. The base index is 0.", "name" : "pos", "schema" : { "type" : "integer", "format" : "int32" }, "required" : true, "in" : "path" } ], "deprecated" : false, "x-atlassian-connect-scope" : "ADMIN", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the screen or screen tab is not found or the position is invalid." }, "400" : { "description" : "Returned if the request is invalid." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Moves a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.moveScreenTab_post", "summary" : "Move screen tab" } }, "/api/3/mypermissions" : { "get" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permissions" }, "example" : "{\"permissions\":{\"EDIT_ISSUE\":{\"id\":\"12\",\"key\":\"EDIT_ISSUES\",\"name\":\"Edit Issues\",\"type\":\"PROJECT\",\"description\":\"Ability to edit issues.\",\"havePermission\":true}}}" } } }, "404" : { "description" : "Returned if the project or issue is not found or the user does not have permission to view the project or issue.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if `permissions` is empty or the permission key it contains is not found or deprecated." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [] }, {} ], "description" : "Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.\n\nThe user is reported as having a project permission:\n\n * in the global context, if the user has the project permission in any project.\n * for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.\n * for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.\n\nThis means that users may be shown as having an issue permission (such as EDIT\\_ISSUE) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT\\_ISSUE permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT\\_ISSUE permission for that issue.\n\nGlobal permissions are unaffected by context.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "operationId" : "com.atlassian.jira.rest.v2.permission.PermissionsResource.getMyPermissions_get", "summary" : "Get my permissions", "tags" : [ "Permissions" ], "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "description" : "The key of project. Ignored if `projectId` is provided.", "name" : "projectKey" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "projectId", "description" : "The ID of project." }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "issueKey", "description" : "The key of the issue. Ignored if `issueId` is provided." }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The ID of the issue.", "name" : "issueId" }, { "name" : "permissions", "description" : "A comma-separated list of permission keys. [ Omitting this parameter is **deprecated**.](https://developer.atlassian.com/cloud/jira/platform/change-notice-get-my-permissions-requires-permissions-query-parameter/) To get the list of available permissions, use [Get all permissions](#api-rest-api-3-permissions-get). Note that deprecated keys cannot be used. Deprecated keys are not returned by [Get all permissions](#api-rest-api-3-permissions-get) but are returned by this operation if `permissions` is omitted.", "x-showInExample" : "true", "schema" : { "example" : "BROWSE_PROJECTS,EDIT_ISSUES", "type" : "string" }, "in" : "query" }, { "name" : "projectUuid", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "projectConfigurationUuid", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ" } }, "/api/3/mypreferences" : { "put" : { "operationId" : "com.atlassian.jira.rest.v2.preference.CurrentUserPreferencesResource.setPreference_put", "summary" : "Set preference", "security" : [ { "basicAuth" : [] } ], "description" : "Creates a preference for the user or updates a preference's value by sending a plain text string. For example, `false`. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:\n\n * *user.notifications.mimetype* The mime type used in notifications sent to the user. Defaults to `html`.\n * *user.notify.own.changes* Indicates whether the user gets notified of their own changes. Defaults to `false`.\n * *jira.user.locale* The locale of the user. By default, not set: the user takes the instance locale. See also, [Set locale](#api-rest-api-3-mypreferences-locale-put).\n * *jira.user.timezone* The time zone of the user. By default, not set, the user takes the instance time zone.\n * *user.default.share.private* Indicates whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. Defaults to `true`.\n * *user.keyboard.shortcuts.disabled* Indicates whether keyboard shortcuts are disabled. Defaults to `false`.\n * *user.autowatch.disabled* Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "404" : { "description" : "Returned if the key or value is not provided or invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." } }, "requestBody" : { "description" : "The value of the preference as a plain text string. The maximum length is 255 characters.", "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } }, "required" : true }, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "required" : true, "name" : "key", "description" : "The key of the preference. The maximum length is 255 characters." } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Myself" ] }, "get" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "required" : true, "in" : "query", "schema" : { "type" : "string" }, "description" : "The key of the preference.", "name" : "key" } ], "deprecated" : false, "tags" : [ "Myself" ], "description" : "Returns the value of a preference of the current user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "404" : { "description" : "Returned if the key is not provided or not found." } }, "summary" : "Get preference", "operationId" : "com.atlassian.jira.rest.v2.preference.CurrentUserPreferencesResource.getPreference_get" }, "delete" : { "parameters" : [ { "description" : "The key of the preference.", "name" : "key", "required" : true, "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Myself" ], "operationId" : "com.atlassian.jira.rest.v2.preference.CurrentUserPreferencesResource.removePreference_delete", "summary" : "Delete preference", "security" : [ { "basicAuth" : [] } ], "description" : "Deletes a preference of the user, which restores the default value of system defined settings.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "404" : { "description" : "Returned if the key is not provided or not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "204" : { "description" : "Returned if the request is successful." } } } }, "/api/3/component" : { "post" : { "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component" }, "example" : { "name" : "Component 1", "isAssigneeTypeValid" : false, "description" : "This is a Jira component", "project" : "HSP", "leadAccountId" : "5b10a2844c20165700ede21g", "assigneeType" : "PROJECT_LEAD" } } }, "required" : true }, "tags" : [ "Project components" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN", "operationId" : "com.atlassian.jira.rest.v2.issue.ComponentResource.createComponent_post", "summary" : "Create component", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Component" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to browse the project containing the component." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira." }, "400" : { "description" : "Returned if:\n\n * The user is not found.\n * `name` is not provided.\n * `name` is over 255 characters in length.\n * `projectId` is not provided.\n * `assigneeType` is an invalid value." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Creates a component. Use components to provide containers for issues within a project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the component is created or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } }, "/api/3/filter" : { "post" : { "responses" : { "400" : { "description" : "Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}", "schema" : { "$ref" : "#/components/schemas/Filter" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "summary" : "Create filter", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.createFilter_post", "tags" : [ "Filters" ], "x-atlassian-connect-scope" : "WRITE", "deprecated" : false, "parameters" : [ { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." } ], "requestBody" : { "content" : { "application/json" : { "example" : { "description" : "Lists all open bugs", "name" : "All Open Bugs", "jql" : "type = Bug and resolution is empty" }, "schema" : { "$ref" : "#/components/schemas/Filter" } } }, "description" : "The filter to create.", "required" : true } }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getFilters_get", "summary" : "Get filters", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all filters. Deprecated, use [ Search for filters](#api-rest-api-3-filter-search-get) that supports search and pagination.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, only the following filters are returned:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "deprecated" : true, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`.", "name" : "expand" } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Filters" ] } }, "/api/3/filter/defaultShareScope" : { "get" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"scope\":\"GLOBAL\"}", "schema" : { "$ref" : "#/components/schemas/DefaultShareScope" } } }, "description" : "Returned if the request is successful." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the default sharing settings for new filters and dashboards for a user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getDefaultShareScope_get", "summary" : "Get default share scope", "tags" : [ "Filter sharing" ], "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "READ" }, "put" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DefaultShareScope" }, "example" : { "scope" : "GLOBAL" } } } }, "tags" : [ "Filter sharing" ], "x-atlassian-connect-scope" : "WRITE", "parameters" : [], "deprecated" : false, "summary" : "Set default share scope", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.setDefaultShareScope_put", "responses" : { "400" : { "description" : "Returned if an invalid scope is set." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DefaultShareScope" }, "example" : "{\"scope\":\"GLOBAL\"}" } } } }, "description" : "Sets the default sharing for new filters and dashboards for a user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ] } }, "/api/3/configuration/timetracking/list" : { "get" : { "description" : "Returns all time tracking providers. By default, Jira only has one time tracking provider: *JIRA provided time tracking*. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the [ Time Tracking Provider](https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/) module.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TimeTrackingProvider" } }, "example" : "[{\"key\":\"Jira\",\"name\":\"JIRA provided time tracking\",\"url\":\"/example/config/url\"}]" } }, "description" : "Returned if the request is successful." } }, "summary" : "Get all time tracking providers", "operationId" : "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.getAvailableTimeTrackingImplementations_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [], "tags" : [ "Time tracking" ] } }, "/api/3/mypreferences/locale" : { "put" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [], "tags" : [ "Myself" ], "requestBody" : { "content" : { "application/json" : { "example" : { "locale" : "en_US" }, "schema" : { "$ref" : "#/components/schemas/Locale" } } }, "description" : "The locale defined in a LocaleBean.", "required" : true }, "description" : "Sets the locale of the user. The locale must be one supported by the instance of Jira.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if request is invalid." }, "204" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } }, "summary" : "Set locale", "operationId" : "com.atlassian.jira.rest.v2.preference.CurrentUserPreferencesResource.setLocale_put" }, "get" : { "summary" : "Get locale", "operationId" : "com.atlassian.jira.rest.v2.preference.CurrentUserPreferencesResource.getLocale_get", "description" : "Returns the locale for the user.\n\nIf the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the *Accept-Language* header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Locale" }, "example" : "{\"locale\":\"en_US\"}" } } } }, "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [], "tags" : [ "Myself" ] }, "delete" : { "tags" : [ "Myself" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [], "deprecated" : false, "summary" : "Delete locale", "operationId" : "com.atlassian.jira.rest.v2.preference.CurrentUserPreferencesResource.deleteLocale_delete", "responses" : { "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Deletes the locale of the user, which restores the default setting.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] } ] } }, "/api/3/worklog/list" : { "post" : { "tags" : [ "Issue worklogs" ], "parameters" : [ { "in" : "query", "schema" : { "default" : "", "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog.", "name" : "expand" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "requestBody" : { "required" : true, "description" : "A JSON object containing a list of worklog IDs.", "content" : { "application/json" : { "example" : { "ids" : [ 1, 2, 5, 10 ] }, "schema" : { "$ref" : "#/components/schemas/WorklogIdsRequestBean" } } } }, "responses" : { "400" : { "description" : "Returned if the request contains more than 1000 worklog IDs or is empty." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Worklog" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]" } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Returns worklog details for a list of worklog IDs.\n\nThe returned list of worklogs is limited to 1000 items.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:\n\n * the worklog is set as *Viewable by All Users*.\n * the user is a member of a project role or group with permission to view the worklog.", "operationId" : "com.atlassian.jira.rest.v2.issue.worklog.WorklogResource.getWorklogsForIds_post", "summary" : "Get worklogs" } }, "/api/3/issue/properties" : { "post" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueEntityProperties" } } }, "description" : "Issue properties to be set/updated with values. For more information" }, "x-experimental" : true, "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Issue properties" ], "operationId" : "com.atlassian.jira.rest.v2.property.IssuePropertyBulkUpdateResource.bulkSetIssuesProperties_post", "summary" : "Bulk set issues properties", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] } ], "description" : "Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously.\n\nThis operation is:\n\n * transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated.\n * [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "responses" : { "303" : { "description" : "Returned if the operation is successful." }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Return if the request is invalid or the user does not have the necessary permissions." }, "401" : { "description" : "Returned if the authentication conventions are incorrect.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } } } }, "/api/3/screens/{screenId}/tabs/{tabId}" : { "delete" : { "tags" : [ "Screens" ], "parameters" : [ { "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "The ID of the screen.", "name" : "screenId" }, { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the screen tab.", "name" : "tabId" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.deleteScreenTab_delete", "summary" : "Delete screen tab", "responses" : { "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the screen or screen tab is not found." } }, "security" : [ { "basicAuth" : [] }, {} ], "description" : "Deletes a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, "put" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.renameScreenTab_put", "summary" : "Update screen tab", "security" : [ { "basicAuth" : [] }, {} ], "description" : "Updates the name of a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "200" : { "content" : { "application/json" : { "example" : "{\"id\":10000,\"name\":\"Fields Tab\"}", "schema" : { "$ref" : "#/components/schemas/ScreenableTab" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the screen or screen tab is not found." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenableTab" } } } }, "deprecated" : false, "parameters" : [ { "name" : "screenId", "description" : "The ID of the screen.", "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" } }, { "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true, "name" : "tabId", "description" : "The ID of the screen tab." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Screens" ] } }, "/api/3/component/{id}/relatedIssueCounts" : { "get" : { "parameters" : [ { "name" : "id", "description" : "The ID of the component.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Project components" ], "operationId" : "com.atlassian.jira.rest.v2.issue.ComponentResource.getComponentRelatedIssues_get", "summary" : "Get component issues count", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the counts of issues assigned to the component.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "404" : { "description" : "Returned if the component is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ComponentIssuesCount" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"issueCount\":23}" } }, "description" : "Returned if the request is successful." } } } }, "/api/3/priority" : { "get" : { "description" : "Returns the list of all issue priorities.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Priority" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\"}]" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } }, "summary" : "Get priorities", "operationId" : "com.atlassian.jira.rest.v2.issue.PriorityResource.getPriorities_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [], "tags" : [ "Issue priorities" ] } }, "/api/3/project/{projectIdOrKey}/avatar/{id}" : { "delete" : { "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The project ID or (case-sensitive) key.", "name" : "projectIdOrKey" }, { "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "The ID of the avatar.", "name" : "id" } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Project avatars" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Deletes a custom avatar from a project. Note that system avatars cannot be deleted.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).", "responses" : { "404" : { "description" : "Returned if the project or avatar is not found or the user does not have permission to view the project." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the avatar is a system avatar or the user does not have permission to administer the project." }, "204" : { "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.deleteProjectAvatar_delete", "summary" : "Delete project avatar" } }, "/api/3/applicationrole/{key}" : { "get" : { "summary" : "Get application role", "operationId" : "com.atlassian.jira.rest.v2.admin.applicationrole.ApplicationRoleResource.getApplicationRole_get", "description" : "Returns an application role.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "403" : { "description" : "Returned if the user is not an administrator." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationRole" }, "example" : "{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5 developers\",\"hasUnlimitedSeats\":false,\"platform\":false}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the role is not found." } }, "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "x-showInExample" : "true", "name" : "key", "description" : "The key of the application role. Use the [Get all application roles](#api-rest-api-3-applicationrole-get) operation to get the key for each application role.", "in" : "path", "required" : true, "schema" : { "type" : "string", "example" : "jira-software" } } ], "deprecated" : false, "tags" : [ "Application roles" ] } }, "/api/3/configuration" : { "get" : { "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Jira settings" ], "operationId" : "com.atlassian.jira.rest.v2.admin.ConfigurationResource.getConfiguration_get", "summary" : "Get global settings", "security" : [ { "basicAuth" : [] }, {} ], "description" : "Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"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\"}}", "schema" : { "$ref" : "#/components/schemas/Configuration" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } } } }, "/api/3/resolution/{id}" : { "get" : { "summary" : "Get resolution", "operationId" : "com.atlassian.jira.rest.v2.issue.ResolutionResource.getResolution_get", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/resolution/1\",\"id\":\"10000\",\"description\":\"A fix for this issue is checked into the tree and tested.\",\"name\":\"Fixed\"}", "schema" : { "$ref" : "#/components/schemas/Resolution" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue resolution value is not found." } }, "description" : "Returns an issue resolution value.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "tags" : [ "Issue resolutions" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the issue resolution value.", "name" : "id" } ] } }, "/api/3/webhook/refresh" : { "put" : { "tags" : [ "Webhooks" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "webhookIds" : [ 10000, 10001, 10042 ] }, "schema" : { "$ref" : "#/components/schemas/ContainerForWebhookIDs" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhooksExpirationDate" }, "example" : "{\"expirationDate\":\"2019-06-01T12:42:30.000+0000\"}" } }, "description" : "Returned if the request is successful." }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the request is invalid." }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the caller is not a Connect app." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive.\n\nUnrecognized webhook IDs (nonexistent or belonging to other apps) are ignored. **[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.", "operationId" : "com.atlassian.jira.rest.v2.webhook.DynamicWebhookResource.refreshWebhooks_put", "summary" : "Extend webhook life" } }, "/api/3/project/{projectIdOrKey}/properties/{propertyKey}" : { "put" : { "parameters" : [ { "description" : "The project ID or project key (case sensitive).", "name" : "projectIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "propertyKey", "description" : "The key of the project property. The maximum length is 255 characters." } ], "deprecated" : false, "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Project properties" ], "requestBody" : { "content" : { "application/json" : { "schema" : {}, "example" : { "string" : "string-value", "number" : 5 } } }, "required" : true }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Sets the value of the [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). You can use project properties to store custom data against the project.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the property is created.", "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the project property is created." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the project property is updated." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if the project is not found." }, "403" : { "description" : "Returned if the user does not have permission to administer the project." }, "400" : { "description" : "Returned if the project key or id is invalid." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectPropertyResource.setProjectProperty_put", "summary" : "Set project property" }, "delete" : { "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys.", "name" : "propertyKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "deprecated" : false, "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Project properties" ], "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectPropertyResource.deleteProjectProperty_delete", "summary" : "Delete project property", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Deletes the [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) from a project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.", "responses" : { "404" : { "description" : "Returned if the project or property is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "400" : { "description" : "Returned if the request is not valid." }, "403" : { "description" : "Returned if the user does not have permission to administer the project." }, "204" : { "description" : "Returned if the project property is deleted." } } }, "get" : { "description" : "Returns the value of a [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "400" : { "description" : "Returned if the request is not valid." }, "403" : { "description" : "Returned if the user does not have permission to view the project." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityProperty" }, "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if the project or property is not found." } }, "summary" : "Get project property", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectPropertyResource.getProjectProperty_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "description" : "The project ID or project key (case sensitive).", "name" : "projectIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "description" : "The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys.", "name" : "propertyKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "tags" : [ "Project properties" ] } }, "/api/3/field" : { "get" : { "responses" : { "200" : { "content" : { "application/json" : { "example" : "[{\"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\"}}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FieldDeprecated" } } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Returns system and custom issue fields according to the following rules:\n\n * Fields that cannot be added to the issue navigator are always returned.\n * Fields that cannot be placed on an issue screen are always returned.\n * Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.\n * For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.)\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get fields", "operationId" : "com.atlassian.jira.rest.v2.issue.FieldResource.getFields_get", "tags" : [ "Issue fields" ], "x-atlassian-connect-scope" : "READ", "parameters" : [], "deprecated" : false }, "post" : { "responses" : { "201" : { "content" : { "application/json" : { "example" : "{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}}", "schema" : { "$ref" : "#/components/schemas/FieldDeprecated" } } }, "description" : "Returned if the custom field is created." }, "400" : { "description" : "Returned if:\n\n * the user does not have permission to create custom fields.\n * any of the request object properties have invalid or missing values." } }, "description" : "Creates a custom field.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "summary" : "Create custom field", "operationId" : "com.atlassian.jira.rest.v2.issue.FieldResource.createCustomField_post", "tags" : [ "Issue fields" ], "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [], "requestBody" : { "required" : true, "description" : "Definition of the custom field to be created", "content" : { "application/json" : { "example" : { "type" : "com.atlassian.jira.plugin.system.customfieldtypes:grouppicker", "name" : "New custom field", "description" : "Custom field for picking groups", "searcherKey" : "com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher" }, "schema" : { "$ref" : "#/components/schemas/CustomFieldDefinitionJsonBean" } } } } } }, "/api/3/issue/{issueIdOrKey}/comment" : { "post" : { "summary" : "Add comment", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueCommentResource.addComment_post", "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}", "schema" : { "$ref" : "#/components/schemas/Comment" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." } }, "description" : "Adds a comment to an issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Add comments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "visibility" : { "type" : "role", "value" : "Administrators" }, "body" : { "type" : "doc", "content" : [ { "content" : [ { "text" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.", "type" : "text" } ], "type" : "paragraph" } ], "version" : 1 } }, "schema" : { "$ref" : "#/components/schemas/Comment" } } } }, "tags" : [ "Issue comments" ], "x-atlassian-connect-scope" : "WRITE", "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML." } ] }, "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "default" : 0, "format" : "int64", "type" : "integer" }, "in" : "query" }, { "schema" : { "format" : "int32", "type" : "integer", "default" : 50 }, "in" : "query", "description" : "The maximum number of items to return per page. The maximum is `100`.", "name" : "maxResults" }, { "in" : "query", "schema" : { "type" : "string", "enum" : [ "created", "-created" ] }, "description" : "The field to order returned comments by. Only accepts the value *created*, which orders comments by their created date.", "name" : "orderBy" }, { "description" : "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.", "name" : "expand", "in" : "query", "schema" : { "type" : "string" } } ], "tags" : [ "Issue comments" ], "summary" : "Get comments", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueCommentResource.getComments_get", "description" : "Returns all comments for an issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Comments are included in the response where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageOfComments" }, "example" : "{\"startAt\":0,\"maxResults\":1,\"total\":1,\"comments\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}]}" } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if `orderBy` is set to a value other than *created*." } } } }, "/api/3/worklog/deleted" : { "get" : { "deprecated" : false, "parameters" : [ { "schema" : { "default" : 0, "format" : "int64", "type" : "integer" }, "in" : "query", "name" : "since", "description" : "The date and time, in UNIX timestamp format, after which deleted worklogs are returned." } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue worklogs" ], "operationId" : "com.atlassian.jira.rest.v2.issue.worklog.WorklogResource.getIdsOfWorklogsDeletedSince_get", "summary" : "Get IDs of deleted worklogs", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.\n\nThis resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs.\n\nThis resource does not return worklogs deleted during the minute preceding the request.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://your-domain.atlassian.net/worklog/deleted?since=1438013671562\",\"nextPage\":\"http://your-domain.atlassian.net/worklog/deleted?since=1438013693136\",\"lastPage\":true}", "schema" : { "$ref" : "#/components/schemas/ChangedWorklogs" } } }, "description" : "Returned if the request is successful." } } } }, "/api/3/version/{id}" : { "put" : { "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the version.", "name" : "id" } ], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Project versions" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Version" }, "example" : { "self" : "http://your-domain.atlassian.net/rest/api/~ver~/version/10000", "userReleaseDate" : "6/Jul/2010", "archived" : false, "projectId" : 10000, "description" : "An excellent version", "name" : "New Version 1", "released" : true, "overdue" : true, "releaseDate" : "2010-07-06T00:00:00.000Z", "id" : "10000" } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Updates a project version.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.", "responses" : { "400" : { "description" : "Returned if:\n\n * the request is invalid.\n * the user does not have the required permissions." }, "404" : { "description" : "Returned if the version is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"userReleaseDate\":\"6/Jul/2010\",\"project\":\"PXA\",\"projectId\":10000}", "schema" : { "$ref" : "#/components/schemas/Version" } } }, "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.updateVersion_put", "summary" : "Update version" }, "delete" : { "responses" : { "404" : { "description" : "Returned if the version is not found." }, "401" : { "description" : "Returned if:\n\n * the authentication credentials are incorrect.\n * the user does not have the required permissions." }, "400" : { "description" : "Returned if the request is invalid." }, "204" : { "description" : "Returned if the version is deleted." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Deletes a project version.\n\nDeprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) that supports swapping version values in custom fields, in addition to the swapping for `fixVersion` and `affectedVersion` provided in this resource.\n\nAlternative versions can be provided to update issues that use the deleted version in `fixVersion` or `affectedVersion`. If alternatives are not provided, occurrences of `fixVersion` and `affectedVersion` that contain the deleted version are cleared.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.", "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.deleteVersion_delete", "summary" : "Delete version", "tags" : [ "Project versions" ], "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the version.", "name" : "id" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "The ID of the version to update `fixVersion` to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.", "name" : "moveFixIssuesTo" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "moveAffectedIssuesTo", "description" : "The ID of the version to update `affectedVersion` to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted." } ], "deprecated" : true, "x-atlassian-connect-scope" : "PROJECT_ADMIN" }, "get" : { "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"overdue\":true,\"userReleaseDate\":\"6/Jul/2010\",\"projectId\":10000}", "schema" : { "$ref" : "#/components/schemas/Version" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the version is not found or the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a project version.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the version.", "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.getVersion_get", "summary" : "Get version", "tags" : [ "Project versions" ], "deprecated" : false, "parameters" : [ { "description" : "The ID of the version.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about version in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property represents the number of issues with a status other than *to do*, *in progress*, and *done*." } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/issue/{issueIdOrKey}/properties" : { "get" : { "tags" : [ "Issue properties" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The key or ID of the issue.", "name" : "issueIdOrKey" } ], "x-atlassian-connect-scope" : "READ", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PropertyKeys" }, "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}" } } }, "404" : { "description" : "Returned if the issue is not found or the user does not have permissions to view the issue." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the URLs and keys of an issue's properties.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Property details are only returned where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssuePropertyResource.getIssuePropertyKeys_get", "summary" : "Get issue property keys" } }, "/api/3/notificationscheme/{id}" : { "get" : { "summary" : "Get notification scheme", "operationId" : "com.atlassian.jira.rest.v2.notification.NotificationSchemeResource.getNotificationScheme_get", "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NotificationScheme" }, "example" : "{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://your-domain.atlassian.net/rest/api/3/notificationscheme\",\"name\":\"notification scheme name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom event\",\"description\":\"Custom event that is published together with an issue created event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}" } } }, "404" : { "description" : "Returned if the notification scheme is not found or the user does not have permission to view it." } }, "description" : "Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "tags" : [ "Issue notification schemes" ], "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "description" : "The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) to get a list of notification scheme IDs.", "name" : "id", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `all` Returns all expandable information.\n * `field` Returns information about any custom fields assigned to receive an event.\n * `group` Returns information about any groups assigned to receive an event.\n * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information.\n * `projectRole` Returns information about any project roles assigned to receive an event.\n * `user` Returns information about any users assigned to receive an event.", "name" : "expand" } ], "deprecated" : false } }, "/api/3/user/search" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.findUsers_get", "summary" : "Find users", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "description" : "Returns a list of users that match the provided search string and property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls or calls by users without the required permission return empty search results.\n\n**Note:** This API is designed to return a small number of users with a flexible search query. As such, the sum of `startAt` and `maxResults` must be less than 1000. If the sum is greater, only results up to the 1000th result will be returned. If you wish to get a larger number of users, please use the get-all-users API (`/rest/api/3/users/search`) instead.", "responses" : { "400" : { "description" : "Returned if:\n\n * `accountId`, `query` or `property` is missing.\n * `query` and `accountId` are provided.\n * `property` parameter is not valid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5\",\"key\":\"\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32\"},\"displayName\":\"Emma Richards\",\"active\":false}]", "schema" : { "items" : { "$ref" : "#/components/schemas/User" }, "type" : "array" } } }, "description" : "Returned if the request is successful." } }, "deprecated" : false, "parameters" : [ { "schema" : { "example" : "query", "type" : "string" }, "in" : "query", "description" : "A query string that is matched against user attributes ( `displayName`, and `emailAddress`) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` or `property` is specified.", "name" : "query", "x-showInExample" : "true" }, { "name" : "username", "schema" : { "type" : "string" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "accountId", "description" : "A query string that is matched against a user accountId. The string must match the accountId exactly. Required, unless `query` or `property` is specified." }, { "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "description" : "The maximum number of items to return per page. The maximum is `1000`.", "name" : "maxResults", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "description" : "A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of `nested` from `{\"something\":{\"nested\":1,\"other\":2}}` use `thepropertykey.something.nested=1`. Required, unless `accountId` or `query` are specified.", "name" : "property", "schema" : { "type" : "string" }, "in" : "query" } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "User search" ] } }, "/api/3/securitylevel/{id}" : { "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Returns details of an issue security level.\n\nUse [Get issue security scheme](#api-rest-api-3-issuesecurityschemes-id-get) to obtain the IDs of issue security levels associated with the issue security scheme.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "404" : { "description" : "Returned if the issue security level is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"}", "schema" : { "$ref" : "#/components/schemas/SecurityLevel" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.IssueSecurityLevelResource.getIssueSecurityLevel_get", "summary" : "Get issue security level", "parameters" : [ { "description" : "The ID of the issue security level.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Issue security level" ] } }, "/api/3/issue/{issueIdOrKey}/comment/{id}" : { "delete" : { "x-atlassian-connect-scope" : "DELETE", "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "issueIdOrKey", "description" : "The ID or key of the issue." }, { "description" : "The ID of the comment.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "tags" : [ "Issue comments" ], "summary" : "Delete comment", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueCommentResource.deleteComment_delete", "description" : "Deletes a comment.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Delete all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to delete any comment or *Delete own comments* to delete comment created by the user,\n * If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue or comment is not found or the user does not have permission to view the issue or comment." }, "204" : { "description" : "Returned if the request is successful." }, "405" : { "description" : "Returned if an anonymous call is made to the operation." }, "400" : { "description" : "Returned if the user does not have permission to delete the comment." } } }, "get" : { "description" : "Returns a comment.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the issue or comment is not found or the user does not have permission to view the issue or comment." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Comment" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "summary" : "Get comment", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueCommentResource.getComment_get", "x-atlassian-connect-scope" : "READ", "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "name" : "id", "description" : "The ID of the comment.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.", "name" : "expand", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "Issue comments" ] }, "put" : { "responses" : { "400" : { "description" : "Returned if the user does not have permission to edit the comment or the request is invalid." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}", "schema" : { "$ref" : "#/components/schemas/Comment" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue or comment is not found or the user does not have permission to view the issue or comment." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Updates a comment.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue containing the comment is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Edit all comments*[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any comment or *Edit own comments* to update comment created by the user.\n * If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueCommentResource.updateComment_put", "summary" : "Update comment", "tags" : [ "Issue comments" ], "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "description" : "The ID of the comment.", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "description" : "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML.", "name" : "expand", "schema" : { "type" : "string" }, "in" : "query" } ], "x-atlassian-connect-scope" : "WRITE", "requestBody" : { "content" : { "application/json" : { "example" : { "body" : { "content" : [ { "content" : [ { "type" : "text", "text" : "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper." } ], "type" : "paragraph" } ], "type" : "doc", "version" : 1 }, "visibility" : { "value" : "Administrators", "type" : "role" } }, "schema" : { "$ref" : "#/components/schemas/Comment" } } }, "required" : true } } }, "/api/3/issueLink/{linkId}" : { "delete" : { "x-atlassian-connect-scope" : "DELETE", "parameters" : [ { "name" : "linkId", "description" : "The ID of the issue link.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "Issue links" ], "description" : "Deletes an issue link.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * Browse project [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues in the link.\n * *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for at least one of the projects containing issues in the link.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the issue link ID is invalid." }, "200" : { "description" : "200 response" }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the issue link is not found.\n * the user doesn't have the required permissions." } }, "summary" : "Delete issue link", "operationId" : "com.atlassian.jira.rest.v2.issue.LinkIssueResource.deleteIssueLink_delete" }, "get" : { "responses" : { "400" : { "description" : "Returned if the issue link ID is invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueLink" }, "example" : "{\"id\":\"10001\",\"type\":{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"},\"inwardIssue\":{\"id\":\"10004\",\"key\":\"PR-3\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-3\",\"fields\":{\"status\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}},\"priority\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/5\",\"statusColor\":\"#cfcfcf\",\"description\":\"Very little impact.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/trivial.png\",\"name\":\"Trivial\",\"id\":\"2\"},\"issuetype\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}}},\"outwardIssue\":{\"id\":\"10004L\",\"key\":\"PR-2\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/PR-2\",\"fields\":{\"status\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},\"priority\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/priority/3\",\"statusColor\":\"#009900\",\"description\":\"Major loss of function.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/priorities/major.png\",\"name\":\"Major\",\"id\":\"1\"},\"issuetype\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1}}}}" } } }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the issue link is not found.\n * the user doesn't have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns an issue link.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the linked issues.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, permission to view both of the issues.", "operationId" : "com.atlassian.jira.rest.v2.issue.LinkIssueResource.getIssueLink_get", "summary" : "Get issue link", "tags" : [ "Issue links" ], "deprecated" : false, "parameters" : [ { "name" : "linkId", "description" : "The ID of the issue link.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/attachment/{id}/expand/raw" : { "get" : { "responses" : { "403" : { "description" : "The user does not have the required permissions." }, "409" : { "description" : "Returned if the attachment is an archive, but not a supported archive format." }, "200" : { "description" : "Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.", "content" : { "application/json" : { "example" : "{\"entries\":[{\"entryIndex\":0,\"name\":\"Allegro from Duet in C Major.mp3\",\"size\":1430174,\"mediaType\":\"audio/mpeg\"},{\"entryIndex\":1,\"name\":\"lrm.rtf\",\"size\":331,\"mediaType\":\"text/rtf\"}],\"totalEntryCount\":24}", "schema" : { "$ref" : "#/components/schemas/AttachmentArchiveImpl" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings." } }, "description" : "Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported.\n\nUse this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use [ Get all metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-human-get) which also returns the metadata for the attachment itself, such as the attachment's ID and name.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get contents metadata for an expanded attachment", "operationId" : "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.expandAttachmentForMachines_get", "tags" : [ "Issue attachments" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the attachment.", "name" : "id" } ], "deprecated" : false, "x-experimental" : true } }, "/api/3/filter/my" : { "get" : { "tags" : [ "Filters" ], "deprecated" : false, "parameters" : [ { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`.", "name" : "expand" }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "description" : "Include the user's favorite filters in the response.", "name" : "includeFavourites" } ], "x-atlassian-connect-scope" : "READ", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getMyFilters_get", "summary" : "Get my filters", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}}],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}]" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:\n\n * owned by the user.\n * shared with a group that the user is a member of.\n * shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * shared with a public project.\n * shared with the public.\n\nFor example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation." } }, "/api/3/workflowscheme/{id}/draft/workflow" : { "delete" : { "summary" : "Delete issue types for workflow in draft workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteDraftWorkflowMapping_delete", "responses" : { "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * The workflow is not found.\n * The workflow is not specified." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful." } }, "description" : "Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "tags" : [ "Workflow scheme drafts" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the workflow scheme that the draft belongs to." }, { "schema" : { "type" : "string" }, "required" : true, "in" : "query", "description" : "The name of the workflow.", "name" : "workflowName" } ], "deprecated" : false }, "get" : { "security" : [ { "basicAuth" : [] } ], "description" : "Returns the workflow-issue type mappings for a workflow scheme's draft.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypesWorkflowMapping" }, "example" : "{\"workflow\":\"jira\",\"issueTypes\":[\"10000\",\"10001\"],\"defaultMapping\":false}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if either the workflow scheme or workflow (if specified) is not found. session." }, "403" : { "description" : "Returned if the user is not permitted to create workflows." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getDraftWorkflow_get", "summary" : "Get issue types for workflows in draft workflow scheme", "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the workflow scheme that the draft belongs to.", "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" } }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.", "name" : "workflowName" } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow scheme drafts" ] }, "put" : { "requestBody" : { "content" : { "application/json" : { "example" : { "workflow" : "jira", "updateDraftIfNeeded" : true, "issueTypes" : [ "10000" ] }, "schema" : { "$ref" : "#/components/schemas/IssueTypesWorkflowMapping" } } }, "required" : true }, "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "name" : "id", "description" : "The ID of the workflow scheme that the draft belongs to." }, { "schema" : { "type" : "string" }, "required" : true, "in" : "query", "description" : "The name of the workflow.", "name" : "workflowName" } ], "deprecated" : false, "tags" : [ "Workflow scheme drafts" ], "summary" : "Set issue types for workflow in workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.updateDraftWorkflowMapping_put", "description" : "Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } } }, "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * The workflow is not found.\n * The workflow is not specified." } } } }, "/api/3/issue/{issueIdOrKey}/properties/{propertyKey}" : { "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The key or ID of the issue.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The key of the property.", "name" : "propertyKey" } ], "tags" : [ "Issue properties" ], "summary" : "Get issue property", "operationId" : "com.atlassian.jira.rest.v2.issue.IssuePropertyResource.getIssueProperty_get", "description" : "Returns the key and value of an issue's property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}", "schema" : { "$ref" : "#/components/schemas/EntityProperty" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue or property is not found or the user does not have permission to see the issue." } } }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssuePropertyResource.deleteIssueProperty_delete", "summary" : "Delete issue property", "responses" : { "204" : { "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the issue or property is not found, or the user does not have permission to edit the issue." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes an issue's property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "tags" : [ "Issue properties" ], "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The key or ID of the issue.", "name" : "issueIdOrKey" }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "propertyKey", "description" : "The key of the property." } ], "x-atlassian-connect-scope" : "DELETE" }, "put" : { "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the issue property is created." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the issue property is updated.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view the issue." }, "403" : { "description" : "Returned if the user does not have permission to edit the issue." }, "400" : { "description" : "Returned if the request is invalid." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Sets the value of an issue's property. Use this resource to store custom data against an issue.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Edit issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssuePropertyResource.setIssueProperty_put", "summary" : "Set issue property", "tags" : [ "Issue properties" ], "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "issueIdOrKey", "description" : "The ID or key of the issue." }, { "name" : "propertyKey", "description" : "The key of the issue property. The maximum length is 255 characters.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "deprecated" : false, "x-atlassian-connect-scope" : "WRITE", "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : {} } } } } }, "/api/3/project/{projectIdOrKey}/avatars" : { "get" : { "description" : "Returns all project avatars, grouped by system and custom avatars.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the the project is not found or the user does not have permission to view the project." }, "200" : { "description" : "Returned if request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectAvatars" }, "example" : "{\"system\":[{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project\"}}],\"custom\":[{\"id\":\"1010\",\"isSystemAvatar\":false,\"isSelected\":false,\"isDeletable\":true,\"urls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project\",\"24x24\":\"https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project\",\"32x32\":\"https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project\",\"48x48\":\"https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project\"}}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "summary" : "Get all project avatars", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getAllProjectAvatars_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "description" : "The ID or (case-sensitive) key of the project.", "name" : "projectIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "tags" : [ "Project avatars" ] } }, "/api/3/issuesecurityschemes" : { "get" : { "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Issue security schemes" ], "operationId" : "com.atlassian.jira.rest.v2.issue.IssueSecuritySchemeResource.getIssueSecuritySchemes_get", "summary" : "Get issue security schemes", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Returns all [issue security schemes](https://confluence.atlassian.com/x/J4lKLg).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"issueSecuritySchemes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000\",\"id\":10000,\"name\":\"Default Issue Security Scheme\",\"description\":\"Description for the default issue security scheme\",\"defaultSecurityLevelId\":10021}]}", "schema" : { "$ref" : "#/components/schemas/SecuritySchemes" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "403" : { "description" : "Returned if the user does not have permission to administer issue security schemes." } } } }, "/api/3/filter/{id}/permission/{permissionId}" : { "delete" : { "deprecated" : false, "parameters" : [ { "description" : "The ID of the filter.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "permissionId", "description" : "The ID of the share permission.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true } ], "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Filter sharing" ], "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.deleteSharePermission_delete", "summary" : "Delete share permission", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes a share permission from a filter.\n\n**[Permissions](#permissions) required:** Permission to access Jira and the user must own the filter.", "responses" : { "204" : { "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the filter is not found.\n * the user does not own the filter." } } }, "get" : { "summary" : "Get share permission", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getSharePermission_get", "description" : "Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, a share permission is only returned for:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if:\n\n * the filter is not found.\n * the permission is not found.\n * the user does not have permission to view the filter." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SharePermission" }, "example" : "{\"id\":10000,\"type\":\"global\"}" } } } }, "x-atlassian-connect-scope" : "READ", "parameters" : [ { "description" : "The ID of the filter.", "name" : "id", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" }, { "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true, "name" : "permissionId", "description" : "The ID of the share permission." } ], "deprecated" : false, "tags" : [ "Filter sharing" ] } }, "/api/3/filter/search" : { "get" : { "tags" : [ "Filters" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "filterName", "description" : "String used to perform a case-insensitive partial match with `name`.", "schema" : { "type" : "string" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "accountId", "description" : "User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`." }, { "description" : "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with `accountId`.", "name" : "owner", "schema" : { "type" : "string" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "groupname", "description" : "Group name used to returns filters that are shared with a group that matches `sharePermissions.group.groupname`." }, { "name" : "projectId", "description" : "Project ID used to returns filters that are shared with a project that matches `sharePermissions.project.id`.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "query" }, { "schema" : { "enum" : [ "id", "name", "description", "owner", "favorite_count", "is_favorite", "-id", "-name", "-description", "-owner", "-favorite_count", "-is_favorite" ], "default" : "name", "type" : "string" }, "in" : "query", "description" : "[Orders](#ordering) the results using one of these filter properties:\n\n * `description` Orders by filter `description`. Note that this ordering works independently of whether the expand to display the description field is in use.\n * `favourite_count` Orders by `favouritedCount`.\n * `is_favourite` Orders by `favourite`.\n * `id` Orders by filter `id`.\n * `name` Orders by filter `name`.\n * `owner` Orders by `owner.accountId`.", "name" : "orderBy" }, { "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt", "schema" : { "default" : 0, "format" : "int64", "type" : "integer" }, "in" : "query" }, { "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `100`.", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `description` Returns the description of the filter.\n * `favourite` Returns an indicator of whether the user has set the filter as a favorite.\n * `favouritedCount` Returns a count of how many users have set this filter as a favorite.\n * `jql` Returns the JQL query that the filter uses.\n * `owner` Returns the owner of the filter.\n * `searchUrl` Returns a URL to perform the filter's JQL query.\n * `sharePermissions` Returns the share permissions defined for the filter.\n * `subscriptions` Returns the users that are subscribed to the filter.\n * `viewUrl` Returns a URL to view the filter.", "name" : "expand" } ], "deprecated" : false, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if:\n\n * `owner` and `accountId` are provided.\n * `expand` includes an invalid value.\n * `orderBy` is invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanFoundFilter" }, "example" : "{\"self\":\"b\",\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":[]},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10010\",\"id\":\"10010\",\"name\":\"My issues\",\"description\":\"Issues assigned to me\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"assignee = currentUser() and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10010\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=assignee+in+%28currentUser%28%29%29+and+resolution+is+empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}}],\"subscriptions\":[{\"id\":1,\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}}]}]}" } } } }, "description" : "Searches for filters. This operation is similar to [Get filters](#api-rest-api-3-filter-get) except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, only the following filters that match the query parameters are returned:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Search for filters", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getFiltersPaginated_get" } }, "/api/3/comment/list" : { "post" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "ids" : [ 1, 2, 5, 10 ] }, "schema" : { "$ref" : "#/components/schemas/IssueCommentListRequestBean" } } }, "description" : "The list of comment IDs." }, "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "description" : "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts multiple values separated by a comma:\n\n * `renderedBody` Returns the comment body rendered in HTML.\n * `properties` Returns the comment's properties.", "name" : "expand" } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Issue comments" ], "operationId" : "com.atlassian.jira.rest.v2.issue.IssueCommentListResource.getCommentsByIds_post", "summary" : "Get comments by IDs", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the comments for a list of comment IDs.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Comments are returned where the user:\n\n * has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the comment.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"maxResults\":1048576,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:29.672+0000\",\"updated\":\"2019-09-20T13:24:29.672+0000\",\"visibility\":{\"type\":\"role\",\"value\":\"Administrators\"}}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanComment" } } } }, "400" : { "description" : "Returned if the request contains more than 1000 IDs or is empty." } } } }, "/api/3/user/email/bulk" : { "get" : { "security" : [ { "basicAuth" : [] } ], "description" : "Returns a user's email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect, or missing from the request (for example if a user is trying to access this API)." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UnrestrictedUserEmail" } } }, "description" : "Returned if the request is successful." }, "503" : { "description" : "Indicates the API is not currently enabled." }, "400" : { "description" : "Returned if the calling app is not approved to use this API." } }, "operationId" : "com.atlassian.jira.rest.v2.user.UnrestrictedUserEmailResource.getUserEmailBulk_get", "summary" : "Get user email bulk", "deprecated" : false, "parameters" : [ { "description" : "the account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (i.e. do not assume any structure in the value).", "name" : "accountId", "required" : true, "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "x-atlassian-connect-scope" : "ACCESS_EMAIL_ADDRESSES", "tags" : [ "Users" ], "x-experimental" : true } }, "/api/3/version/{id}/mergeto/{moveIssuesTo}" : { "put" : { "x-atlassian-connect-scope" : "PROJECT_ADMIN", "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the version to delete.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the version to merge into.", "name" : "moveIssuesTo" } ], "tags" : [ "Project versions" ], "summary" : "Merge versions", "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.mergeVersions_put", "description" : "Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`.\n\nConsider using [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) instead. This resource supports swapping version values in `fixVersion`, `affectedVersion`, and custom fields.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the version is deleted." }, "404" : { "description" : "Returned if the version to be deleted or the version to merge to are not found." }, "401" : { "description" : "Returned if:\n\n * the authentication credentials are incorrect or missing.\n * the user does not have the required permissions." } } } }, "/api/3/user/search/query/key" : { "get" : { "deprecated" : false, "parameters" : [ { "name" : "query", "description" : "The search query.", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "schema" : { "default" : 0, "format" : "int64", "type" : "integer" }, "in" : "query", "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset)." }, { "schema" : { "default" : 100, "format" : "int32", "type" : "integer" }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `1000`." } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "User search" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "description" : "Finds users with a structured query and returns a list of user keys.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n\nThe query statements are:\n\n * `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*.\n * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.\n * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.\n * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.\n * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.\n * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.\n * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.\n * `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value.\n\nThe list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example:\n\n`is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanUserKey" } } } }, "403" : { "description" : "Returned if the calling user does not have *Browse users and groups* global permission." }, "408" : { "description" : "Returned if the search is timed out." }, "400" : { "description" : "Returned if the query is invalid." } }, "operationId" : "com.atlassian.jira.rest.v2.search.UserSearchResource.findUserKeysByQuery_get", "summary" : "Find user keys by query" } }, "/api/3/workflowscheme/{id}/issuetype/{issueType}" : { "put" : { "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the workflow scheme.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the issue type.", "name" : "issueType" } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow schemes" ], "requestBody" : { "description" : "The issue type-project mapping.", "content" : { "application/json" : { "example" : { "issueType" : "10000", "updateDraftIfNeeded" : false, "workflow" : "jira" }, "schema" : { "$ref" : "#/components/schemas/IssueTypeWorkflowMapping" } } }, "required" : true }, "security" : [ { "basicAuth" : [] } ], "description" : "Sets the workflow for an issue type in a workflow scheme.\n\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the workflow scheme or issue type is not found." }, "400" : { "description" : "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false." }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.setWorkflowSchemeIssueType_put", "summary" : "Set workflow for issue type in workflow scheme" }, "delete" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "The ID of the workflow scheme.", "name" : "id" }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the issue type.", "name" : "issueType" }, { "name" : "updateDraftIfNeeded", "description" : "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`.", "in" : "query", "schema" : { "type" : "boolean" } } ], "tags" : [ "Workflow schemes" ], "description" : "Deletes the issue type-workflow mapping for an issue type in a workflow scheme.\n\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "404" : { "description" : "Returned if the workflow scheme or issue type is not found." }, "200" : { "content" : { "application/json" : { "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false." }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." } }, "summary" : "Delete workflow for issue type in workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteWorkflowSchemeIssueType_delete" }, "get" : { "tags" : [ "Workflow schemes" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the workflow scheme." }, { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the issue type.", "name" : "issueType" }, { "in" : "query", "schema" : { "type" : "boolean", "default" : false }, "name" : "returnDraftIfExists", "description" : "Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned." } ], "deprecated" : false, "summary" : "Get workflow for issue type in workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getWorkflowSchemeIssueType_get", "responses" : { "403" : { "description" : "Returned if the user is not permitted to access workflows." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypeWorkflowMapping" }, "example" : "{\"issueType\":\"10000\",\"workflow\":\"jira\"}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the workflow scheme or issue type is not found." } }, "description" : "Returns the issue type-workflow mapping for an issue type in a workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ] } }, "/api/3/filter/{id}/permission" : { "get" : { "responses" : { "404" : { "description" : "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/SharePermission" }, "type" : "array" }, "example" : "[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"role\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"}}]" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None, however, share permissions are only returned for:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get share permissions", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.getSharePermissions_get", "tags" : [ "Filter sharing" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the filter.", "name" : "id" } ] }, "post" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SharePermissionInputBean" }, "example" : { "type" : "group", "groupname" : "jira-administrators" } } } }, "tags" : [ "Filter sharing" ], "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the filter.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "x-atlassian-connect-scope" : "WRITE", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.addSharePermission_post", "summary" : "Add share permission", "responses" : { "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},\"role\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"}}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SharePermission" } } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter." }, "400" : { "description" : "Returned if:\n\n * the request object is invalid. For example, it contains an invalid type, the ID does not match the type, or the project or group is not found.\n * the user does not own the filter.\n * the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.\n\nBe aware that this operation uses different objects for updating share permissions compared to [Update filter](#api-rest-api-3-filter-id-put).\n\n**[Permissions](#permissions) required:** *Share dashboards and filters* [global permission](https://confluence.atlassian.com/x/x4dKLg) and the user must own the filter." } }, "/api/3/workflowscheme/{id}/createdraft" : { "post" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" } } } }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user is not permitted to create workflow schemes." } }, "description" : "Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "summary" : "Create draft workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.createWorkflowSchemeDraftFromParent_post", "tags" : [ "Workflow scheme drafts" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "name" : "id", "description" : "The ID of the active workflow scheme that the draft is created from.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "deprecated" : false } }, "/api/3/screens/{screenId}/availableFields" : { "get" : { "summary" : "Get available screen fields", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.getAvailableScreenFields_get", "description" : "Returns the fields that can be added to a tab on a screen.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScreenableField" } } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the screen is not found." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the screen.", "name" : "screenId" } ], "deprecated" : false, "tags" : [ "Screens" ] } }, "/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}" : { "put" : { "requestBody" : { "content" : { "application/json" : { "schema" : {} } }, "required" : true }, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "addonKey", "description" : "The key of the app, as defined in its descriptor." }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The key of the property.", "name" : "propertyKey" } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE", "tags" : [ "App properties" ], "operationId" : "AddonPropertiesResource.putAddonProperty_put", "summary" : "Set app property", "description" : "Sets the value of an app's property. Use this resource to store custom data for your app.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\n**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OperationMessage" }, "example" : { "message" : "Property updated.", "statusCode" : 200 } } }, "description" : "Returned if the property is updated." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OperationMessage" }, "example" : { "statusCode" : 401, "message" : "Access to this resource must be authenticated as an app." } } }, "description" : "Returned if the authentication credentials are incorrect or missing." }, "201" : { "content" : { "application/json" : { "example" : { "message" : "Property created.", "statusCode" : 201 }, "schema" : { "$ref" : "#/components/schemas/OperationMessage" } } }, "description" : "Returned is the property is created." }, "400" : { "description" : "Returned if:\n * the property key is longer than 127 characters.\n * the value is not valid JSON.\n * the value is longer than 32768 characters.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OperationMessage" }, "example" : { "statusCode" : 400, "message" : "The property key cannot be longer than 127 characters." } } } } } }, "delete" : { "deprecated" : false, "parameters" : [ { "description" : "The key of the app, as defined in its descriptor.", "name" : "addonKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The key of the property.", "name" : "propertyKey" } ], "x-atlassian-connect-scope" : "NONE", "tags" : [ "App properties" ], "operationId" : "AddonPropertiesResource.deleteAddonProperty_delete", "summary" : "Delete app property", "description" : "Deletes an app's property.\n\n**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.", "responses" : { "204" : { "description" : "Returned if the request is successful." }, "400" : { "content" : { "application/json" : { "example" : { "message" : "The property key cannot be longer than 127 characters.", "statusCode" : 400 }, "schema" : { "$ref" : "#/components/schemas/OperationMessage" } } }, "description" : "Returned if the property key is longer than 127 characters." }, "404" : { "description" : "Returned if the property is not found or doesn't belong to the app.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OperationMessage" }, "example" : { "message" : "Property with key not found.", "statusCode" : 404 } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OperationMessage" }, "example" : { "message" : "Access to this resource must be authenticated as an app.", "statusCode" : 401 } } }, "description" : "Returned if the authentication credentials are incorrect or missing." } } }, "get" : { "tags" : [ "App properties" ], "parameters" : [ { "description" : "The key of the app, as defined in its descriptor.", "name" : "addonKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "propertyKey", "description" : "The key of the property." } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing.", "content" : { "application/json" : { "example" : { "message" : "Access to this resource must be authenticated as an app.", "statusCode" : 401 }, "schema" : { "$ref" : "#/components/schemas/OperationMessage" } } } }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityProperty" }, "example" : { "key" : "propertyKey", "self" : "http://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey", "value" : "propertyValue" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the property is not found or doesn't belong to the app.", "content" : { "application/json" : { "example" : { "statusCode" : 404, "message" : "Property with key not found." }, "schema" : { "$ref" : "#/components/schemas/OperationMessage" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OperationMessage" }, "example" : { "message" : "The property key cannot be longer than 127 characters.", "statusCode" : 400 } } }, "description" : "Returned if the property key is longer than 127 characters." } }, "description" : "Returns the key and value of an app's property.\n\n**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.", "operationId" : "AddonPropertiesResource.getAddonProperty_get", "summary" : "Get app property" } }, "/api/3/jql/pdcleaner" : { "post" : { "summary" : "Convert user identifiers to account IDs in JQL queries", "operationId" : "com.atlassian.jira.rest.v2.search.JQLPersonalDataMigrationResource.migrateQueries_post", "description" : "Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.\n\nYou may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/).\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "responses" : { "400" : { "description" : "Returned if at least one of the queries cannot be converted. For example, the JQL has invalid operators or invalid keywords, or the users in the query cannot be found." }, "200" : { "content" : { "application/json" : { "example" : "{\"queryStrings\":[\"issuetype = Bug AND assignee in (abcde-12345) AND reporter in (abc551-c4e99) order by lastViewed DESC\"],\"queriesWithUnknownUsers\":[{\"originalQuery\":\"assignee = mia\",\"convertedQuery\":\"assignee = unknown\"}]}", "schema" : { "$ref" : "#/components/schemas/ConvertedJQLQueries" } } }, "description" : "Returned if the request is successful. Note that the JQL queries are returned in the same order that they were passed." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "requestBody" : { "content" : { "application/json" : { "example" : { "queryStrings" : [ "assignee = mia", "issuetype = Bug AND assignee in (mia) AND reporter in (alana) order by lastViewed DESC" ] }, "schema" : { "$ref" : "#/components/schemas/JQLPersonalDataMigrationRequest" } } }, "required" : true }, "x-atlassian-connect-scope" : "READ", "parameters" : [], "deprecated" : false, "tags" : [ "JQL" ] } }, "/api/3/project/{projectIdOrKey}" : { "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.deleteProject_delete", "summary" : "Delete project", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Deletes a project.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "204" : { "description" : "Returned if the project is deleted." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to delete it." } }, "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Projects" ] }, "get" : { "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that the project description, issue types, and project lead are included in all responses by default:\n\n * `description` The project description.\n * `issueTypes` The issue types associated with the project.\n * `lead` The project lead.\n * `projectKeys` All project keys associated with the project.\n * `issueTypeHierarchy` The project issue type hierarchy.", "name" : "expand" }, { "name" : "properties", "description" : "A comma-separated list of project properties to return for the project.", "in" : "query", "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Projects" ], "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getProject_get", "summary" : "Get project", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"description\":\"This project was created as an example for REST.\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}],\"issueTypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}],\"url\":\"http://your-domain.atlassian.net/browse/EX\",\"email\":\"from-jira@example.com\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"}}", "schema" : { "$ref" : "#/components/schemas/Project" } } } }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." } } }, "put" : { "tags" : [ "Projects" ], "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive)." }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that the project description, issue types, and project lead are included in all responses by default:\n\n * `description` The project description.\n * `issueTypes` The issue types associated with the project.\n * `lead` The project lead.\n * `projectKeys` All project keys associated with the project." } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "requestBody" : { "content" : { "application/json" : { "example" : { "assigneeType" : "PROJECT_LEAD", "projectTemplateKey" : "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control", "notificationScheme" : 10021, "lead" : "Charlie", "issueSecurityScheme" : 10001, "avatarId" : 10200, "permissionScheme" : 10011, "description" : "Example Project description", "key" : "EX", "name" : "Example", "url" : "http://atlassian.com", "projectTypeKey" : "business", "categoryId" : 10120 }, "schema" : { "$ref" : "#/components/schemas/ProjectInputBean" } } }, "description" : "The project details to be updated.", "required" : true }, "responses" : { "400" : { "description" : "Returned if the request is not valid." }, "403" : { "description" : "Returned if:\n\n * the user is not permitted to update project details.\n * the permission scheme is being changed and the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be changed on Free plans." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the project is updated.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Project" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"description\":\"This project was created as an example for REST.\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}],\"issueTypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}],\"url\":\"http://your-domain.atlassian.net/browse/EX\",\"email\":\"from-jira@example.com\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"}}" } } }, "404" : { "description" : "Returned if the project is not found." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project.\n\nAll parameters are optional in the body of the request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.updateProject_put", "summary" : "Update project" } }, "/api/3/project/{projectId}/hierarchy" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.nextgen.HierarchyResource.getHierarchy_get", "summary" : "Get the hierarchy", "responses" : { "401" : { "description" : "Unauthorized request (eg: user may not create issues)." }, "200" : { "description" : "The hierarchy", "content" : { "application/json" : { "example" : "{\"projectId\":10030,\"hierarchy\":[{\"entityId\":\"6ec98275-27d5-47a1-8521-ad3a3328f4a6\",\"level\":0,\"name\":\"Standard Issue Types\",\"issueTypes\":[{\"id\":7,\"name\":\"Story\",\"avatarId\":10324}]}]}", "schema" : { "$ref" : "#/components/schemas/HierarchyOutputFragment" } } } }, "500" : { "description" : "Unknown server error." }, "503" : { "description" : "This feature is unavailable." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Get the project hierarchy.", "tags" : [ "Issue type hierarchy" ], "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the project.", "name" : "projectId" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ" } }, "/api/3/attachment/{id}" : { "delete" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes an attachment from an issue.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the project holding the issue containing the attachment:\n\n * *Delete own attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by the calling user.\n * *Delete all attachments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by any user.", "responses" : { "404" : { "description" : "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "204" : { "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.removeAttachment_delete", "summary" : "Delete attachment", "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the attachment.", "name" : "id" } ], "deprecated" : false, "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Issue attachments" ] }, "get" : { "tags" : [ "Issue attachments" ], "parameters" : [ { "name" : "id", "description" : "The ID of the attachment.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "404" : { "description" : "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentMetadata" }, "example" : "{\"id\":10000,\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-09-20T13:24:30.888+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10000\"}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the metadata for an attachment. Note that the attachment itself is not returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "operationId" : "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.getAttachment_get", "summary" : "Get attachment metadata" } }, "/api/3/project/search" : { "get" : { "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" } }, { "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `50`." }, { "name" : "orderBy", "description" : "[Order](#ordering) the results by a field. If the `orderBy` field is not set, then projects are listed in ascending order by project key:\n\n * `category` Sorts projects in order by project category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation.\n * `key` Sorts projects in order by project key.\n * `name` Sorts projects in alphabetical order by project name.\n * `owner` Sorts projects in order by the project lead.", "schema" : { "enum" : [ "category", "-category", "+category", "key", "-key", "+key", "name", "-name", "+name", "owner", "-owner", "+owner" ], "default" : "key", "type" : "string" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "Filter the results using a literal string. Projects with a matching `key` or `name` are returned (case insensitive).", "name" : "query" }, { "description" : "Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts multiple values separated by a comma. Valid values are `business`, `service_desk`, and `software`.", "name" : "typeKey", "in" : "query", "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "format" : "int64", "type" : "integer" }, "name" : "categoryId", "description" : "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation." }, { "name" : "searchBy", "schema" : { "default" : "key, name", "type" : "string" }, "in" : "query" }, { "description" : "Filter results by projects for which the user can:\n\n * `view` the project, meaning that they have one of the following permissions:\n \n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL\")).\n * `browse` the project, meaning that they have the *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * `edit` the project, meaning that they have one of the following permissions:\n \n * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL\")).", "name" : "action", "schema" : { "default" : "view", "enum" : [ "view", "browse", "edit" ], "type" : "string" }, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `description` Returns the project description.\n * `projectKeys` Returns all project keys associated with a project.\n * `lead` Returns information about the the project lead.\n * `issueTypes` Returns all issue types associated with the project.\n * `url` Returns the URL associated with the project.", "name" : "expand" } ], "deprecated" : false, "tags" : [ "Projects" ], "summary" : "Get projects paginated", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.searchProjects_get", "description" : "Returns projects visible to the user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Projects are returned only where the user has *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "400" : { "description" : "Returned if the request is not valid." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/search?startAt=0&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/project/search?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/ABC\",\"id\":\"10001\",\"key\":\"ABC\",\"name\":\"Alphabetical\",\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\"}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanProject" } } }, "description" : "Returned if the request is successful. Returns a page of projects." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if no projects matching the search criteria are found." } } } }, "/api/3/group/user" : { "post" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateUserToGroupBean" }, "example" : { "accountId" : "5b10ac8d82e05b22cc7d4ef5" } } }, "description" : "The user to add to the group." }, "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "name" : "groupname", "description" : "The name of the group (case sensitive).", "schema" : { "type" : "string" }, "in" : "query", "required" : true } ], "tags" : [ "Groups" ], "summary" : "Add user to group", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupResource.addUserToGroup_post", "description" : "Adds a user to a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the group or user are not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing from the request." }, "403" : { "description" : "Returned if the calling user does not have the necessary permission." }, "400" : { "description" : "Returned if:\n\n * `groupname` is not provided.\n * `accountId` is missing." } } }, "delete" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The name of the group.", "name" : "groupname", "required" : true, "in" : "query", "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username" }, { "in" : "query", "required" : true, "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" }, "x-showInExample" : "true", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required." } ], "tags" : [ "Groups" ], "summary" : "Remove user from group", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupResource.removeUserFromGroup_delete", "description" : "Removes a user from a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if:\n\n * `groupName` is missing.\n * `accountId` is missing." }, "200" : { "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing from the request." }, "404" : { "description" : "Returned if the group or user are not found." } } } }, "/api/3/serverInfo" : { "get" : { "description" : "Returns information about the Jira instance.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServerInformation" }, "example" : "{\"baseUrl\":\"http://your-domain.atlassian.net/jira\",\"version\":\"1001.0.0-SNAPSHOT\",\"versionNumbers\":[5,0,0],\"buildNumber\":582,\"buildDate\":\"2019-09-20T13:24:27.773+0000\",\"serverTime\":\"2019-09-20T13:24:27.773+0000\",\"scmInfo\":\"1f51473f5c7b75c1a69a0090f4832cdc5053702a\",\"serverTitle\":\"My Jira instance\",\"defaultLocale\":{\"locale\":\"en_AU\"}}" } } } }, "summary" : "Get Jira instance info", "operationId" : "com.atlassian.jira.rest.v2.ServerInfoResource.getServerInfo_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [], "tags" : [ "Server info" ] } }, "/api/3/workflowscheme" : { "post" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : { "issueTypeMappings" : { "10000" : "scrum workflow", "10001" : "builds workflow" }, "defaultWorkflow" : "jira", "description" : "The description of the example workflow scheme.", "name" : "Example workflow scheme" } } } }, "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [], "tags" : [ "Workflow schemes" ], "summary" : "Create workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.createWorkflowScheme_post", "description" : "Creates a workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "403" : { "description" : "Returned if the user is not permitted to create workflow schemes." }, "400" : { "description" : "Returned if the request is invalid." }, "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } } } }, "/api/3/project/{projectKeyOrId}/securitylevel" : { "get" : { "tags" : [ "Project permission schemes" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "projectKeyOrId", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"levels\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/securitylevel/100000\",\"id\":\"100000\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/securitylevel/100001\",\"id\":\"100001\",\"description\":\"Only internal staff can see this issue.\",\"name\":\"Staff Only\"}]}", "schema" : { "$ref" : "#/components/schemas/ProjectIssueSecurityLevels" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." } }, "description" : "Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels for the project that the user has access to.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [global permission](https://confluence.atlassian.com/x/x4dKLg) for the project, however, issue security levels are only returned for authenticated user with *Set Issue Security* [global permission](https://confluence.atlassian.com/x/x4dKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get project issue security levels", "operationId" : "com.atlassian.jira.rest.v2.securitylevel.ProjectSecurityLevelResource.getSecurityLevelsForProject_get" } }, "/api/3/groupuserpicker" : { "get" : { "tags" : [ "Group and user picker" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "query", "description" : "The search string.", "name" : "query" }, { "name" : "maxResults", "description" : "The maximum number of items to return in each list. The maximum is `1000`.", "in" : "query", "schema" : { "default" : 50, "format" : "int32", "type" : "integer" } }, { "name" : "showAvatar", "description" : "Indicates whether the user avatar should be returned. If an invalid value is provided, the default value is used.", "in" : "query", "schema" : { "type" : "boolean", "default" : false } }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The custom field ID of the field this request is for.", "name" : "fieldId" }, { "in" : "query", "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "description" : "The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide multiple copies of this parameter. For example, `projectId=10000&projectId=10001`. This parameter is only used when `fieldId` is present.", "name" : "projectId" }, { "in" : "query", "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "description" : "The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide multiple copies of this parameter. For example, `issueTypeId=10000&issueTypeId=10001`. Special values, such as `-1` (all standard issue types) and `-2` (all subtask issue types), are supported. This parameter is only used when `fieldId` is present.", "name" : "issueTypeId" }, { "name" : "avatarSize", "description" : "The size of the avatar to return. If an invalid value is provided, the default value is used.", "schema" : { "type" : "string", "enum" : [ "xsmall", "xsmall@2x", "xsmall@3x", "small", "small@2x", "small@3x", "medium", "medium@2x", "medium@3x", "large", "large@2x", "large@3x", "xlarge", "xlarge@2x", "xlarge@3x", "xxlarge", "xxlarge@2x", "xxlarge@3x", "xxxlarge", "xxxlarge@2x", "xxxlarge@3x" ], "default" : "xsmall" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "boolean", "default" : false }, "description" : "Indicates whether the search for groups should be case insensitive.", "name" : "caseInsensitive" }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "name" : "excludeConnectAddons", "description" : "Indicates whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used." } ], "x-atlassian-connect-scope" : "READ", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupAndUserPickerResource.findUsersAndGroups_get", "summary" : "Find users and groups", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"users\":{\"users\":[{\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"mia\",\"key\":\"mia\",\"html\":\"Mia Krystof - mia@example.com (mia)\",\"displayName\":\"Mia Krystof\",\"avatarUrl\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\"}],\"total\":25,\"header\":\"Showing 20 of 25 matching groups\"},\"groups\":{\"header\":\"Showing 20 of 25 matching groups\",\"total\":25,\"groups\":[{\"name\":\"jdog-developers\",\"html\":\"jdog-developers\"},{\"name\":\"juvenal-bot\",\"html\":\"juvenal-bot\"}]}}", "schema" : { "$ref" : "#/components/schemas/FoundUsersAndGroups" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have permission to view users and groups" }, "400" : { "description" : "Returned if the query parameter is not provided." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a list of users and groups matching a string. The string is used:\n\n * for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.\n * for groups, to find a case-sensitive match with group name.\n\nFor example, if the string *tin* is used, records with the display name *Tina*, email address *sarah@tinplatetraining.com*, and the group *accounting* would be returned.\n\nOptionally, the search can be refined to:\n\n * the projects and issue types associated with a custom field, such as a user picker. The search can then be further refined to return only users and groups that have permission to view specific:\n \n * projects.\n * issue types.\n \n If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.\n * not return Connect app users and groups.\n * return groups that have a case-insensitive match with the query.\n\nThe primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an `html` field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically *Showing X of Y matching groups*.\n\nThis operation can be accessed anonymously if permissions allow open access.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/yodKLg)." } }, "/api/3/issue/properties/{propertyKey}" : { "delete" : { "operationId" : "com.atlassian.jira.rest.v2.property.IssuePropertyBulkUpdateResource.bulkDeleteIssueProperty_delete", "summary" : "Bulk delete issue property", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] } ], "description" : "Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.\n\nThe criteria the filter used to identify eligible issues are:\n\n * `entityIds` Only issues from this list are eligible.\n * `currentValue` Only issues with the property set to this value are eligible.\n\nIf both criteria is specified, they are joined with the logical *AND*: only issues that satisfy both criteria are considered eligible.\n\nIf no filter criteria are specified, all the issues visible to the user and where the user has the EDIT\\_ISSUES permission for the issue are considered eligible.\n\nThis operation is:\n\n * transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.\n * [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [ project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the request is invalid." }, "303" : { "description" : "Returned if the request is successful." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueFilterForBulkPropertyDelete" }, "example" : { "entityIds" : [ 10100, 100010 ], "currentValue" : "deprecated value" } } } }, "x-experimental" : true, "deprecated" : false, "parameters" : [ { "description" : "The key of the property.", "name" : "propertyKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Issue properties" ] }, "put" : { "parameters" : [ { "description" : "The key of the property. The maximum length is 255 characters.", "name" : "propertyKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Issue properties" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "value" : { "owner" : "admin", "weight" : 100 }, "filter" : { "hasProperty" : true, "currentValue" : { "owner" : "admin", "weight" : 50 }, "entityIds" : [ 10100, 100010 ] } }, "schema" : { "$ref" : "#/components/schemas/BulkIssuePropertyUpdateRequest" } } } }, "x-experimental" : true, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] } ], "description" : "Sets a property value on multiple issues. The issues to be updated can be specified by a filter.\n\nThe filter identifies issues eligible for update using these criteria:\n\n * `entityIds` Only issues from this list are eligible.\n * `currentValue` Only issues with the property set to this value are eligible.\n * `hasProperty`:\n \n * If *true*, only issues with the property are eligible.\n * If *false*, only issues without the property are eligible.\n\nIf more than one criteria is specified, they are joined with the logical *AND*: only issues that satisfy all criteria are eligible.\n\nIf an invalid combination of criteria is provided, an error is returned. For example, specifying a `currentValue` and `hasProperty` as *false* would not match any issues (because without the property the property cannot have a value).\n\nThe filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT\\_ISSUES permission for the issue are considered eligible.\n\nThis operation is:\n\n * transactional, either all eligible issues are updated or, when errors occur, none are updated.\n * [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for each project containing issues.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * *Edit issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for each issue.", "responses" : { "303" : { "description" : "Returned if the request is successful." }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the request is invalid." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the authentication credentials are incorrect or missing." } }, "operationId" : "com.atlassian.jira.rest.v2.property.IssuePropertyBulkUpdateResource.bulkSetIssueProperty_put", "summary" : "Bulk set issue property" } }, "/api/3/project/{projectIdOrKey}/versions" : { "get" : { "x-atlassian-connect-scope" : "READ", "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The project ID or project key (case sensitive).", "name" : "projectIdOrKey" }, { "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `operations` Returns actions that can be performed on the specified version.", "name" : "expand", "schema" : { "type" : "string" }, "in" : "query" } ], "deprecated" : false, "tags" : [ "Project versions" ], "description" : "Returns all versions in a project. The response is not paginated. Use [Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) if you want to get the versions in a project with pagination.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"overdue\":true,\"userReleaseDate\":\"6/Jul/2010\",\"projectId\":10000},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10010\",\"id\":\"10010\",\"description\":\"Minor Bugfix version\",\"name\":\"Next Version\",\"archived\":false,\"released\":false,\"overdue\":false,\"projectId\":10000,\"issuesStatusForFixVersion\":{\"unmapped\":0,\"toDo\":10,\"inProgress\":20,\"done\":100}}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Version" } } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." } }, "summary" : "Get project versions", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getProjectVersions_get" } }, "/api/3/issuetype/{issueTypeId}/properties/{propertyKey}" : { "get" : { "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "issueTypeId", "description" : "The ID of the issue type.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys.", "name" : "propertyKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "Issue type properties" ], "description" : "Returns the key and value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the details of any issue type.\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the details of any issue types associated with the projects the user has permission to browse.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the issue type or property is not found or the user does not have the required permissions." }, "200" : { "content" : { "application/json" : { "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}", "schema" : { "$ref" : "#/components/schemas/EntityProperty" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the issue type ID is invalid." } }, "summary" : "Get issue type property", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypePropertyResource.getIssueTypeProperty_get" }, "delete" : { "tags" : [ "Issue type properties" ], "deprecated" : false, "parameters" : [ { "name" : "issueTypeId", "description" : "The ID of the issue type.", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "propertyKey", "description" : "The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys." } ], "x-atlassian-connect-scope" : "ADMIN", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypePropertyResource.deleteIssueTypeProperty_delete", "summary" : "Delete issue type property", "responses" : { "204" : { "description" : "Returned if the issue type property is deleted." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if the issue type ID is invalid." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue type or property is not found." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Deletes the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." }, "put" : { "responses" : { "403" : { "description" : "Returned if the user does not have permission to modify the issue type." }, "400" : { "description" : "Returned if:\n\n * the issue type ID is invalid.\n * a property value is not provided.\n * the property value JSON content is invalid." }, "201" : { "description" : "Returned if the issue type property is created.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the issue type property is updated.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if:\n\n * the issue type is not found.\n * the user does not have the permission view the issue type." } }, "description" : "Creates or updates the value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). Use this resource to store and update data against an issue type.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "summary" : "Set issue type property", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypePropertyResource.setIssueTypeProperty_put", "tags" : [ "Issue type properties" ], "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the issue type.", "name" : "issueTypeId" }, { "name" : "propertyKey", "description" : "The key of the issue type property. The maximum length is 255 characters.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "deprecated" : false, "requestBody" : { "content" : { "application/json" : { "example" : { "number" : 5, "string" : "string-value" }, "schema" : {} } }, "required" : true } } }, "/api/3/workflow/search" : { "get" : { "description" : "Returns a [paginated](#pagination) list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.\n\nThis operation does not return next-gen workflows.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] } ], "responses" : { "403" : { "content" : { "application/json" : { "example" : "{\"errorMessages\":[\"Only Jira administrators can access workflows.\"],\"errors\":{}}", "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the user does not have the necessary permission." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanWorkflow" }, "example" : "{\"maxResults\":1,\"startAt\":0,\"total\":5,\"isLast\":false,\"values\":[{\"id\":{\"name\":\"SCRUM Workflow\"},\"description\":\"A workflow used for Software projects in the SCRUM methodology\",\"transitions\":[{\"id\":\"5\",\"name\":\"In Progress\",\"description\":\"Start working on the issue.\",\"from\":[\"10\",\"13\"],\"to\":\"14\",\"type\":\"directed\",\"screen\":{\"id\":\"10000\"},\"rules\":{\"conditions\":[{\"type\":\"PermissionCondition\",\"configuration\":{\"permissionKey\":\"WORK_ON_ISSUES\"}}],\"validators\":[{\"type\":\"FieldRequiredValidator\",\"configuration\":{\"ignoreContext\":true,\"errorMessage\":\"A custom error message\",\"fields\":[\"description\",\"assignee\"]}}],\"postFunctions\":[{\"type\":\"UpdateIssueStatusFunction\"},{\"type\":\"GenerateChangeHistoryFunction\"},{\"type\":\"FireIssueEventFunction\"}]}}],\"statuses\":[{\"id\":\"3\",\"name\":\"In Progress\",\"properties\":{\"issueEditable\":false}}]}]}" } } } }, "summary" : "Get workflows paginated", "operationId" : "com.atlassian.jira.rest.v2.admin.workflow.WorkflowSearchResource.getWorkflowsPaginated_get", "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "schema" : { "default" : 0, "type" : "integer", "format" : "int64" }, "in" : "query", "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "name" : "maxResults", "description" : "The maximum number of items to return per page.", "schema" : { "format" : "int32", "type" : "integer", "default" : 50 }, "in" : "query" }, { "description" : "The name of a workflow to return.", "name" : "workflowName", "in" : "query", "schema" : { "uniqueItems" : true, "items" : { "type" : "string" }, "type" : "array" } }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `transitions` For each workflow, returns information about the transitions inside the workflow.\n * `transitions.rules` For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.\n * `statuses` For each workflow, returns information about the statuses inside the workflow.\n * `statuses.properties` For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested." } ], "tags" : [ "Workflows" ], "x-experimental" : true } }, "/api/3/universal_avatar/type/{type}/owner/{entityId}" : { "get" : { "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "type", "description" : "The type of the entity. Valid values are `project` and `issuetype`." }, { "description" : "The ID of the entity item.", "name" : "entityId", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Avatars" ], "operationId" : "com.atlassian.jira.rest.v2.issue.UniversalAvatarResource.getAvatars_get", "summary" : "Get avatars", "security" : [ { "basicAuth" : [] }, {} ], "description" : "Returns the system and custom avatars for a project or issue type.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "404" : { "description" : "Returned if the entity type is invalid, the item ID is missing, or the item is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Avatars" }, "example" : "{\"system\":[{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project\"}}],\"custom\":[{\"id\":\"1010\",\"isSystemAvatar\":false,\"isSelected\":false,\"isDeletable\":true,\"urls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project\",\"24x24\":\"https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project\",\"32x32\":\"https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project\",\"48x48\":\"https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project\"}}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } } }, "post" : { "deprecated" : false, "parameters" : [ { "name" : "type", "description" : "The type of the entity. Valid values are `project` and `issuetype`.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the entity item.", "name" : "entityId" }, { "description" : "The X coordinate of the top-left corner of the crop region.", "name" : "x", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "in" : "query" }, { "schema" : { "default" : 0, "format" : "int32", "type" : "integer" }, "in" : "query", "name" : "y", "description" : "The Y coordinate of the top-left corner of the crop region." }, { "schema" : { "type" : "integer", "format" : "int32" }, "in" : "query", "required" : true, "name" : "size", "description" : "The length of each side of the crop region." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Avatars" ], "requestBody" : { "required" : true, "content" : { "*/*" : { "schema" : {} } } }, "security" : [ { "basicAuth" : [] }, {} ], "description" : "Loads a custom avatar for a project or issue type.\n\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:\n\n * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).\n * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.\n\nFor example: \n`curl --request POST `\n\n`--user email@example.com: `\n\n`--header 'X-Atlassian-Token: no-check' `\n\n`--header 'Content-Type: image/< image_type>' `\n\n`--data-binary \"<@/path/to/file/with/your/avatar>\" `\n\n`--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'`\n\nThe avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.\n\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.\n\nAfter creating the avatar use:\n\n * [Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar.\n * [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "400" : { "description" : "Returned if:\n\n * an image isn't included in the request.\n * the image type is unsupported.\n * the crop parameters extend the crop area beyond the edge of the image." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the entity type is invalid, the item ID is missing, or the item is not found." }, "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"/secure/useravatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"/secure/useravatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"/secure/useravatar?avatarId=10040&avatarType=project\"}}", "schema" : { "$ref" : "#/components/schemas/Avatar" } } } } }, "operationId" : "com.atlassian.jira.rest.v2.issue.UniversalAvatarResource.storeAvatar_post", "summary" : "Load avatar" } }, "/api/3/user/search/query" : { "get" : { "x-experimental" : true, "tags" : [ "User search" ], "parameters" : [ { "in" : "query", "required" : true, "schema" : { "type" : "string" }, "name" : "query", "description" : "The search query." }, { "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt", "in" : "query", "schema" : { "format" : "int64", "type" : "integer", "default" : 0 } }, { "schema" : { "type" : "integer", "format" : "int32", "default" : 100 }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `1000`." } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "operationId" : "com.atlassian.jira.rest.v2.search.UserSearchResource.findUsersByQuery_get", "summary" : "Find users by query", "responses" : { "408" : { "description" : "Returned if the search is timed out." }, "400" : { "description" : "Returned if the query is invalid." }, "403" : { "description" : "Returned if the calling user does not have *Browse users and groups* global permission." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanUser" } } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "description" : "Finds users with a structured query and returns user details.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n\nThe query statements are:\n\n * `is assignee of PROJ` Returns the users that are assignees of at least one issue in project *PROJ*.\n * `is assignee of (PROJ-1, PROJ-2)` Returns users that are assignees on the issues *PROJ-1* or *PROJ-2*.\n * `is reporter of (PROJ-1, PROJ-2)` Returns users that are reporters on the issues *PROJ-1* or *PROJ-2*.\n * `is watcher of (PROJ-1, PROJ-2)` Returns users that are watchers on the issues *PROJ-1* or *PROJ-2*.\n * `is voter of (PROJ-1, PROJ-2)` Returns users that are voters on the issues *PROJ-1* or *PROJ-2*.\n * `is commenter of (PROJ-1, PROJ-2)` Returns users that have posted a comment on the issues *PROJ-1* or *PROJ-2*.\n * `is transitioner of (PROJ-1, PROJ-2)` Returns users that have performed a transition on issues *PROJ-1* or *PROJ-2*.\n * `[propertyKey].entity.property.path is \"property value\"` Returns users with the entity property value.\n\nThe list of issues can be extended as needed, as in *(PROJ-1, PROJ-2, ... PROJ-n)*. Statements can be combined using the `AND` and `OR` operators to form more complex queries. For example:\n\n`is assignee of PROJ AND [propertyKey].entity.property.path is \"property value\"`" } }, "/api/3/user/columns" : { "put" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the requested user is not found." }, "500" : { "description" : "Returned if an invalid issue table column ID is sent." }, "403" : { "description" : "Returned if the calling user does not have the *Administer Jira* global permission or is not accessing their user record." } }, "security" : [ { "basicAuth" : [] }, {} ], "description" : "Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an accountId is not passed, the calling user's default columns are set. If no column details are sent, then all default columns are removed.\n\nThe parameters for this resource are expressed as HTML form data. For example, in curl:\n\n`curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'`\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user.\n * Permission to access Jira, to set the calling user's columns.", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.setUserColumns_put", "summary" : "Set user default columns", "tags" : [ "Users" ], "parameters" : [ { "x-showInExample" : "true", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "in" : "query", "schema" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "requestBody" : { "description" : "The ID of a column to set. To set multiple columns, send multiple `columns` parameters.", "content" : { "multipart/form-data" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, "*/*" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } } } } }, "get" : { "responses" : { "404" : { "description" : "Returned if the requested user is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ColumnItem" } } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the calling user does not have the *Administer Jira* global permission or is not accessing their user record." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "description" : "Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an accountId is not passed in the request, the calling user's details are returned.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user.\n * Permission to access Jira, to get the calling user's column details.", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.getUserDefaultColumns_get", "summary" : "Get user default columns", "tags" : [ "Users" ], "parameters" : [ { "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" }, "in" : "query", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.", "x-showInExample" : "true" }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ" }, "delete" : { "tags" : [ "Users" ], "parameters" : [ { "in" : "query", "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" }, "x-showInExample" : "true", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.resetUserColumns_delete", "summary" : "Reset user default columns", "responses" : { "403" : { "description" : "Returned if the calling user does not have the *Administer Jira* global permission or is not accessing their user record." }, "204" : { "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, {} ], "description" : "Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If an accountId is not passed, the calling user's default columns are reset.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user.\n * Permission to access Jira, to set the calling user's columns." } }, "/api/3/issuetype/{issueTypeId}/properties" : { "get" : { "tags" : [ "Issue type properties" ], "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "issueTypeId", "description" : "The ID of the issue type." } ], "x-atlassian-connect-scope" : "READ", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypePropertyResource.getIssueTypePropertyKeys_get", "summary" : "Get issue type property keys", "responses" : { "400" : { "description" : "Returned if the issue type ID is invalid." }, "404" : { "description" : "Returned if:\n\n * the issue type is not found.\n * the user does not have the required permissions." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PropertyKeys" }, "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}" } }, "description" : "Returned if the request is successful." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys of the issue type.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) to get the property keys of any issue type.\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) to get the property keys of any issue types associated with the projects the user has permission to browse." } }, "/api/3/issue/{issueIdOrKey}/worklog" : { "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all worklogs for an issue.\n\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** Workloads are only returned where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageOfWorklogs" }, "example" : "{\"startAt\":0,\"maxResults\":1,\"total\":1,\"worklogs\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"updated\":\"2019-09-20T13:24:29.951+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-09-20T13:24:29.951+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"id\":\"100028\",\"issueId\":\"10002\"}]}" } }, "description" : "Returned if the request is successful" }, "404" : { "description" : "Returned if:\n\n * the issue is not found or the user does not have permission to view the issue.\n * `startAt` or `maxResults` has non-numeric values.\n * time tracking is disabled." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.IssueWorklogsResource.getIssueWorklog_get", "summary" : "Get issue worklogs", "deprecated" : false, "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "format" : "int64", "type" : "integer", "default" : 0 }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 1048576 }, "description" : "The maximum number of items to return per page. The maximum is `1048576`.", "name" : "maxResults" }, { "description" : "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts multiple values separated by a comma:\n\n * `properties` Returns worklog properties.", "name" : "expand", "in" : "query", "schema" : { "default" : "", "type" : "string" } } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue worklogs" ] }, "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueWorklogsResource.addWorklog_post", "summary" : "Add worklog", "responses" : { "400" : { "description" : "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n * the user does not have permission to add the worklog.\n * the request JSON is malformed." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." }, "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Worklog" } } }, "description" : "Returned if the request is successful." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Adds a worklog to an issue.\n\nTime tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Work on issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "requestBody" : { "content" : { "application/json" : { "example" : { "started" : "2019-09-20T13:24:29.950+0000", "timeSpentSeconds" : 12000, "comment" : { "content" : [ { "content" : [ { "type" : "text", "text" : "I did some work here." } ], "type" : "paragraph" } ], "type" : "doc", "version" : 1 }, "visibility" : { "value" : "jira-developers", "type" : "group" } }, "schema" : { "$ref" : "#/components/schemas/Worklog" } } }, "required" : true }, "tags" : [ "Issue worklogs" ], "parameters" : [ { "description" : "The ID or key the issue.", "name" : "issueIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "in" : "query", "schema" : { "type" : "boolean", "default" : true }, "description" : "Indicates whether users watching the issue are notified by email.", "name" : "notifyUsers" }, { "name" : "adjustEstimate", "description" : "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Reduces the estimate by amount specified in `reduceBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog.", "schema" : { "type" : "string", "default" : "auto", "enum" : [ "new", "leave", "manual", "auto" ] }, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `new`.", "name" : "newEstimate" }, { "description" : "The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when `adjustEstimate` is `manual`.", "name" : "reduceBy", "schema" : { "type" : "string" }, "in" : "query" }, { "description" : "Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts multiple values separated by a comma:\n\n * `properties` Returns worklog properties.", "name" : "expand", "in" : "query", "schema" : { "default" : "", "type" : "string" } }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "name" : "overrideEditableFlag", "description" : "Indicates whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin scope permission can use this flag." } ], "deprecated" : false, "x-atlassian-connect-scope" : "WRITE" } }, "/api/3/jql/autocompletedata/suggestions" : { "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string", "example" : "reporter" }, "in" : "query", "description" : "The name of the field.", "name" : "fieldName", "x-showInExample" : "true" }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The partial field item name entered by the user.", "name" : "fieldValue" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "predicateName", "description" : "The name of the [ CHANGED operator predicate](https://confluence.atlassian.com/x/hQORLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for which the suggestions are generated. The valid predicate operators are *by*, *from*, and *to*." }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "predicateValue", "description" : "The partial predicate item name entered by the user." } ], "tags" : [ "JQL" ], "description" : "Returns the JQL search auto complete suggestions for a field.\n\nSuggestions can be obtained by providing:\n\n * `fieldName` to get a list of all values for the field.\n * `fieldName` and `fieldValue` to get a list of values containing the text in `fieldValue`.\n * `fieldName` and `predicateName` to get a list of all predicate values for the field.\n * `fieldName`, `predicateName`, and `predicateValue` to get a list of predicate values containing the text in `predicateValue`.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "400" : { "description" : "Returned if an invalid combination of parameters is passed." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"results\":[{\"value\":\"ActiveObjects\",\"displayName\":\"ActiveObjects (AO)\"},{\"value\":\"Atlassian Connect\",\"displayName\":\"Atlassian Connect (AC)\"},{\"value\":\"Atlassian Connect in Jira\",\"displayName\":\"Atlassian Connect in Jira (ACJIRA)\"}]}", "schema" : { "$ref" : "#/components/schemas/AutoCompleteSuggestions" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } }, "summary" : "Get field auto complete suggestions", "operationId" : "com.atlassian.jira.rest.v2.search.SearchAutoCompleteResource.getFieldAutoCompleteForQueryString_get" } }, "/api/3/workflow" : { "get" : { "parameters" : [ { "description" : "The name of the workflow to be returned. Only one workflow can be specified.", "name" : "workflowName", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : true, "x-atlassian-connect-scope" : "ADMIN", "tags" : [ "Workflows" ], "operationId" : "com.atlassian.jira.rest.v2.admin.WorkflowsResource.getAllWorkflows_get", "summary" : "Get all workflows", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows paginated](#api-rest-api-3-workflow-search-get).\n\nIf the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, an array of workflow objects is returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/DeprecatedWorkflow" }, "type" : "array" }, "example" : "[{\"name\":\"classic workflow\",\"description\":\"A classic Jira workflow\",\"lastModifiedDate\":\"01-01-2011\",\"lastModifiedUser\":\"admin\",\"lastModifiedUserAccountId\":\"5b10a2844c20165700ede21g\",\"steps\":5,\"default\":true}]" } } }, "401" : { "description" : "Returned if the user does not have the required permissions." } } } }, "/api/3/field/{fieldKey}/option/suggestions/search" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.getVisibleIssueFieldOptions_get", "summary" : "Get visible issue field options", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Returns options defined for a select list issue field that can be viewed by the user.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "404" : { "description" : "Returned if the field is not found or does not support options." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1\",\"maxResults\":1,\"startAt\":0,\"total\":10,\"isLast\":false,\"values\":[{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"}}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanIssueFieldOption" } } }, "description" : "Returned if the request is successful." } }, "parameters" : [ { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "in" : "query", "schema" : { "default" : 0, "format" : "int64", "type" : "integer" } }, { "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `100`.", "schema" : { "type" : "integer", "format" : "int32" }, "in" : "query" }, { "description" : "Filters the results to options that are only available in the specified project.", "name" : "projectId", "schema" : { "type" : "integer", "format" : "int64" }, "in" : "query" }, { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "fieldKey", "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*." } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE", "tags" : [ "Issue field options" ] } }, "/api/3/expression/eval" : { "post" : { "tags" : [ "Jira expressions" ], "deprecated" : false, "parameters" : [ { "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `meta.complexity` Returns information about the expression complexity (for example, the number of expensive operations used by the expression) and how close the expression is to reaching the [complexity limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing and debugging your expressions.", "name" : "expand", "in" : "query", "schema" : { "type" : "string" } } ], "x-atlassian-connect-scope" : "READ", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JiraExpressionEvalRequestBean" }, "example" : { "context" : { "project" : { "key" : "ACJIRA" }, "issues" : { "jql" : { "startAt" : 0, "maxResults" : 100, "query" : "project = HSP", "validation" : "strict" } }, "customerRequest" : 1450, "serviceDesk" : 10023, "board" : 10100, "issue" : { "key" : "ACJIRA-1470" }, "sprint" : 10001 }, "expression" : "{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }" } } }, "description" : "The Jira expression and the evaluation context.", "required" : true }, "responses" : { "400" : { "description" : "Returned if:\n\n * the request is invalid, that is:\n \n * invalid data is provided, such as a request including issue ID and key.\n * the expression is invalid and can not be parsed.\n * evaluation fails at runtime. This may happen for various reasons. For example, accessing a property on a null object (such as the expression `issue.id` where `issue` is `null`). In this case an error message is provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" }, "example" : "{\"errorMessages\":[\"Evaluation failed: \\\"issue['a' + 'b']\\\" - Unrecognized property of `issue`: \\\"ab\\\" ('a' + 'b'). Available properties of type 'Issue' are: 'assignee', 'comments', 'description', 'id', 'issueType', 'key', 'priority', 'project', 'properties', 'reporter', 'status', 'summary'\"],\"errors\":{}}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JiraExpressionResult" }, "example" : "{\"value\":\"The expression's result. This value can be any JSON, not necessarily a String\",\"meta\":{\"complexity\":{\"steps\":{\"value\":1,\"limit\":10000},\"expensiveOperations\":{\"value\":3,\"limit\":10},\"beans\":{\"value\":0,\"limit\":1000},\"primitiveValues\":{\"value\":1,\"limit\":10000}},\"issues\":{\"jql\":{\"startAt\":0,\"maxResults\":1000,\"count\":140,\"totalCount\":140,\"validationWarnings\":[\"There is a problem with the JQL query.\"]}}}}" } } }, "404" : { "description" : "Returned if any entity provided in the request context is not found or the user does not have permission to view it.", "content" : { "application/json" : { "example" : "{\"errorMessages\":[\"Issue does not exist or you do not have permission to see it.\"],\"errors\":{}}", "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work", "read:jira-user" ] }, {} ], "description" : "Evaluates a Jira expression and returns its value.\n\nThis resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the [Jira expressions documentation](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/) for more details.\n\n#### Context variables ####\n\nThe following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.\n\n * `user` ([User](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user)): The current user. Always available and equal to `null` if the request is anonymous.\n * `app` ([App](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#app)): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: [Authentication for Connect apps](https://developer.atlassian.com/cloud/jira/platform/authentication-for-apps/)).\n * `issue` ([Issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)): The current issue. Available only when the issue is provided in the request context object.\n * `issues` ([List](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#list) of [Issues](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue)): A collection of issues matching a given JQL. Available only when the JQL is provided in the request context object.\n * `project` ([Project](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#project)): The current project. Available only when the project is provided in the request context object.\n * `sprint` ([Sprint](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#sprint)): The current sprint. Available only when the sprint is provided in the request context object.\n * `board` ([Board](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#board)): The current board. Available only when the board is provided in the request context object.\n * `serviceDesk` ([ServiceDesk](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#servicedesk)): The current service desk. Available only when the service desk is provided in the request context object.\n * `customerRequest` ([CustomerRequest](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#customerrequest)): The current customer request. Available only when the customer request is provided in the request context object.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required**: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue. \nPermission to access Jira Software is required to access Jira Software context variables (`board` and `sprint`) or fields (for example, `issue.sprint`).", "operationId" : "com.atlassian.jira.rest.v2.expression.JiraExpressionsResource.evaluateJiraExpression_post", "summary" : "Evaluate Jira expression" } }, "/api/3/jql/parse" : { "post" : { "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JqlQueriesToParse" }, "example" : { "queries" : [ "summary ~ test AND (labels in (urgent, blocker) OR lastCommentedBy = currentUser()) AND status CHANGED AFTER startOfMonth(-1M) ORDER BY updated DESC", "invalid query", "summary = test", "summary in test", "project = INVALID", "universe = 42" ] } } }, "required" : true }, "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "JQL" ], "operationId" : "com.atlassian.jira.rest.v2.jql.JqlParserResource.parseJqlQueries_post", "summary" : "Parse JQL query", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Parses and validates JQL queries.\n\nValidation is performed in context of the current user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ParsedJqlQueries" }, "example" : "{\"queries\":[{\"query\":\"summary ~ test AND (labels in (urgent, blocker) OR lastCommentedBy = currentUser()) AND status CHANGED AFTER -5d ORDER BY updated DESC\",\"structure\":{\"where\":{\"clauses\":[{\"field\":{\"name\":\"summary\"},\"operator\":\"~\",\"operand\":{\"value\":\"test\"}},{\"clauses\":[{\"field\":{\"name\":\"labels\"},\"operator\":\"in\",\"operand\":{\"values\":[{\"value\":\"urgent\"},{\"value\":\"blocker\"}]}},{\"field\":{\"name\":\"lastCommentedBy\",\"property\":[{\"entity\":\"issue\",\"key\":\"propertyKey\",\"path\":\"path.in.property\",\"type\":\"user\"}]},\"operator\":\"=\",\"operand\":{\"function\":\"currentUser\",\"arguments\":[]}}],\"operator\":\"or\"},{\"field\":{\"name\":\"status\"},\"operator\":\"changed\",\"predicates\":[{\"operator\":\"after\",\"operand\":{\"function\":\"startOfMonth\",\"arguments\":[\"-1M\"]}}]}],\"operator\":\"and\"},\"orderBy\":{\"fields\":[{\"field\":{\"name\":\"updated\"},\"direction\":\"desc\"}]}}},{\"query\":\"invalid query\",\"errors\":[\"Error in the JQL Query: Expecting operator but got 'query'. The valid operators are '=', '!=', '<', '>', '<=', '>=', '~', '!~', 'IN', 'NOT IN', 'IS' and 'IS NOT'. (line 1, character 9)\"]},{\"query\":\"summary = test\",\"errors\":[\"The operator '=' is not supported by the 'summary' field.\"]},{\"query\":\"summary in test\",\"errors\":[\"Operator 'in' does not support the non-list value '\\\"test\\\"' for field 'summary'.\"]},{\"query\":\"project = INVALID\",\"errors\":[\"The value 'INVALID' does not exist for the field 'project'.\"]},{\"query\":\"universe = 42\",\"errors\":[\"Field 'universe' does not exist or you do not have permission to view it.\"]}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "400" : { "description" : "Returned if the request is invalid.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } } } }, "/api/3/workflowscheme/project" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.project.WorkflowSchemeProjectResource.getWorkflowSchemeProjectAssociations_get", "summary" : "Get workflow scheme project associations", "responses" : { "400" : { "content" : { "application/json" : { "example" : "{\"errorMessages\":[],\"errors\":{\"projectId\":\"The projectId query param is required.\"}}" } }, "description" : "Returned if the request is invalid." }, "403" : { "content" : { "application/json" : { "example" : "{\"errorMessages\":[\"Only Jira administrators can access workflow scheme associations.\"],\"errors\":{}}" } }, "description" : "Returned if the user does not have the necessary permission." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"values\":[{\"projectIds\":[\"10010\",\"10020\"],\"workflowScheme\":{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}}]}", "schema" : { "$ref" : "#/components/schemas/ContainerOfWorkflowSchemeAssociations" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any next-gen or non-existent projects in the request are ignored and no errors are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "x-experimental" : true, "tags" : [ "Workflow scheme project associations" ], "deprecated" : false, "parameters" : [ { "schema" : { "maxItems" : 100, "minItems" : 1, "uniqueItems" : true, "items" : { "format" : "int64", "type" : "integer", "example" : 10010 }, "type" : "array" }, "required" : true, "in" : "query", "description" : "The ID of a project to return the workflow schemes for. To include multiple projects, provide multiple copies of this parameter. For example, `projectId=10000&projectId=10001`.", "name" : "projectId" } ], "x-atlassian-connect-scope" : "ADMIN" } }, "/api/3/label" : { "get" : { "summary" : "Get all labels", "operationId" : "com.atlassian.jira.rest.v2.label.LabelResource.getAllLabels_get", "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"maxResults\":2,\"startAt\":0,\"total\":100,\"isLast\":false,\"values\":[\"performance\",\"security\"]}", "schema" : { "$ref" : "#/components/schemas/PageBeanString" } } }, "description" : "Returned if the request is successful." } }, "description" : "Returns a [paginated](#pagination) list of available labels.", "security" : [ { "basicAuth" : [] } ], "tags" : [ "Labels" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "in" : "query", "schema" : { "format" : "int64", "type" : "integer", "default" : 0 }, "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "in" : "query", "schema" : { "default" : 1000, "format" : "int32", "type" : "integer" }, "name" : "maxResults", "description" : "The maximum number of items to return per page." } ], "deprecated" : false } }, "/api/3/user/picker" : { "get" : { "tags" : [ "User search" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "query", "description" : "A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*.", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "maxResults", "description" : "The maximum number of items to return. The maximum is `1000`. The total number of matched users is returned in `total`.", "in" : "query", "schema" : { "default" : 50, "type" : "integer", "format" : "int32" } }, { "description" : "Include the URI to the user's avatar.", "name" : "showAvatar", "in" : "query", "schema" : { "type" : "boolean", "default" : false } }, { "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "in" : "query", "name" : "exclude", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "in" : "query", "name" : "excludeAccountIds", "description" : "A comma-separated list of account IDs to exclude from the search results. This parameter may be specified multiple times. For example, `excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5`. Cannot be provided with `exclude`." }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "avatarSize" }, { "name" : "excludeConnectUsers", "schema" : { "default" : false, "type" : "boolean" }, "in" : "query" } ], "summary" : "Find users for picker", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.findUsersForPicker_get", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"users\":[{\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"mia\",\"key\":\"mia\",\"html\":\"Mia Krystof - mia@example.com (mia)\",\"displayName\":\"Mia Krystof\",\"avatarUrl\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\"}],\"total\":25,\"header\":\"Showing 20 of 25 matching groups\"}", "schema" : { "$ref" : "#/components/schemas/FoundUsers" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if `exclude` and `excludeAccountIds` are provided." } }, "description" : "Returns a list of users whose attributes match the query term. The returned object includes the `html` field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return search results for an exact name match only.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ] } }, "/api/3/jql/match" : { "post" : { "operationId" : "com.atlassian.jira.rest.v2.match.IssueMatchResource.matchIssues_post", "summary" : "Check issues against JQL", "security" : [ { "basicAuth" : [] } ], "description" : "Checks whether one or more issues would be returned by one or more JQL queries.\n\n**[Permissions](#permissions) required:** None, however, issues are only matched against JQL queries where the user has:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "responses" : { "400" : { "description" : "Returned if `jqls` exceeds the maximum number of JQL queries or `issueIds` exceeds the maximum number of issue IDs." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueMatches" }, "example" : "{\"matches\":[{\"matchedIssues\":[10000,10004],\"errors\":[]},{\"matchedIssues\":[100134,10025,10236],\"errors\":[]},{\"matchedIssues\":[],\"errors\":[]},{\"matchedIssues\":[],\"errors\":[\"Invalid JQL: broken = value\"]}]}" } } } }, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssuesAndJQLQueries" }, "example" : { "jqls" : [ "project = FOO", "issuetype = Bug", "summary ~ \"some text\" AND project in (FOO, BAR)" ], "issueIds" : [ 10001, 1000, 10042 ] } } }, "required" : true }, "x-experimental" : true, "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue search" ] } }, "/api/3/user/permission/search" : { "get" : { "tags" : [ "User search" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "example" : "query", "type" : "string" }, "in" : "query", "name" : "query", "description" : "A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` is specified.", "x-showInExample" : "true" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username" }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless `query` is specified.", "name" : "accountId" }, { "name" : "permissions", "description" : "A comma-separated list of permissions. The valid permissions are:\n\n * ASSIGNABLE\\_USER\n * ASSIGN\\_ISSUE\n * ATTACHMENT\\_DELETE\\_ALL\n * ATTACHMENT\\_DELETE\\_OWN\n * BROWSE\n * CLOSE\\_ISSUE\n * COMMENT\\_DELETE\\_ALL\n * COMMENT\\_DELETE\\_OWN\n * COMMENT\\_EDIT\\_ALL\n * COMMENT\\_EDIT\\_OWN\n * COMMENT\\_ISSUE\n * CREATE\\_ATTACHMENT\n * CREATE\\_ISSUE\n * DELETE\\_ISSUE\n * EDIT\\_ISSUE\n * LINK\\_ISSUE\n * MANAGE\\_WATCHER\\_LIST\n * MODIFY\\_REPORTER\n * MOVE\\_ISSUE\n * PROJECT\\_ADMIN\n * RESOLVE\\_ISSUE\n * SCHEDULE\\_ISSUE\n * SET\\_ISSUE\\_SECURITY\n * TRANSITION\\_ISSUE\n * VIEW\\_VERSION\\_CONTROL\n * VIEW\\_VOTERS\\_AND\\_WATCHERS\n * VIEW\\_WORKFLOW\\_READONLY\n * WORKLOG\\_DELETE\\_ALL\n * WORKLOG\\_DELETE\\_OWN\n * WORKLOG\\_EDIT\\_ALL\n * WORKLOG\\_EDIT\\_OWN\n * WORK\\_ISSUE", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "issueKey", "description" : "The issue key for the issue.", "schema" : { "type" : "string" }, "in" : "query" }, { "name" : "projectKey", "description" : "The project key for the project (case sensitive).", "schema" : { "type" : "string" }, "in" : "query" }, { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "format" : "int32", "type" : "integer", "default" : 0 }, "in" : "query" }, { "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `1000`." } ], "responses" : { "404" : { "description" : "Returned if the issue or project is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5\",\"key\":\"\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32\"},\"displayName\":\"Emma Richards\",\"active\":false}]" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if:\n\n * `issueKey` or `projectKey` is missing.\n * neither of `query` or `accountId` are provided.\n * both `query` and `accountId` are provided.\n * `permissions` is empty or contains an invalid entry." } }, "description" : "Returns a list of users who fulfill these criteria:\n\n * their user attributes match a search string.\n * they have a set of permissions for a project or issue.\n\nIf no search string is provided, a list of all users with the permissions is returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get users for any project.\n * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project, to get users for that project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "summary" : "Find users with permissions", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.findUsersWithAllPermissions_get" } }, "/api/3/issueLinkType" : { "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueLinkTypeResource.createIssueLinkType_post", "summary" : "Create issue link type", "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"}", "schema" : { "$ref" : "#/components/schemas/IssueLinkType" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the issue link type name is in use.\n * the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link's inward and outward relationships.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueLinkType" }, "example" : { "name" : "Duplicate", "outward" : "Duplicates", "inward" : "Duplicated by" } } }, "required" : true }, "tags" : [ "Issue link types" ], "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "ADMIN" }, "get" : { "tags" : [ "Issue link types" ], "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "READ", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"issueLinkTypes\":[{\"id\":\"1000\",\"name\":\"Duplicate\",\"inward\":\"Duplicated by\",\"outward\":\"Duplicates\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1000\"},{\"id\":\"1010\",\"name\":\"Blocks\",\"inward\":\"Blocked by\",\"outward\":\"Blocks\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueLinkType/1010\"}]}", "schema" : { "$ref" : "#/components/schemas/IssueLinkTypes" } } } }, "404" : { "description" : "Returned if issue linking is disabled." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a list of all issue link types.\n\nTo use this operation, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project in the site.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueLinkTypeResource.getIssueLinkTypes_get", "summary" : "Get issue link types" } }, "/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}" : { "put" : { "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.setDashboardItemProperty_put", "summary" : "Set dashboard item property", "responses" : { "403" : { "description" : "Returned if the user is not the owner of the dashboard." }, "400" : { "description" : "Returned if the request is invalid." }, "201" : { "description" : "Returned if the dashboard item property is created.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if the dashboard item is not found or the dashboard is not shared with the user." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the dashboard item property is updated." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.\n\nA dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).\n\nWhen an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see [ Building a dashboard item for a JIRA Connect add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation.\n\nThere is no resource to set or get dashboard items.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard.", "requestBody" : { "content" : { "application/json" : { "schema" : {} } }, "required" : true }, "tags" : [ "Dashboards" ], "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the dashboard.", "name" : "dashboardId" }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "itemId", "description" : "The ID of the dashboard item." }, { "name" : "propertyKey", "description" : "The key of the dashboard item property. The maximum length is 255 characters.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "x-atlassian-connect-scope" : "WRITE" }, "delete" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the dashboard item is not found or the dashboard is not shared with the user." }, "204" : { "description" : "Returned if the dashboard item property is deleted." }, "403" : { "description" : "Returned if the user is not the owner of the dashboard." }, "400" : { "description" : "Returned if the dashboard or dashboard item ID is invalid." } }, "description" : "Deletes a dashboard item property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The user must be the owner of the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "summary" : "Delete dashboard item property", "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.deleteDashboardItemProperty_delete", "tags" : [ "Dashboards" ], "x-atlassian-connect-scope" : "DELETE", "deprecated" : false, "parameters" : [ { "name" : "dashboardId", "description" : "The ID of the dashboard.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "itemId", "description" : "The ID of the dashboard item." }, { "name" : "propertyKey", "description" : "The key of the dashboard item property.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ] }, "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "dashboardId", "description" : "The ID of the dashboard." }, { "description" : "The ID of the dashboard item.", "name" : "itemId", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "description" : "The key of the dashboard item property.", "name" : "propertyKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "tags" : [ "Dashboards" ], "summary" : "Get dashboard item property", "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.getDashboardItemProperty_get", "description" : "Returns the key and value of a dashboard item property.\n\nA dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ).\n\nWhen an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see [ Building a dashboard item for a JIRA Connect add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation.\n\nThere is no resource to set or get dashboard items.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The user must be the owner of the dashboard or be shared the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the dashboard, the dashboard item, or dashboard item property is not found, or the dashboard is not owned by or shared with the user." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityProperty" }, "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}" } }, "description" : "Returned if the request is successful." } } } }, "/api/3/user/bulk" : { "get" : { "description" : "Returns details of the users specified by one or more account IDs.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"maxResults\":100,\"startAt\":0,\"total\":1,\"isLast\":true,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanUser" } } } }, "400" : { "description" : "Returned if `accountID` is missing." } }, "summary" : "Bulk get users", "operationId" : "com.atlassian.jira.rest.v2.user.UserBulkResource.bulkGetUsers_get", "x-atlassian-connect-scope" : "READ", "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "in" : "query", "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "schema" : { "default" : 10, "format" : "int32", "type" : "integer" }, "in" : "query", "description" : "The maximum number of items to return per page. The maximum is `200`.", "name" : "maxResults" }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "name" : "key", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "in" : "query", "required" : true, "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "items" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" }, "type" : "array" }, "x-showInExample" : "true", "name" : "accountId", "description" : "Account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`. Required." } ], "deprecated" : false, "tags" : [ "Users" ], "x-experimental" : true } }, "/atlassian-connect/1/addons/{addonKey}/properties" : { "get" : { "x-atlassian-connect-scope" : "NONE", "parameters" : [ { "name" : "addonKey", "description" : "The key of the app, as defined in its descriptor.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "App properties" ], "summary" : "Get app properties", "operationId" : "AddonPropertiesResource.getAddonProperties_get", "description" : "Gets all the properties of an app.\n\n**[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing.", "content" : { "application/json" : { "example" : { "message" : "Access to this resource must be authenticated as an app.", "statusCode" : 401 }, "schema" : { "$ref" : "#/components/schemas/OperationMessage" } } } }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : { "keys" : [ { "key" : "propertyKey", "self" : "http://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey" } ] }, "schema" : { "$ref" : "#/components/schemas/PropertyKeys" } } } } } } }, "/api/3/workflowscheme/{id}/draft/default" : { "delete" : { "parameters" : [ { "description" : "The ID of the workflow scheme that the draft belongs to.", "name" : "id", "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow scheme drafts" ], "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteDraftDefaultWorkflow_delete", "summary" : "Delete draft default workflow", "security" : [ { "basicAuth" : [] } ], "description" : "Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if the user is not permitted to create workflows." }, "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}" } } } } }, "get" : { "parameters" : [ { "description" : "The ID of the workflow scheme that the draft belongs to.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow scheme drafts" ], "security" : [ { "basicAuth" : [] } ], "description" : "Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if the user is not permitted to create workflows." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"workflow\":\"jira\"}", "schema" : { "$ref" : "#/components/schemas/DefaultWorkflow" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getDraftDefaultWorkflow_get", "summary" : "Get draft default workflow" }, "put" : { "responses" : { "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "400" : { "description" : "Returned if the request is invalid." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Sets the default workflow for a workflow scheme's draft.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.updateDraftDefaultWorkflow_put", "summary" : "Update draft default workflow", "tags" : [ "Workflow scheme drafts" ], "parameters" : [ { "name" : "id", "description" : "The ID of the workflow scheme that the draft belongs to.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "requestBody" : { "required" : true, "description" : "The object for the new default workflow.", "content" : { "application/json" : { "example" : { "updateDraftIfNeeded" : false, "workflow" : "jira" }, "schema" : { "$ref" : "#/components/schemas/DefaultWorkflow" } } } } } }, "/api/3/screens/addToDefault/{fieldId}" : { "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.addFieldToDefaultScreen_post", "summary" : "Add field to default screen", "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "404" : { "description" : "Returned if the field it not found or the field is already present." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Adds a field to the default tab of the default screen.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "tags" : [ "Screens" ], "parameters" : [ { "name" : "fieldId", "description" : "The ID of the field.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "deprecated" : false, "x-atlassian-connect-scope" : "ADMIN" } }, "/api/3/project/{projectIdOrKey}/roledetails" : { "get" : { "description" : "Returns all [project roles](https://confluence.atlassian.com/x/3odKLg) and the details for each role. Note that the list of project roles is common to all projects.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the project is not found or if the user does not have the necessary permissions for the project." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ProjectRole" }, "type" : "array" }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]" } }, "description" : "Returned if the request is successful." } }, "summary" : "Get project role details", "operationId" : "com.atlassian.jira.rest.v2.issue.project.ProjectRoleDetailsResource.getProjectRoleDetails_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "description" : "Whether the roles should be filtered to include only those the user is assigned to.", "name" : "currentMember" }, { "name" : "excludeConnectAddons", "schema" : { "default" : false, "type" : "boolean" }, "in" : "query" } ], "tags" : [ "Project roles" ] } }, "/api/3/projectCategory/{id}" : { "put" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectCategoryResource.updateProjectCategory_put", "summary" : "Update project category", "responses" : { "403" : { "description" : "Returned if the user does not have the necessary permission." }, "404" : { "description" : "Returned if the project category is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdatedProjectCategory" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10100\",\"id\":\"10100\",\"name\":\"UPDATED\",\"description\":\"Updated Project Category\"}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] } ], "description" : "Updates a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "requestBody" : { "content" : { "application/json" : { "example" : { "name" : "UPDATED", "description" : "Updated Project Category" }, "schema" : { "$ref" : "#/components/schemas/ProjectCategory" } } }, "required" : true }, "tags" : [ "Project categories" ], "deprecated" : false, "parameters" : [ { "name" : "id", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "INACCESSIBLE" }, "get" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path", "description" : "The ID of the project category.", "name" : "id" } ], "deprecated" : false, "tags" : [ "Project categories" ], "description" : "Returns a project category.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectCategory" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project category is not found." } }, "summary" : "Get project category by id", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectCategoryResource.getProjectCategoryById_get" }, "delete" : { "tags" : [ "Project categories" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "ID of the project category to delete.", "name" : "id" } ], "deprecated" : false, "responses" : { "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the necessary permission." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project category is not found." } }, "description" : "Deletes a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] } ], "summary" : "Delete project category", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectCategoryResource.removeProjectCategory_delete" } }, "/api/3/projectvalidate/validProjectKey" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectValidateResource.getValidProjectKey_get", "summary" : "Get valid project key", "responses" : { "200" : { "content" : { "application/json" : { "example" : "\"VPNE\"", "schema" : { "type" : "string" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "tags" : [ "Project key and name validation" ], "deprecated" : false, "parameters" : [ { "name" : "key", "description" : "The project key.", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "HSP" }, "in" : "query" } ], "x-atlassian-connect-scope" : "INACCESSIBLE" } }, "/api/3/user/bulk/migration" : { "get" : { "x-experimental" : true, "tags" : [ "Users" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" }, "in" : "query" }, { "description" : "The maximum number of items to return per page.", "name" : "maxResults", "in" : "query", "schema" : { "format" : "int32", "type" : "integer", "default" : 10 } }, { "name" : "username", "description" : "Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, `username=fred&username=barney`. Required if `key` isn't provided. Cannot be provided if `key` is present.", "in" : "query", "schema" : { "items" : { "type" : "string" }, "type" : "array" } }, { "name" : "key", "description" : "Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, `key=fred&key=barney`. Required if `username` isn't provided. Cannot be provided if `username` is present.", "in" : "query", "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "summary" : "Get account IDs for users", "operationId" : "com.atlassian.jira.rest.v2.user.UserBulkResource.bulkGetUsersMigration_get", "responses" : { "400" : { "description" : "Returned if `key` or `username`" }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "[{\"username\":\"mia\",\"accountId\":\"5b10a2844c20165700ede21g\"},{\"username\":\"emma\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\"}]", "schema" : { "items" : { "$ref" : "#/components/schemas/UserMigrationBean" }, "type" : "array" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Returns the account IDs for the users specified in the `key` or `username` parameters. Note that multiple `key` or `username` parameters can be specified.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ] } }, "/api/3/permissions/check" : { "post" : { "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "READ", "tags" : [ "Permissions" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "globalPermissions" : [ "SYSTEM_ADMIN" ], "projectPermissions" : [ { "issues" : [ 10010, 10011, 10012, 10013, 10014 ], "permissions" : [ "EDIT_ISSUE" ], "projects" : [ 10001 ] } ] }, "schema" : { "$ref" : "#/components/schemas/BulkPermissionsRequestBean" } } }, "description" : "Details of the permissions to check." }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [] }, {} ], "description" : "Returns:\n\n * for a list of global permissions, the global permissions granted to the user.\n * for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.\n\nNote that:\n\n * Invalid project and issue IDs are ignored.\n * A maximum of 1000 projects and 1000 issues can be checked.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" }, "example" : "{\"errorMessages\":[],\"errors\":{\"PERMISSION_123\":\"Unrecognized permission\"}}" } }, "description" : "Returned if:\n\n * issue or project IDs are provided without at least one project permission being provided.\n * an invalid global permission is provided in the global permissions list.\n * an invalid project permission is provided in the project permissions list.\n * more than 1000 valid project IDs or more than 1000 valid issue IDs are provided." }, "200" : { "content" : { "application/json" : { "example" : "{\"projectPermissions\":[{\"permission\":\"EDIT_ISSUE\",\"issues\":[10010,10013,10014],\"projects\":[10001]}],\"globalPermissions\":[\"SYSTEM_ADMIN\"]}", "schema" : { "$ref" : "#/components/schemas/BulkPermissionGrants" } } }, "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.permission.PermissionsResource.getBulkPermissions_post", "summary" : "Get bulk permissions" } }, "/api/3/workflow/transitions/{transitionId}/properties" : { "delete" : { "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "200 response" }, "404" : { "description" : "Returned if the workflow transition is not found." }, "304" : { "description" : "Returned if no changes were made by the request. For example, trying to delete a property that cannot be found." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if the request is invalid." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource.deleteWorkflowTransitionProperty_delete", "summary" : "Delete workflow transition property", "tags" : [ "Workflow transition properties" ], "parameters" : [ { "description" : "The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.", "name" : "transitionId", "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" } }, { "required" : true, "in" : "query", "schema" : { "type" : "string" }, "description" : "The name of the transition property to delete, also known as the name of the property.", "name" : "key" }, { "description" : "The name of the workflow that the transition belongs to.", "name" : "workflowName", "schema" : { "type" : "string" }, "required" : true, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string", "enum" : [ "live", "draft" ] }, "name" : "workflowMode", "description" : "The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited." } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE" }, "get" : { "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "name" : "transitionId", "description" : "The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition." }, { "schema" : { "default" : false, "type" : "boolean" }, "in" : "query", "name" : "includeReservedKeys", "description" : "Some properties with keys that have the *jira.* prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to *true*." }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.", "name" : "key" }, { "name" : "workflowName", "description" : "The name of the workflow that the transition belongs to.", "schema" : { "type" : "string" }, "in" : "query", "required" : true }, { "description" : "The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows.", "name" : "workflowMode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "live", "draft" ], "default" : "live" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "ADMIN", "tags" : [ "Workflow transition properties" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if the user does not have admin permission" }, "400" : { "description" : "Returned if the request is invalid." }, "404" : { "description" : "Returned if the workflow transition or property is not found." }, "200" : { "content" : { "application/json" : { "example" : "[{\"key\":\"jira.i18n.title\",\"value\":\"some.title\",\"id\":\"jira.i18n.title\"},{\"key\":\"jira.permission\",\"value\":\"createissue\",\"id\":\"jira.permission\"}]", "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionProperty" } } }, "description" : "200 response" }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource.getWorkflowTransitionProperties_get", "summary" : "Get workflow transition properties" }, "put" : { "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionProperty" }, "example" : { "value" : "createissue" } } }, "required" : true }, "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "name" : "transitionId", "description" : "The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "key", "description" : "The key of the property being updated, also known as the name of the property. Set this to the same value as the `key` defined in the request body.", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The name of the workflow that the transition belongs to.", "name" : "workflowName", "schema" : { "type" : "string" }, "required" : true, "in" : "query" }, { "name" : "workflowMode", "description" : "The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited.", "schema" : { "enum" : [ "live", "draft" ], "type" : "string" }, "in" : "query" } ], "tags" : [ "Workflow transition properties" ], "summary" : "Update workflow transition property", "operationId" : "com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource.updateWorkflowTransitionProperty_put", "description" : "Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "304" : { "description" : "Returned if no changes were made by the request. For example, attempting to update a property with its current value." }, "404" : { "description" : "Returned if the workflow transition is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "200 response", "content" : { "application/json" : { "example" : "{\"key\":\"jira.i18n.title\",\"value\":\"some.title\",\"id\":\"jira.i18n.title\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionProperty" } } } } } }, "post" : { "tags" : [ "Workflow transition properties" ], "parameters" : [ { "name" : "transitionId", "description" : "The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The key of the property being added, also known as the name of the property. Set this to the same value as the `key` defined in the request body.", "name" : "key", "schema" : { "type" : "string" }, "required" : true, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "required" : true, "name" : "workflowName", "description" : "The name of the workflow that the transition belongs to." }, { "schema" : { "type" : "string", "enum" : [ "live", "draft" ], "default" : "live" }, "in" : "query", "name" : "workflowMode", "description" : "The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited." } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionProperty" }, "example" : { "value" : "createissue" } } }, "required" : true }, "responses" : { "400" : { "description" : "Returned if a workflow property with the same key is present on the transition." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"key\":\"jira.i18n.title\",\"value\":\"some.title\",\"id\":\"jira.i18n.title\"}", "schema" : { "$ref" : "#/components/schemas/WorkflowTransitionProperty" } } }, "description" : "200 response" }, "404" : { "description" : "Returned if the workflow transition is not found." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.WorkflowTransitionResource.createWorkflowTransitionProperty_post", "summary" : "Create workflow transition property" } }, "/api/3/filter/{id}/favourite" : { "delete" : { "parameters" : [ { "name" : "id", "description" : "The ID of the filter.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`." } ], "deprecated" : false, "x-atlassian-connect-scope" : "DELETE", "tags" : [ "Filters" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "400" : { "description" : "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}", "schema" : { "$ref" : "#/components/schemas/Filter" } } }, "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.deleteFavouriteForFilter_delete", "summary" : "Remove filter as favorite" }, "put" : { "description" : "Add a filter as a favorite for the user.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, the user can only favorite:\n\n * filters owned by the user.\n * filters shared with a group that the user is a member of.\n * filters shared with a private project that the user has *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for.\n * filters shared with a public project.\n * filters shared with the public.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Filter" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/filter/10000\",\"id\":\"10000\",\"name\":\"All Open Bugs\",\"description\":\"Lists all open bugs\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"jql\":\"type = Bug and resolution is empty\",\"viewUrl\":\"http://your-domain.atlassian.net/issues/?filter=10000\",\"searchUrl\":\"http://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty\",\"favourite\":true,\"favouritedCount\":0,\"sharePermissions\":[],\"subscriptions\":{\"size\":0,\"items\":[],\"max-results\":0,\"start-index\":0,\"end-index\":0}}" } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if:\n\n * the filter is not found.\n * the user does not have permission to favorite the filter." } }, "summary" : "Add filter as favorite", "operationId" : "com.atlassian.jira.rest.v2.search.FilterResource.setFavouriteForFilter_put", "x-atlassian-connect-scope" : "WRITE", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the filter." }, { "description" : "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts multiple values separated by a comma:\n\n * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`.\n * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`.", "name" : "expand", "in" : "query", "schema" : { "type" : "string" } } ], "tags" : [ "Filters" ] } }, "/api/3/user/properties/{propertyKey}" : { "put" : { "description" : "Sets the value of a user's property. Use this resource to store custom data against a user.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on any user.\n * Access to Jira, to set a property on the calling user's record.\n\nNote: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/8YxjL) that are set in Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] } ], "responses" : { "403" : { "description" : "Returned if the calling user does not have the *Administer Jira* permission or is not accessing their user record." }, "400" : { "description" : "Returned if `accountId` is missing." }, "405" : { "description" : "Returned if the property key is not specified." }, "201" : { "description" : "Returned if the user property is created.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if the user is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the user property is updated." } }, "summary" : "Set user property", "operationId" : "com.atlassian.jira.rest.v2.userproperty.UserPropertyResource.setUserProperty_put", "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" }, "in" : "query" }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "userKey", "in" : "query", "schema" : { "type" : "string" } }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "in" : "query", "schema" : { "type" : "string" } }, { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "propertyKey", "description" : "The key of the user's property. The maximum length is 255 characters." } ], "deprecated" : false, "tags" : [ "User properties" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : {} } } } }, "get" : { "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" }, "in" : "query", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "name" : "accountId", "x-showInExample" : "true" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "userKey", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username" }, { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The key of the user's property.", "name" : "propertyKey" } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "User properties" ], "operationId" : "com.atlassian.jira.rest.v2.userproperty.UserPropertyResource.getUserProperty_get", "summary" : "Get user property", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "description" : "Returns the value of a user's property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from any user.\n * Access to Jira, to get a property from the calling user's record.\n\nNote: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/74xjL) that are set in Jira.", "responses" : { "403" : { "description" : "Returned if the calling user does not have the *Administer Jira* permission or is not accessing their user record." }, "400" : { "description" : "Returned if `accountId` is missing." }, "404" : { "description" : "Returned if the user is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityProperty" }, "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } } }, "delete" : { "tags" : [ "User properties" ], "x-atlassian-connect-scope" : "DELETE", "parameters" : [ { "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" }, "in" : "query", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "x-showInExample" : "true" }, { "name" : "userKey", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "in" : "query", "schema" : { "type" : "string" } }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "in" : "query", "schema" : { "type" : "string" } }, { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "propertyKey", "description" : "The key of the user's property." } ], "deprecated" : false, "responses" : { "204" : { "description" : "Returned if the user property is deleted." }, "403" : { "description" : "Returned if the user does not have the *Administer Jira* permission or is not accessing their user record." }, "400" : { "description" : "Returned if `accountId` is missing." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the user or the property is not found." } }, "description" : "Deletes a property from a user.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property from any user.\n * Access to Jira, to delete a property from the calling user's record.\n\nNote: These user properties are unrelated to the [user properties](https://confluence.atlassian.com/x/74xjL) that are set in Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] } ], "summary" : "Delete user property", "operationId" : "com.atlassian.jira.rest.v2.userproperty.UserPropertyResource.deleteUserProperty_delete" } }, "/api/3/permissionscheme" : { "post" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "name" : "expand", "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission.", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "Permission schemes" ], "requestBody" : { "required" : true, "description" : "The permission scheme to create.", "content" : { "application/json" : { "example" : { "description" : "description", "name" : "Example permission scheme", "permissions" : [ { "permission" : "ADMINISTER_PROJECTS", "holder" : { "type" : "group", "parameter" : "jira-core-users" } } ] }, "schema" : { "$ref" : "#/components/schemas/PermissionScheme" } } } }, "description" : "Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "403" : { "description" : "Returned if the user is not permitted to create permission schemes." }, "400" : { "description" : "Returned if the request is invalid." }, "201" : { "description" : "Returned if the permission scheme is created.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionScheme" }, "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "summary" : "Create permission scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.createPermissionScheme_post" }, "get" : { "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Permission schemes" ], "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.getAllPermissionSchemes_get", "summary" : "Get all permission schemes", "security" : [ { "basicAuth" : [] } ], "description" : "Returns all permission schemes.\n\n### About permission schemes and grants ###\n\nA permission scheme is a collection of permission grants. A permission grant consists of a `holder` and a `permission`.\n\n#### Holder object ####\n\nThe `holder` object contains information about the user or group being granted the permission. For example, the *Administer projects* permission is granted to a group named *Teams in space administrators*. In this case, the type is `\"type\": \"group\"`, and the parameter is the group name, `\"parameter\": \"Teams in space administrators\"`. The `holder` object is defined by the following properties:\n\n * `type` Identifies the user or group (see the list of types below).\n * `parameter` The value of this property depends on the `type`. For example, if the `type` is a group, then you need to specify the group name.\n\nThe following `types` are available. The expected values for the `parameter` are given in parenthesis (some `types` may not have a `parameter`):\n\n * `anyone` Grant for anonymous users.\n * `applicationRole` Grant for users with access to the specified application (application name). See [Update product access settings](https://confluence.atlassian.com/x/3YxjL) for more information.\n * `assignee` Grant for the user currently assigned to an issue.\n * `group` Grant for the specified group (group name).\n * `groupCustomField` Grant for a user in the group selected in the specified custom field (custom field ID).\n * `projectLead` Grant for a project lead.\n * `projectRole` Grant for the specified project role (project role ID).\n * `reporter` Grant for the user who reported the issue.\n * `sd.customer.portal.only` Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See [Customizing Jira Service Desk permissions](https://confluence.atlassian.com/x/24dKLg) for more information.\n * `user` Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).\n * `userCustomField` Grant for a user selected in the specified custom field (custom field ID).\n\n#### Built-in permissions ####\n\nThe [built-in Jira permissions](https://confluence.atlassian.com/x/yodKLg) are listed below. Apps can also define custom permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information.\n\n**Project permissions**\n\n * `ADMINISTER_PROJECTS`\n * `BROWSE_PROJECTS`\n * `MANAGE_SPRINTS_PERMISSION` (Jira Software only)\n * `SERVICEDESK_AGENT` (Jira Service Desk only)\n * `VIEW_DEV_TOOLS` (Jira Software only)\n * `VIEW_READONLY_WORKFLOW`\n\n**Issue permissions**\n\n * `ASSIGNABLE_USER`\n * `ASSIGN_ISSUES`\n * `CLOSE_ISSUES`\n * `CREATE_ISSUES`\n * `DELETE_ISSUES`\n * `EDIT_ISSUES`\n * `LINK_ISSUES`\n * `MODIFY_REPORTER`\n * `MOVE_ISSUES`\n * `RESOLVE_ISSUES`\n * `SCHEDULE_ISSUES`\n * `SET_ISSUE_SECURITY`\n * `TRANSITION_ISSUES`\n\n**Voters and watchers permissions**\n\n * `MANAGE_WATCHERS`\n * `VIEW_VOTERS_AND_WATCHERS`\n\n**Comments permissions**\n\n * `ADD_COMMENTS`\n * `DELETE_ALL_COMMENTS`\n * `DELETE_OWN_COMMENTS`\n * `EDIT_ALL_COMMENTS`\n * `EDIT_OWN_COMMENTS`\n\n**Attachments permissions**\n\n * `CREATE_ATTACHMENTS`\n * `DELETE_ALL_ATTACHMENTS`\n * `DELETE_OWN_ATTACHMENTS`\n\n**Time tracking permissions**\n\n * `DELETE_ALL_WORKLOGS`\n * `DELETE_OWN_WORKLOGS`\n * `EDIT_ALL_WORKLOGS`\n * `EDIT_OWN_WORKLOGS`\n * `WORK_ON_ISSUES`\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionSchemes" }, "example" : "{\"permissionSchemes\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\"}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } } } }, "/api/3/version/{id}/removeAndSwap" : { "post" : { "tags" : [ "Project versions" ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the version." } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeleteAndReplaceVersionBean" } } } }, "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the version to delete is not found.\n * the user does not have the required permissions." }, "204" : { "description" : "Returned if the version is deleted.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "Returned if the request is invalid." } }, "description" : "Deletes a project version.\n\nAlternative versions can be provided to update issues that use the deleted version in `fixVersion`, `affectedVersion`, or any version picker custom fields. If alternatives are not provided, occurrences of `fixVersion`, `affectedVersion`, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "summary" : "Delete and replace version", "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.deleteAndReplaceVersion_post" } }, "/api/3/issuetype/{id}/alternatives" : { "get" : { "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "id", "description" : "The ID of the issue type." } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue types" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "404" : { "description" : "Returned if:\n\n * the issue type is not found.\n * the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]", "schema" : { "items" : { "$ref" : "#/components/schemas/IssueTypeBean" }, "type" : "array" } } }, "description" : "Returned if the request is successful." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.getAlternativeIssueTypes_get", "summary" : "Get alternative issue types" } }, "/api/3/role/{id}/actors" : { "get" : { "tags" : [ "Project role actors" ], "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" }, "name" : "id", "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." } ], "responses" : { "403" : { "description" : "Returned if the user does not have administrative permissions." }, "400" : { "description" : "Returned if the request is invalid." }, "404" : { "description" : "Returned if the project role is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectRole" }, "example" : "{\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}}]}" } }, "description" : "Returned if the request is successful." } }, "description" : "Returns the [default actors](#api-rest-api-3-resolution-get) for the project role.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "summary" : "Get default actors for project role", "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.getProjectRoleActorsForRole_get" }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.deleteProjectRoleActorsFromRole_delete", "summary" : "Delete default actors from project role", "security" : [ { "basicAuth" : [] } ], "description" : "Deletes the [default actors](#api-rest-api-3-resolution-get) from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.\n\nChanging a project role's default actors does not affect project role members for projects already created.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "404" : { "description" : "Returned if the project role is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectRole" }, "example" : "{\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}}]}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have administrative permissions." }, "400" : { "description" : "Returned if the request is invalid." } }, "deprecated" : false, "parameters" : [ { "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "name" : "id", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" }, { "schema" : { "type" : "string", "example" : "5b10ac8d82e05b22cc7d4ef5" }, "in" : "query", "name" : "user", "description" : "The user account ID of the user to remove as a default actor.", "x-showInExample" : "true" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "group", "description" : "The group name of the group to be removed as a default actor." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Project role actors" ] }, "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.addProjectRoleActorsToRole_post", "summary" : "Add default actors to project role", "responses" : { "404" : { "description" : "Returned if the project role is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}}]}", "schema" : { "$ref" : "#/components/schemas/ProjectRole" } } } }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have administrative permissions." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Adds [default actors](#api-rest-api-3-resolution-get) to a role. You may add groups or users, but you cannot add groups and users in the same request.\n\nChanging a project role's default actors does not affect project role members for projects already created.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ActorInputBean" }, "example" : { "user" : [ "admin" ] } } } }, "tags" : [ "Project role actors" ], "parameters" : [ { "name" : "id", "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE" } }, "/api/3/version" : { "post" : { "tags" : [ "Project versions" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "PROJECT_ADMIN", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Version" }, "example" : { "name" : "New Version 1", "description" : "An excellent version", "projectId" : 10000, "archived" : false, "releaseDate" : "2010-07-06T00:00:00.000Z", "released" : true } } }, "required" : true }, "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the project is not found.\n * the user does not have the required permissions." }, "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Version" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"userReleaseDate\":\"6/Jul/2010\",\"project\":\"PXA\",\"projectId\":10000}" } } }, "400" : { "description" : "Returned if the request is invalid." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Creates a project version.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project the version is added to.", "operationId" : "com.atlassian.jira.rest.v2.issue.VersionResource.createVersion_post", "summary" : "Create version" } }, "/api/3/issue/{issueIdOrKey}/attachments" : { "post" : { "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "type" : "string", "format" : "binary" } } } }, "tags" : [ "Issue attachments" ], "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "description" : "The ID or key of the issue that attachments are added to.", "name" : "issueIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "deprecated" : false, "summary" : "Add attachment", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueAttachmentsResource.addAttachment_post", "responses" : { "404" : { "description" : "Returned if any of the following is true:\n\n * the issue is not found.\n * the user does not have permission to view the issue." }, "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://www.example.com/jira/rest/api/3/attachments/10000\",\"id\":\"10001\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2019-09-20T13:24:32.376+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"http://www.example.com/jira/attachments/10000\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10000\"},{\"self\":\"http://www.example.com/jira/rest/api/3/attachments/10001\",\"filename\":\"dbeuglog.txt\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2019-09-20T13:24:32.377+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"http://www.example.com/jira/attachments/10001\",\"thumbnail\":\"http://www.example.com/jira/secure/thumbnail/10002\"}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Attachment" } } } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "413" : { "description" : "The attachments exceed the maximum attachment size for issues. See [Configuring file attachments](https://confluence.atlassian.com/x/wIXKM) for details." } }, "description" : "Adds one or more attachments to an issue. Attachments are posted as multipart/form-data ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)).\n\nNote that:\n\n * The request must have a `X-Atlassian-Token: no-check` header, if not it is blocked. See [Special headers](#special-request-headers) for more information.\n * The name of the multipart/form-data parameter that contains the attachments must be `file`.\n\nThe following example uploads a file called *myfile.txt* to the issue *TEST-123*:\n\n`curl -D- -u admin:admin -X POST -H \"X-Atlassian-Token: no-check\" -F \"file=@myfile.txt\" https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments`\n\nTip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) class for multipart POST operations.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** \n\n * *Browse Projects* and *Create attachments* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ] } }, "/api/3/webhook" : { "post" : { "tags" : [ "Webhooks" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "requestBody" : { "content" : { "application/json" : { "example" : { "webhooks" : [ { "events" : [ "jira:issue_created", "jira:issue_updated" ], "jqlFilter" : "project = PROJ" }, { "events" : [ "jira:issue_deleted" ], "jqlFilter" : "project IN (PROJ, EXP) AND status = done" } ], "url" : "https://your-app.example.com/webhook-received" }, "schema" : { "$ref" : "#/components/schemas/WebhookRegistrationDetails" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"webhookRegistrationResult\":[{\"createdWebhookId\":1000},{\"errors\":[\"The clause watchCount is unsupported\"]},{\"createdWebhookId\":1001}]}", "schema" : { "$ref" : "#/components/schemas/ContainerForRegisteredWebhooks" } } }, "description" : "Returned if the request is successful." }, "403" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the caller is not a Connect app." }, "400" : { "description" : "Returned if the request is invalid.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Registers webhooks.\n\n**[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.", "operationId" : "com.atlassian.jira.rest.v2.webhook.DynamicWebhookResource.registerDynamicWebhooks_post", "summary" : "Register dynamic webhooks" }, "get" : { "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"maxResults\":2,\"startAt\":0,\"total\":100,\"isLast\":false,\"values\":[{\"id\":10000,\"jqlFilter\":\"project = PRJ\",\"events\":[\"jira:issue_updated\",\"jira:issue_created\"],\"expirationDate\":\"2019-06-01T12:42:30.000+0000\"},{\"id\":10001,\"jqlFilter\":\"issuetype = Bug\",\"events\":[\"jira:issue_created\"],\"expirationDate\":\"2019-06-01T12:42:30.000+0000\"}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanWebhook" } } } }, "403" : { "description" : "Returned if the caller is not a Connect app.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } }, "description" : "Returned if the request is invalid." } }, "description" : "Returns the webhooks registered by the calling app.\n\n**[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "summary" : "Get dynamic webhooks for app", "operationId" : "com.atlassian.jira.rest.v2.webhook.DynamicWebhookResource.getDynamicWebhooksForApp_get", "tags" : [ "Webhooks" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "in" : "query", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 }, "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "description" : "The maximum number of items to return per page.", "name" : "maxResults", "schema" : { "default" : 100, "format" : "int32", "type" : "integer" }, "in" : "query" } ] }, "delete" : { "description" : "Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored.\n\n**[Permissions](#permissions) required:** Only [Connect apps](https://developer.atlassian.com/cloud/jira/platform/integrating-with-jira-cloud/#atlassian-connect) can use this operation.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "responses" : { "202" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the caller is not a Connect app.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "400" : { "description" : "Returned if the list of webhook IDs is missing.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } }, "summary" : "Delete webhooks by ID", "operationId" : "com.atlassian.jira.rest.v2.webhook.DynamicWebhookResource.deleteWebhookById_delete", "x-atlassian-connect-scope" : "READ", "parameters" : [], "deprecated" : false, "tags" : [ "Webhooks" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "webhookIds" : [ 10000, 10001, 10042 ] }, "schema" : { "$ref" : "#/components/schemas/ContainerForWebhookIDs" } } } } } }, "/api/3/application-properties/advanced-settings" : { "get" : { "tags" : [ "Jira settings" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "responses" : { "403" : { "description" : "Returned if the user is not an administrator." }, "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ApplicationProperty" }, "type" : "array" }, "example" : "[{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"Jira home directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE -\",\"name\":\"The prefix added to the Summary field of cloned issues\",\"type\":\"string\",\"defaultValue\":\"CLONE -\"}]" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns the application properties that are accessible on the *Advanced Settings* page. To navigate to the *Advanced Settings* page in Jira, choose the Jira icon > **Jira settings** > **System**, **General Configuration** and then click **Advanced Settings** (in the upper right).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource.getAdvancedSettings_get", "summary" : "Get advanced settings" } }, "/api/3/field/{fieldKey}/option/{optionId}" : { "put" : { "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.updateIssueFieldOption_put", "summary" : "Update issue field option", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueFieldOption" }, "example" : "{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}" } }, "description" : "Returned if the option is updated or created." }, "404" : { "description" : "Returned if field is not found." }, "400" : { "description" : "Returned if the option is invalid, or the *ID* in the request object does not match the *optionId* parameter." }, "403" : { "description" : "Returned if the request is not authenticated as a Jira administrator or the app that provided the field." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.", "requestBody" : { "content" : { "application/json" : { "example" : { "properties" : { "description" : "The team's description", "members" : 42, "leader" : { "name" : "Leader Name", "email" : "lname@example.com" }, "founded" : "2016-06-06T00:00:00.000Z" }, "config" : { "scope" : { "projects" : [], "projects2" : [ { "id" : 1002, "attributes" : [ "notSelectable" ] }, { "id" : 1001, "attributes" : [ "notSelectable" ] } ], "global" : {} }, "attributes" : [] }, "id" : 1, "value" : "Team 1" }, "schema" : { "$ref" : "#/components/schemas/IssueFieldOption" } } }, "required" : true }, "tags" : [ "Issue field options" ], "parameters" : [ { "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*.", "name" : "fieldKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "name" : "optionId", "description" : "The ID of the option to be updated.", "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE" }, "delete" : { "x-atlassian-connect-scope" : "NONE", "parameters" : [ { "name" : "fieldKey", "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*.", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true, "name" : "optionId", "description" : "The ID of the option to be deleted." } ], "deprecated" : false, "tags" : [ "Issue field options" ], "summary" : "Delete issue field option", "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.deleteIssueFieldOption_delete", "description" : "Deletes an option from a select list issue field.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "409" : { "description" : "Returned if the option is selected for the field in any issue." }, "403" : { "description" : "Returned if the request is not authenticated as a Jira administrator or the app that provided the field." }, "204" : { "description" : "Returned if the field option is deleted.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "404" : { "description" : "Returned if the field or option is not found." } } }, "get" : { "summary" : "Get issue field option", "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.getIssueFieldOption_get", "responses" : { "403" : { "description" : "Returned if the request is not authenticated as a Jira administrator or the app that provided the field." }, "400" : { "description" : "Returned if the field is not found or does not support options." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueFieldOption" }, "example" : "{\"id\":1,\"value\":\"Team 1\",\"properties\":{\"leader\":{\"name\":\"Leader Name\",\"email\":\"lname@example.com\"},\"members\":42,\"description\":\"The team's description\",\"founded\":\"2016-06-06\"},\"config\":{\"scope\":{\"projects\":[],\"projects2\":[{\"id\":1002,\"attributes\":[\"notSelectable\"]},{\"id\":1001,\"attributes\":[\"notSelectable\"]}],\"global\":{}},\"attributes\":[]}}" } }, "description" : "Returned if the requested option is returned." }, "404" : { "description" : "Returned if the option is not found." } }, "description" : "Returns an option from a select list issue field.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "tags" : [ "Issue field options" ], "x-atlassian-connect-scope" : "NONE", "deprecated" : false, "parameters" : [ { "name" : "fieldKey", "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "optionId", "description" : "The ID of the option to be returned.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ] } }, "/api/3/projectCategory" : { "get" : { "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Project categories" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Returns all project categories.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10001\",\"id\":\"10001\",\"name\":\"SECOND\",\"description\":\"Second Project Category\"}]", "schema" : { "items" : { "$ref" : "#/components/schemas/ProjectCategory" }, "type" : "array" } } } } }, "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectCategoryResource.getAllProjectCategories_get", "summary" : "Get all project categories" }, "post" : { "summary" : "Create project category", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectCategoryResource.createProjectCategory_post", "responses" : { "201" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10100\",\"id\":\"10100\",\"name\":\"CREATED\",\"description\":\"Created Project Category\"}", "schema" : { "$ref" : "#/components/schemas/ProjectCategory" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "409" : { "description" : "Returned if the project category name is in use." }, "403" : { "description" : "Returned if the user does not have the necessary permissions." } }, "description" : "Creates a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] } ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "name" : "CREATED", "description" : "Created Project Category" }, "schema" : { "$ref" : "#/components/schemas/ProjectCategory" } } } }, "tags" : [ "Project categories" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [], "deprecated" : false } }, "/api/3/dashboard/{dashboardId}/items/{itemId}/properties" : { "get" : { "description" : "Returns the keys of all properties for a dashboard item.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The user must be the owner of the dashboard or be shared the dashboard. Note, users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}", "schema" : { "$ref" : "#/components/schemas/PropertyKeys" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the dashboard or dashboard item is not found, or the dashboard is not owned by or shared with the user." } }, "summary" : "Get dashboard item property keys", "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.getDashboardItemPropertyKeys_get", "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "dashboardId", "description" : "The ID of the dashboard.", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "description" : "The ID of the dashboard item.", "name" : "itemId", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false, "tags" : [ "Dashboards" ] } }, "/api/3/issue/{issueIdOrKey}/changelog" : { "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all changelogs for an issue sorted by date, starting from the oldest.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2\",\"maxResults\":2,\"startAt\":2,\"total\":5,\"isLast\":false,\"values\":[{\"id\":\"10001\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:50.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"fieldId\":\"fieldId\",\"from\":null,\"fromString\":\"\",\"to\":null,\"toString\":\"label-1\"}]},{\"id\":\"10002\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"1970-01-18T06:27:51.429+0000\",\"items\":[{\"field\":\"fields\",\"fieldtype\":\"jira\",\"fieldId\":\"fieldId\",\"from\":null,\"fromString\":\"label-1\",\"to\":null,\"toString\":\"label-1 label-2\"}]}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanChangelog" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.IssueChangelogResource.getChangeLogs_get", "summary" : "Get change logs", "deprecated" : false, "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "in" : "query", "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "schema" : { "format" : "int32", "type" : "integer", "default" : 100 }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `100`." } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Issues" ] } }, "/api/3/permissionscheme/{schemeId}/permission" : { "get" : { "tags" : [ "Permission schemes" ], "deprecated" : false, "parameters" : [ { "description" : "The ID of the permission scheme.", "name" : "schemeId", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:\n\n * `permissions` Returns all permission grants for each permission scheme.\n * `user` Returns information about the user who is granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `projectRole` Returns information about the project role granted the permission.\n * `field` Returns information about the custom field granted the permission.\n * `all` Returns all expandable information." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.getPermissionSchemeGrants_get", "summary" : "Get permission scheme grants", "responses" : { "404" : { "description" : "Returned if the user is not permitted to view permission schemes or the permission scheme is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionGrants" }, "example" : "{\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}],\"expand\":\"user,group,projectRole,field,all\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns all permission grants for a permission scheme.\n\n**[Permissions](#permissions) required:** Permission to access Jira." }, "post" : { "security" : [ { "basicAuth" : [] } ], "description" : "Creates a permission grant in a permission scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "400" : { "description" : "Returned if the value for expand is invalid or the same permission grant is present." }, "403" : { "description" : "Returned if the user is not permitted to edit permission schemes." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionGrant" }, "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}" } }, "description" : "Returned if the scheme permission is created." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.createPermissionGrant_post", "summary" : "Create permission grant", "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "name" : "schemeId", "description" : "The ID of the permission scheme in which to create a new permission grant." }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:\n\n * `permissions` Returns all permission grants for each permission scheme.\n * `user` Returns information about the user who is granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `projectRole` Returns information about the project role granted the permission.\n * `field` Returns information about the custom field granted the permission.\n * `all` Returns all expandable information." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Permission schemes" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "holder" : { "type" : "group", "parameter" : "jira-core-users" }, "permission" : "ADMINISTER_PROJECTS" }, "schema" : { "$ref" : "#/components/schemas/PermissionGrant" } } }, "description" : "The permission grant to create." } } }, "/api/3/dashboard/search" : { "get" : { "description" : "Searches for dashboards. This operation is similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** The following dashboards that match the query parameters are returned:\n\n * Dashboards owned by the user. Not returned for anonymous users.\n * Dashboards shared with a group that the user is a member of. Not returned for anonymous users.\n * Dashboards shared with a private project that the user can browse. Not returned for anonymous users.\n * Dashboards shared with a public project.\n * Dashboards shared with the public.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/search?expand=owner&maxResults=50&startAt=0\",\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"description\":\"Testing program\",\"id\":\"1\",\"isFavourite\":true,\"name\":\"Testing\",\"owner\":{\"self\":\"http://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g\",\"displayName\":\"Mia\",\"active\":true,\"accountId\":\"5b10a2844c20165700ede21g\",\"avatarUrls\":{\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\",\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\"}},\"popularity\":1,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/1\",\"sharePermissions\":[{\"type\":\"global\"}],\"view\":\"http://your-domain.atlassian.net/Dashboard.jspa?selectPageId=1\"},{\"description\":\"Quantum initiative\",\"id\":\"2\",\"isFavourite\":false,\"name\":\"Quantum \",\"owner\":{\"self\":\"http://your-domain.atlassian.net/user?accountId=5b10a2844c20165700ede21g\",\"displayName\":\"Mia\",\"active\":true,\"accountId\":\"5b10a2844c20165700ede21g\",\"avatarUrls\":{\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\",\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\"}},\"popularity\":0,\"self\":\"http://your-domain.atlassian.net/rest/api/3/dashboard/2\",\"sharePermissions\":[{\"type\":\"loggedin\"}],\"view\":\"http://your-domain.atlassian.net/Dashboard.jspa?selectPageId=2\"}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanDashboard" } } } }, "400" : { "description" : "Returned if:\n\n * `orderBy` is invalid.\n * `expand` includes an invalid value.\n * `accountId` and `owner` are provided.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } }, "summary" : "Search for dashboards", "operationId" : "com.atlassian.jira.rest.v2.dashboard.DashboardResource.getDashboardsPaginated_get", "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "description" : "String used to perform a case-insensitive partial match with `name`.", "name" : "dashboardName" }, { "description" : "User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot be used with the `owner` parameter.", "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used with the `accountId` parameter.", "name" : "owner" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "groupname", "description" : "Group name used to returns dashboards that are shared with a group that matches `sharePermissions.group.name`." }, { "in" : "query", "schema" : { "format" : "int64", "type" : "integer" }, "description" : "Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.", "name" : "projectId" }, { "schema" : { "type" : "string", "enum" : [ "id", "name", "description", "owner", "favorite_count", "is_favorite", "-id", "-name", "-description", "-owner", "-favorite_count", "-is_favorite" ], "default" : "name" }, "in" : "query", "name" : "orderBy", "description" : "[Orders](#ordering) the results using one of these dashboard properties:\n\n * `id` Orders by dashboard `id`.\n * `name` Orders by dashboard `name`.\n * `description` Orders by dashboard `description`. Note that this sort works independently of whether the expand to display the description field is in use.\n * `owner` Orders by owner `name`.\n * `favourite_count` Orders by `popularity`.\n * `is_favourite` Orders by `isFavourite`." }, { "in" : "query", "schema" : { "format" : "int64", "type" : "integer", "default" : 0 }, "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `100`.", "schema" : { "default" : 50, "format" : "int32", "type" : "integer" }, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about dashboard in the response. This parameter accepts multiple values separated by a comma:\n\n * `description` Returns the description of the dashboard.\n * `owner` Returns the owner of the dashboard.\n * `viewUrl` Returns the URL that is used to view the dashboard.\n * `favourite` Returns `isFavourite`, an indicator of whether the user has set the dashboard as a favorite.\n * `favouritedCount` Returns `popularity`, a count of how many users have set this dashboard as a favorite.\n * `sharePermissions` Returns details of the share permissions defined for the dashboard." } ], "tags" : [ "Dashboards" ] } }, "/api/3/application-properties" : { "get" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "description" : "The key of the application property.", "name" : "key" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "The permission level of all items being returned in the list.", "name" : "permissionLevel" }, { "description" : "When a `key` isn't provided, this filters the list of results by the application property `key` using a regular expression. For example, using `jira.lf.*` will return all application properties with keys that start with *jira.lf.*.", "name" : "keyFilter", "in" : "query", "schema" : { "type" : "string" } } ], "tags" : [ "Jira settings" ], "summary" : "Get application property", "operationId" : "com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource.getApplicationProperty_get", "description" : "Returns all application properties or an application property.\n\nIf you specify a value for the `key` parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See [Set application property](#api-rest-api-3-application-properties-id-put) for descriptions of editable properties.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "404" : { "description" : "Returned if the application property is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "[{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"Jira home directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE -\",\"name\":\"The prefix added to the Summary field of cloned issues\",\"type\":\"string\",\"defaultValue\":\"CLONE -\"}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationProperty" } } } } } } } }, "/api/3/project/{projectIdOrKey}/version" : { "get" : { "tags" : [ "Project versions" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" }, "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset)." }, { "schema" : { "default" : 50, "format" : "int32", "type" : "integer" }, "in" : "query", "name" : "maxResults", "description" : "The maximum number of items to return per page. The maximum is `50`." }, { "description" : "[Order](#ordering) the results by a field:\n\n * `description` Sorts versions in alphabetical order by description.\n * `name` Sorts versions in alphabetical order by version name.\n * `releaseDate` Sorts versions in order by release date, starting with the oldest date. Versions with no release date are listed last.\n * `sequence` Sorts versions by the order of appearance in the user interface.\n * `startDate` Sorts versions in order by start date, starting with the oldest date. Versions with no start date are listed last.", "name" : "orderBy", "in" : "query", "schema" : { "enum" : [ "description", "-description", "+description", "name", "-name", "+name", "releaseDate", "-releaseDate", "+releaseDate", "sequence", "-sequence", "+sequence", "startDate", "-startDate", "+startDate" ], "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "Filter the results using a literal string. Versions with matching `name` or `description` are returned (case insensitive).", "name" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "status", "description" : "A comma-separated list of status values used to filter the results by version status. The status values are `released`, `unreleased`, and `archived`." }, { "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `issuesstatus` Returns the number of issues in each status category for each version.\n * `operations` Returns actions that can be performed on the specified version.", "name" : "expand", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "summary" : "Get project versions paginated", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getProjectVersionsPaginated_get", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanVersion" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10000\",\"id\":\"10000\",\"description\":\"An excellent version\",\"name\":\"New Version 1\",\"archived\":false,\"released\":true,\"releaseDate\":\"2010-07-06\",\"overdue\":true,\"userReleaseDate\":\"6/Jul/2010\",\"projectId\":10000},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/version/10010\",\"id\":\"10010\",\"description\":\"Minor Bugfix version\",\"name\":\"Next Version\",\"archived\":false,\"released\":false,\"overdue\":false,\"projectId\":10000,\"issuesStatusForFixVersion\":{\"unmapped\":0,\"toDo\":10,\"inProgress\":20,\"done\":100}}]}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." } }, "description" : "Returns a [paginated](#pagination) representation of all versions in a project. See the [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get) resource if you want to get a full list of versions without pagination.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ] } }, "/api/3/screens" : { "get" : { "parameters" : [ { "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" }, "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "description" : "The maximum number of items to return per page. The maximum is `100`.", "name" : "maxResults", "schema" : { "default" : 100, "format" : "int32", "type" : "integer" }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "ADMIN", "tags" : [ "Screens" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Returns all screens.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageBeanScreen" } } } } }, "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.getAllScreens_get", "summary" : "Get all screens" } }, "/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move" : { "post" : { "tags" : [ "Screens" ], "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true, "name" : "screenId", "description" : "The ID of the screen." }, { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the screen tab.", "name" : "tabId" }, { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "id", "description" : "The ID of the field." } ], "deprecated" : false, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MoveFieldBean" } } } }, "responses" : { "404" : { "description" : "Returned if the screen, screen tab, or field is not found or the field can't be moved to the requested position." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the request is invalid." } }, "description" : "Moves a screen tab field.\n\nIf `after` and `position` are provided in the request, `position` is ignored.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "summary" : "Move screen tab field", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.moveScreenTabField_post" } }, "/api/3/issuetype/{id}" : { "put" : { "tags" : [ "Issue types" ], "parameters" : [ { "description" : "The ID of the issue type.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "ADMIN", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypeUpdateBean" }, "example" : { "description" : "description", "name" : "name", "avatarId" : 1 } } }, "required" : true }, "responses" : { "400" : { "description" : "Returned if the request is invalid because:\n\n * no content is sent.\n * the issue type name exceeds 60 characters.\n * the avatar is not associated with this issue type." }, "409" : { "description" : "Returned if the issue type name is in use." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypeBean" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue type is not found." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Updates the issue type.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.updateIssueType_put", "summary" : "Update issue type" }, "get" : { "tags" : [ "Issue types" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "description" : "The ID of the issue type.", "name" : "id", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "deprecated" : false, "responses" : { "400" : { "description" : "Returned if the issue type ID is invalid." }, "404" : { "description" : "Returned if:\n\n * the issue type is not found.\n * the user does not have the required permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1}", "schema" : { "$ref" : "#/components/schemas/IssueTypeBean" } } }, "description" : "Returned if the request is successful." } }, "description" : "Returns an issue type.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) in a project the issue type is associated with or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get issue type", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.getIssueType_get" }, "delete" : { "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the issue type.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "alternativeIssueTypeId", "description" : "The ID of the replacement issue type.", "in" : "query", "schema" : { "type" : "string" } } ], "x-atlassian-connect-scope" : "ADMIN", "tags" : [ "Issue types" ], "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.deleteIssueType_delete", "summary" : "Delete issue type", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (`alternativeIssueTypeId`). A list of alternative issue types are obtained from the [Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) resource.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the issue type is in use and an alternative issue type is not specified.\n * the issue type or alternative issue type is not found." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "409" : { "description" : "Returned if the issue type is in use and:\n\n * also specified as the alternative issue type.\n * is a *standard* issue type and the alternative issue type is a *subtask*." }, "400" : { "description" : "Returned if any issues cannot be updated with the alternative issue type." } } } }, "/api/3/issue/{issueIdOrKey}/assignee" : { "put" : { "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" }, "example" : { "accountId" : "5b10ac8d82e05b22cc7d4ef5" } } }, "description" : "The request object with the user that the issue is assigned to.", "required" : true }, "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "issueIdOrKey", "description" : "The ID or key of the issue to be assigned." } ], "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Issues" ], "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.assignIssue_put", "summary" : "Assign issue", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Assigns an issue to a user. Use this operation when the calling user does not have the *Edit Issues* permission but has the *Assign issue* permission for the project that the issue is in.\n\nIf `name` or `accountId` is set to:\n\n * `\"-1\"`, the issue is assigned to the default assignee for the project.\n * `null`, the issue is set to unassigned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse Projects* and *Assign Issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "responses" : { "404" : { "description" : "Returned if the issue is not found." }, "400" : { "description" : "Returned if:\n\n * the user is not found.\n * `name`, `key`, or `accountId` is missing.\n * more than one of `name`, `key`, and `accountId` are provided." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." } } } }, "/api/3/project/{projectIdOrKey}/components" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getProjectComponents_get", "summary" : "Get project components", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Component" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000}]" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "tags" : [ "Project components" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive)." } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/worklog/updated" : { "get" : { "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "since", "description" : "The date and time, in UNIX timestamp format, after which updated worklogs are returned.", "in" : "query", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "schema" : { "type" : "string", "default" : "" }, "in" : "query", "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog." } ], "deprecated" : false, "tags" : [ "Issue worklogs" ], "summary" : "Get IDs of updated worklogs", "operationId" : "com.atlassian.jira.rest.v2.issue.worklog.WorklogResource.getIdsOfWorklogsModifiedSince_get", "description" : "Returns a list of IDs and update timestamps for worklogs updated after a date and time.\n\nThis resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs.\n\nThis resource does not return worklogs updated during the minute preceding the request.\n\n**[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:\n\n * the worklog is set as *Viewable by All Users*.\n * the user is a member of a project role or group with permission to view the worklog.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"values\":[{\"worklogId\":103,\"updatedTime\":1438013671562,\"properties\":[]},{\"worklogId\":104,\"updatedTime\":1438013672165,\"properties\":[]},{\"worklogId\":105,\"updatedTime\":1438013693136,\"properties\":[]}],\"since\":1438013671562,\"until\":1438013693136,\"self\":\"http://your-domain.atlassian.net/worklog/updated?since=1438013671562\",\"nextPage\":\"http://your-domain.atlassian.net/worklog/updated?since=1438013693136\",\"lastPage\":true}", "schema" : { "$ref" : "#/components/schemas/ChangedWorklogs" } } }, "description" : "Returned if the request is successful." } } } }, "/api/3/projectvalidate/validProjectName" : { "get" : { "deprecated" : false, "parameters" : [ { "name" : "name", "description" : "The project name.", "schema" : { "type" : "string" }, "in" : "query", "required" : true } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Project key and name validation" ], "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectValidateResource.getValidProjectName_get", "summary" : "Get valid project name", "security" : [ { "basicAuth" : [] } ], "description" : "Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "string" }, "example" : "\"Valid Project Name Example\"" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "404" : { "description" : "Returned if a valid project name cannot be generated." }, "400" : { "description" : "Returned if the request is invalid." } } } }, "/api/3/project/type/{projectTypeKey}" : { "get" : { "tags" : [ "Project types" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "enum" : [ "software", "service_desk", "business" ], "type" : "string" }, "name" : "projectTypeKey", "description" : "The key of the project type." } ], "responses" : { "404" : { "description" : "Returned if the project type is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectType" }, "example" : "{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"}" } }, "description" : "Returned if the request is successful." } }, "description" : "Returns a [project type](https://confluence.atlassian.com/x/Var1Nw).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get project type by key", "operationId" : "com.atlassian.jira.rest.v2.project.type.ProjectTypeResource.getProjectTypeByKey_get" } }, "/api/3/attachment/{id}/expand/human" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.expandAttachmentForHumans_get", "summary" : "Get all metadata for an expanded attachment", "responses" : { "404" : { "description" : "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentArchiveMetadataReadable" }, "example" : "{\"id\":7237823,\"name\":\"images.zip\",\"entries\":[{\"path\":\"MG00N067.JPG\",\"index\":0,\"size\":\"119 kB\",\"mediaType\":\"image/jpeg\",\"label\":\"MG00N067.JPG\"},{\"path\":\"Allegro from Duet in C Major.mp3\",\"index\":1,\"size\":\"1.36 MB\",\"mediaType\":\"audio/mpeg\",\"label\":\"Allegro from Duet in C 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 k\",\"mediaType\":\"text/plain\",\"label\":\"long/path/thanks/to/.../reach/the/leaf.txt\"}],\"totalEntryCount\":39,\"mediaType\":\"application/zip\"}" } } }, "409" : { "description" : "Returned if the attachment is an archive, but not a supported archive format." }, "403" : { "description" : "The user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported.\n\nUse this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use [ Get contents metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-raw-get), which only returns the metadata for the attachment's contents.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "x-experimental" : true, "tags" : [ "Issue attachments" ], "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the attachment.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "x-atlassian-connect-scope" : "READ" } }, "/api/3/permissions" : { "get" : { "tags" : [ "Permissions" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.permission.PermissionsResource.getAllPermissions_get", "summary" : "Get all permissions", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Permissions" }, "example" : "{\"permissions\":{\"BULK_CHANGE\":{\"key\":\"BULK_CHANGE\",\"name\":\"Bulk Change\",\"type\":\"GLOBAL\",\"description\":\"Ability to modify a collection of issues at once. For example, resolve multiple issues in one step.\"}}}" } } }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns all permissions, including:\n\n * global permissions.\n * project permissions.\n * global permissions added by plugins.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } }, "/api/3/project/type" : { "get" : { "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "Project types" ], "operationId" : "com.atlassian.jira.rest.v2.project.type.ProjectTypeResource.getAllProjectTypes_get", "summary" : "Get all project types", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns all [project types](https://confluence.atlassian.com/x/Var1Nw), whether or not the instance has a valid license for each type.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectType" } }, "example" : "[{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"jira.project.type.software.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } } } }, "/api/3/permissionscheme/{schemeId}" : { "put" : { "security" : [ { "basicAuth" : [] } ], "description" : "Updates a permission scheme. Below are some important things to note when using this resource:\n\n * If a permissions list is present in the request, then it is set in the permission scheme, overwriting *all existing* grants.\n * If you want to update only the name and description, then do not send a permissions list in the request.\n * Sending an empty list will remove all permission grants from the permission scheme.\n\nIf you want to add or delete a permission grant instead of updating the whole list, see [Create permission grant](#api-rest-api-3-permissionscheme-schemeId-permission-post) or [Delete permission scheme entity](#api-rest-api-3-permissionscheme-schemeId-permission-permissionId-delete).\n\nSee [About permission schemes and grants](#about-permission-schemes) for more details.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if:\n\n * the user is not permitted to update permission schemes.\n * the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be updated on Free plans." }, "404" : { "description" : "Returned if the permission scheme is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionScheme" }, "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}" } }, "description" : "Returned if the scheme is updated." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.updatePermissionScheme_put", "summary" : "Update permission scheme", "parameters" : [ { "name" : "schemeId", "description" : "The ID of the permission scheme to update.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true }, { "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission.", "name" : "expand", "in" : "query", "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Permission schemes" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "permissions" : [ { "holder" : { "type" : "group", "parameter" : "jira-core-users" }, "permission" : "ADMINISTER_PROJECTS" } ], "name" : "Example permission scheme", "description" : "description" }, "schema" : { "$ref" : "#/components/schemas/PermissionScheme" } } } } }, "get" : { "tags" : [ "Permission schemes" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the permission scheme to return.", "name" : "schemeId" }, { "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission.", "name" : "expand", "schema" : { "type" : "string" }, "in" : "query" } ], "summary" : "Get permission scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.getPermissionScheme_get", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionScheme" }, "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/10000\",\"name\":\"Example permission scheme\",\"description\":\"description\",\"permissions\":[{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}]}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the user is not permitted to view permission schemes or if the permission scheme is not found." } }, "description" : "Returns a permission scheme.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] } ] }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.deletePermissionScheme_delete", "summary" : "Delete permission scheme", "responses" : { "204" : { "description" : "Returned if the permission scheme is deleted." }, "403" : { "description" : "Returned if the user is not permitted to delete permission schemes." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the permission scheme is not found." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Deletes a permission scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "tags" : [ "Permission schemes" ], "deprecated" : false, "parameters" : [ { "description" : "The ID of the permission scheme being deleted.", "name" : "schemeId", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "INACCESSIBLE" } }, "/api/3/customFieldOption/{id}" : { "get" : { "tags" : [ "Issue fields" ], "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the custom field option. To find this ID, [ configure the custom field](https://confluence.atlassian.com/x/B4hKLg) and edit its options in Jira. Click the option and its ID will show in the URL as the `selectedParentOptionId` parameter.", "name" : "id" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomFieldOption" }, "example" : "{\"self\":\"https://your-domain.atlassian.net/rest/api/3/customFieldOption/10000\",\"value\":\"To Do\"}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the custom field option is not found.\n * the user does not have permission to view the custom field." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a custom field option. For example, an option in a cascading select list.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "operationId" : "com.atlassian.jira.rest.v2.issue.customfield.CustomFieldOptionResource.getCustomFieldOption_get", "summary" : "Get custom field option" } }, "/api/3/project/{projectIdOrKey}/statuses" : { "get" : { "tags" : [ "Projects" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "description" : "The project ID or project key (case sensitive).", "name" : "projectIdOrKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "deprecated" : false, "responses" : { "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "[{\"self\":\"http://localhost:8090/jira/rest/api/3/issueType/3\",\"id\":\"3\",\"name\":\"Task\",\"subtask\":false,\"statuses\":[{\"self\":\"http://localhost:8090/jira/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\"},{\"self\":\"http://localhost:8090/jira/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://localhost:8090/jira/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\"}]}]", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IssueTypeWithStatus" } } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get all statuses for project", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getAllStatuses_get" } }, "/api/3/issue/createmeta" : { "get" : { "tags" : [ "Issues" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "array", "items" : { "type" : "string" } }, "in" : "query", "description" : "Comma-separated list of project IDs. This parameter may be specified multiple times. For example, `projectIds=10000,10001&projectIds=10020,10021`. This parameter may be provided with `projectKeys`.", "name" : "projectIds" }, { "description" : "Comma-separated list of project keys. This parameter may be specified multiple times. For example, `projectKeys=proj1,proj2&projectKeys=proj3`. This parameter may be provided with `projectIds`.", "name" : "projectKeys", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "in" : "query" }, { "description" : "Comma-separated list of issue type IDs. This parameter may be specified multiple times. For example, `issuetypeIds=10000,10001&issuetypeIds=10020,10021`. This parameter may be provided with `issuetypeNames`.", "name" : "issuetypeIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "in" : "query", "description" : "Comma-separated list of issue type names. This parameter may be specified multiple times. For example, `issuetypeNames=name1,name2&issuetypeNames=name3`. This parameter may be provided with `issuetypeIds`.", "name" : "issuetypeNames" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about issue metadata in the response. This parameter accepts `projects.issuetypes.fields` which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the `fields` and `update` fields in [Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post)." } ], "x-atlassian-connect-scope" : "READ", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getCreateIssueMeta_get", "summary" : "Get create issue metadata", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"projects\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/ED\",\"id\":\"10000\",\"key\":\"ED\",\"name\":\"Edison Project\",\"avatarUrls\":{\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011\",\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011\"},\"issuetypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"An error in the code\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/issuetypes/bug.png\",\"name\":\"Bug\",\"subtask\":false,\"fields\":{\"issuetype\":{\"required\":true,\"name\":\"Issue Type\",\"key\":\"issuetype\",\"hasDefaultValue\":false,\"operations\":[\"set\"]}}}]}]}", "schema" : { "$ref" : "#/components/schemas/IssueCreateMetadata" } } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post).\n\nThe request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Create issues* [project permission](https://confluence.atlassian.com/x/yodKLg) in the requested projects." } }, "/api/3/user/groups" : { "get" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "description" : "Returns the groups to which a user belongs.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "403" : { "description" : "Returned if the calling user does not have the *Browse users and groups* global permission." }, "404" : { "description" : "Returned if:\n\n * `accountId` is missing.\n * the user is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupName" } }, "example" : "{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.getUserGroups_get", "summary" : "Get user groups", "deprecated" : false, "parameters" : [ { "x-showInExample" : "true", "name" : "accountId", "description" : "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required.", "in" : "query", "required" : true, "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" } }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "schema" : { "type" : "string" }, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "key", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details." } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Users" ] } }, "/api/3/comment/{commentId}/properties" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.getCommentPropertyKeys_get", "summary" : "Get comment property keys", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PropertyKeys" }, "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the comment is not found." }, "400" : { "description" : "Returned if the comment ID is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the keys of all the properties of a comment.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "tags" : [ "Issue comment properties" ], "parameters" : [ { "name" : "commentId", "description" : "The ID of the comment.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ" } }, "/api/3/configuration/timetracking/options" : { "put" : { "summary" : "Set time tracking settings", "operationId" : "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.setSharedTimeTrackingConfiguration_put", "description" : "Sets the time tracking settings.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"workingHoursPerDay\":7.6,\"workingDaysPerWeek\":5.5,\"timeFormat\":\"pretty\",\"defaultUnit\":\"hour\"}", "schema" : { "$ref" : "#/components/schemas/TimeTrackingConfiguration" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have the required permissions." }, "400" : { "description" : "Returned if the request object is invalid." } }, "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TimeTrackingConfiguration" }, "example" : { "workingDaysPerWeek" : 5.5, "timeFormat" : "pretty", "workingHoursPerDay" : 7.6, "defaultUnit" : "hour" } } } }, "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [], "tags" : [ "Time tracking" ] }, "get" : { "summary" : "Get time tracking settings", "operationId" : "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.getSharedTimeTrackingConfiguration_get", "description" : "Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TimeTrackingConfiguration" }, "example" : "{\"workingHoursPerDay\":7.6,\"workingDaysPerWeek\":5.5,\"timeFormat\":\"pretty\",\"defaultUnit\":\"hour\"}" } }, "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "x-atlassian-connect-scope" : "READ", "parameters" : [], "deprecated" : false, "tags" : [ "Time tracking" ] } }, "/api/3/project/{projectIdOrKey}/avatar" : { "put" : { "summary" : "Set project avatar", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.updateProjectAvatar_put", "responses" : { "403" : { "description" : "Returned if the user does not have permission to administer the project." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the project or avatar is not found or the user does not have permission to view the project." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "description" : "Sets the avatar displayed for a project.\n\nUse [Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post) to store avatars against the project, before using this operation to set the displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Avatar" }, "example" : { "id" : "10010" } } }, "required" : true }, "tags" : [ "Project avatars" ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "projectIdOrKey", "description" : "The ID or (case-sensitive) key of the project." } ] } }, "/api/3/role" : { "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.createProjectRole_post", "summary" : "Create project role", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\"}", "schema" : { "$ref" : "#/components/schemas/ProjectRole" } } } }, "400" : { "description" : "Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace." }, "409" : { "description" : "Returned if a project role with the provided name already exists." }, "403" : { "description" : "Returned if the user does not have administrative permissions." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Creates a new project role with no [default actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to project role](#api-rest-api-3-role-id-actors-post) operation to add default actors to the project role after creating it.\n\n*Note that although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created.*<\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateUpdateRoleRequestBean" }, "example" : { "description" : "A project role that represents developers in a project", "name" : "Developers" } } } }, "tags" : [ "Project roles" ], "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE" }, "get" : { "description" : "Gets a list of all project roles, complete with project role details and default actors.\n\n### About project roles ###\n\n[Project roles](https://confluence.atlassian.com/x/3odKLg) are a flexible way to to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications).\n\nProject roles are used in [permission schemes](#api-rest-api-3-permissionscheme-get), [email notification schemes](#api-rest-api-3-notificationscheme-get), [issue security levels](#api-rest-api-3-issuesecurityschemes-get), [comment visibility](#api-rest-api-3-comment-list-post), and workflow conditions.\n\n#### Members and actors ####\n\nIn the Jira REST API, a member of a project role is called an *actor*. An *actor* is a group or user associated with a project role.\n\nActors may be set as [default members](https://confluence.atlassian.com/x/3odKLg#Managingprojectroles-Specifying'defaultmembers'foraprojectrole) of the project role or set at the project level:\n\n * Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.\n * Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "403" : { "description" : "Returned if the user does not have administrative permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectRole" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]" } } } }, "summary" : "Get all project roles", "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.getAllProjectRoles_get", "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [], "tags" : [ "Project roles" ] } }, "/api/3/issue" : { "post" : { "responses" : { "403" : { "description" : "Returned if the user is not permitted to access the application.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } }, "400" : { "description" : "Returned if the request:\n\n * is missing required fields.\n * contains invalid field values.\n * contains fields that cannot be set for the issue type.\n * is by a user who does not have the necessary permissions.\n * is to create a subtype in a project different that of the the parent issue.\n * is for a subtask when the option to create subtasks is disabled.\n * is invalid for any other reason.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" }, "example" : "{\"errorMessages\":[\"Field 'priority' is required\"],\"errors\":{}}" } } }, "201" : { "content" : { "application/json" : { "example" : "{\"id\":\"10000\",\"key\":\"ED-24\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10000\",\"transition\":{\"status\":200,\"errorCollection\":{\"errorMessages\":[],\"errors\":{}}}}", "schema" : { "$ref" : "#/components/schemas/CreatedIssue" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorCollection" } } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.\n\nThe content of the issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issue's create screen. Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.\n\nCreating a subtask differs from creating an issue as follows:\n\n * `issueType` must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).\n * `parent` MUST contain the ID or key of the parent issue.\n\nA parent MAY be supplied for any issue provided both parent and child are members of the same next-gen project. In a classic project the parent field is only valid for subtasks.\n\n**[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue or subtask is created.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.createIssue_post", "summary" : "Create issue", "tags" : [ "Issues" ], "parameters" : [ { "in" : "query", "schema" : { "type" : "boolean", "default" : false }, "description" : "Indicates whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira.", "name" : "updateHistory" } ], "deprecated" : false, "x-atlassian-connect-scope" : "WRITE", "requestBody" : { "content" : { "application/json" : { "example" : { "update" : {}, "fields" : { "labels" : [ "bugfix", "blitz_test" ], "customfield_50000" : { "type" : "doc", "content" : [ { "content" : [ { "type" : "text", "text" : "Could impact day-to-day work." } ], "type" : "paragraph" } ], "version" : 1 }, "environment" : { "type" : "doc", "content" : [ { "content" : [ { "type" : "text", "text" : "UAT" } ], "type" : "paragraph" } ], "version" : 1 }, "customfield_40000" : { "version" : 1, "content" : [ { "content" : [ { "text" : "Occurs on all orders", "type" : "text" } ], "type" : "paragraph" } ], "type" : "doc" }, "versions" : [ { "id" : "10000" } ], "reporter" : { "id" : "5b10a2844c20165700ede21g" }, "assignee" : { "id" : "5b109f2e9729b51b54dc274d" }, "duedate" : "2019-05-11T00:00:00.000Z", "customfield_80000" : { "value" : "red" }, "customfield_30000" : [ "10000", "10002" ], "customfield_60000" : "jira-software-users", "customfield_10000" : "09/Jun/19", "security" : { "id" : "10000" }, "description" : { "type" : "doc", "content" : [ { "type" : "paragraph", "content" : [ { "text" : "Order entry fails when selecting supplier.", "type" : "text" } ] } ], "version" : 1 }, "issuetype" : { "id" : "10000" }, "timetracking" : { "remainingEstimate" : "5", "originalEstimate" : "10" }, "summary" : "Main order flow broken", "customfield_70000" : [ "jira-administrators", "jira-software-users" ], "components" : [ { "id" : "10000" } ], "priority" : { "id" : "20000" }, "customfield_20000" : "06/Jul/19 3:25 PM", "project" : { "id" : "10000" }, "fixVersions" : [ { "id" : "10001" } ] } }, "schema" : { "$ref" : "#/components/schemas/IssueUpdateDetails" } } }, "required" : true } } }, "/api/3/issue/picker" : { "get" : { "description" : "Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.\n\nThis operation returns two lists:\n\n * `History Search` which includes issues from the user's history of created, edited, or viewed issues that contain the string in the `query` parameter.\n * `Current Search` which includes issues that match the JQL expression in `currentJQL` and contain the string in the `query` parameter.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssuePickerSuggestions" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "summary" : "Get issue picker suggestions", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getIssuePickerResource_get", "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "query", "description" : "A string to match against text fields in the issue such as title, description, or comments.", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "query" }, "in" : "query" }, { "name" : "currentJQL", "description" : "A JQL query defining a list of issues to search for the query term. Note that `username` and `userkey` cannot be used as search terms for this parameter, due to privacy reasons. Use `accountId` instead.", "schema" : { "type" : "string" }, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.", "name" : "currentIssueKey" }, { "name" : "currentProjectId", "description" : "The ID of a project that suggested issues must belong to.", "in" : "query", "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "type" : "boolean" }, "description" : "Indicate whether to include subtasks in the suggestions list.", "name" : "showSubTasks" }, { "name" : "showSubTaskParent", "description" : "When `currentIssueKey` is a subtask, indicates whether to include the parent issue in the suggestions if it matches the query.", "schema" : { "type" : "boolean" }, "in" : "query" } ], "tags" : [ "Issue search" ] } }, "/api/3/project/{projectIdOrKey}/avatar2" : { "post" : { "description" : "Loads an avatar for a project.\n\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:\n\n * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).\n * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.\n\nFor example: \n`curl --request POST `\n\n`--user email@example.com: `\n\n`--header 'X-Atlassian-Token: no-check' `\n\n`--header 'Content-Type: image/< image_type>' `\n\n`--data-binary \"<@/path/to/file/with/your/avatar>\" `\n\n`--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'`\n\nThe avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.\n\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.\n\nAfter creating the avatar use [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project's displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project is not found or the user does not have permission to view the project." }, "201" : { "content" : { "application/json" : { "example" : "{\"id\":\"1010\",\"isSystemAvatar\":false,\"isSelected\":false,\"isDeletable\":true}", "schema" : { "$ref" : "#/components/schemas/Avatar" } } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if:\n\n * an image isn't included in the request.\n * the image type is unsupported.\n * the crop parameters extend the crop area beyond the edge of the image." }, "403" : { "description" : "Returned if the user does not have permission to administer the project or an anonymous call is made to the operation." } }, "summary" : "Load project avatar", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.createProjectAvatar_post", "x-atlassian-connect-scope" : "PROJECT_ADMIN", "parameters" : [ { "description" : "The ID or (case-sensitive) key of the project.", "name" : "projectIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "in" : "query", "schema" : { "format" : "int32", "type" : "integer", "default" : 0 }, "description" : "The X coordinate of the top-left corner of the crop region.", "name" : "x" }, { "in" : "query", "schema" : { "default" : 0, "format" : "int32", "type" : "integer" }, "description" : "The Y coordinate of the top-left corner of the crop region.", "name" : "y" }, { "in" : "query", "schema" : { "format" : "int32", "type" : "integer" }, "name" : "size", "description" : "The length of each side of the crop region." } ], "deprecated" : false, "tags" : [ "Project avatars" ], "requestBody" : { "content" : { "*/*" : { "schema" : {} } }, "required" : true } } }, "/api/3/notificationscheme" : { "get" : { "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "schema" : { "default" : 0, "type" : "integer", "format" : "int64" }, "in" : "query", "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt" }, { "schema" : { "default" : 50, "type" : "integer", "format" : "int32" }, "in" : "query", "description" : "The maximum number of items to return per page. The maximum is `50`.", "name" : "maxResults" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `all` Returns all expandable information.\n * `field` Returns information about any custom fields assigned to receive an event.\n * `group` Returns information about any groups assigned to receive an event.\n * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information.\n * `projectRole` Returns information about any project roles assigned to receive an event.\n * `user` Returns information about any users assigned to receive an event." } ], "tags" : [ "Issue notification schemes" ], "summary" : "Get notification schemes paginated", "operationId" : "com.atlassian.jira.rest.v2.notification.NotificationSchemeResource.getNotificationSchemes_get", "description" : "Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.\n\n### About notification schemes ###\n\nA notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the `notificationSchemeEvents` object and contains pairs of `events` and `notifications`:\n\n * `event` Identifies the type of event. The events can be [Jira system events](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or [custom events](https://confluence.atlassian.com/x/AIlKLg).\n * `notifications` Identifies the [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients) of notifications for each event. Recipients can be any of the following types:\n \n * `CurrentAssignee`\n * `Reporter`\n * `CurrentUser`\n * `ProjectLead`\n * `ComponentLead`\n * `User` (the `parameter` is the user key)\n * `Group` (the `parameter` is the group name)\n * `ProjectRole` (the `parameter` is the project role ID)\n * `EmailAddress`\n * `AllWatchers`\n * `UserCustomField` (the `parameter` is the ID of the custom field)\n * `GroupCustomField`(the `parameter` is the ID of the custom field)\n\n*Note that you should allow for events without recipients to appear in responses.*\n\n**[Permissions](#permissions) required:** Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "200" : { "description" : "Returned if the request is successful. Only returns notification schemes that the user has permission to access. An empty list is returned if the user lacks permission to access all notification schemes.", "content" : { "application/json" : { "example" : "{\"maxResults\":6,\"startAt\":1,\"total\":5,\"isLast\":false,\"values\":[{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://your-domain.atlassian.net/rest/api/3/notificationscheme\",\"name\":\"notification scheme name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom event\",\"description\":\"Custom event that is published together with an issue created event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanNotificationScheme" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } } } }, "/api/3/group" : { "post" : { "responses" : { "201" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"name\":\"power-users\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=power-users\",\"users\":{\"size\":1,\"items\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}],\"max-results\":50,\"start-index\":0,\"end-index\":0},\"expand\":\"users\"}", "schema" : { "$ref" : "#/components/schemas/Group" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user does not have the necessary permission." }, "400" : { "description" : "Returned if group name is not specified or the group name is in use." } }, "description" : "Creates a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "summary" : "Create group", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupResource.createGroup_post", "tags" : [ "Groups" ], "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [], "deprecated" : false, "requestBody" : { "description" : "The name of the group.", "content" : { "application/json" : { "example" : { "name" : "power-users" }, "schema" : { "$ref" : "#/components/schemas/AddGroupBean" } } }, "required" : true } }, "get" : { "summary" : "Get group", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupResource.getGroup_get", "description" : "This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get).\n\nReturns all users in a group.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "responses" : { "400" : { "description" : "Returned if the group name is not specified." }, "403" : { "description" : "Returned if the calling user does not have the Administer Jira global permission." }, "404" : { "description" : "Returned if the group is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "name" : "groupname", "description" : "The name of the group.", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "expand", "description" : "List of fields to expand.", "schema" : { "type" : "string" }, "in" : "query" } ], "deprecated" : true, "tags" : [ "Groups" ] }, "delete" : { "description" : "Deletes a group.\n\n**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjL)).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "responses" : { "404" : { "description" : "Returned if the group is not found." }, "200" : { "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing from the request." }, "400" : { "description" : "Returned if the group name is not specified." }, "403" : { "description" : "Returned if the user does not have the necessary permission." } }, "summary" : "Remove group", "operationId" : "com.atlassian.jira.rest.v2.issue.GroupResource.removeGroup_delete", "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The name of the group.", "name" : "groupname", "schema" : { "type" : "string" }, "required" : true, "in" : "query" }, { "schema" : { "type" : "string" }, "in" : "query", "name" : "swapGroup", "description" : "The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion." } ], "tags" : [ "Groups" ] } }, "/api/3/project/type/{projectTypeKey}/accessible" : { "get" : { "tags" : [ "Project types" ], "deprecated" : false, "parameters" : [ { "name" : "projectTypeKey", "description" : "The key of the project type.", "in" : "path", "required" : true, "schema" : { "type" : "string", "enum" : [ "software", "service_desk", "business" ] } } ], "x-atlassian-connect-scope" : "READ", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"}", "schema" : { "$ref" : "#/components/schemas/ProjectType" } } } }, "404" : { "description" : "Returned if the project type is not accessible to the user." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a [project type](https://confluence.atlassian.com/x/Var1Nw) if it is accessible to the user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "operationId" : "com.atlassian.jira.rest.v2.project.type.ProjectTypeResource.getAccessibleProjectTypeByKey_get", "summary" : "Get accessible project type by key" } }, "/api/3/project/{projectKeyOrId}/notificationscheme" : { "get" : { "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "projectKeyOrId", "description" : "The project ID or project key (case sensitive)." }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "Use [expand](#expansion) to include additional information in the response. This parameter accepts multiple values separated by a comma:\n\n * `all` Returns all expandable information.\n * `field` Returns information about any custom fields assigned to receive an event.\n * `group` Returns information about any groups assigned to receive an event.\n * `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable information.\n * `projectRole` Returns information about any project roles assigned to receive an event.\n * `user` Returns information about any users assigned to receive an event.", "name" : "expand" } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Projects" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] } ], "description" : "Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. See the [Get notification scheme](#api-rest-api-3-notificationscheme-id-get) resource for more information about notification schemes.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).", "responses" : { "404" : { "description" : "Returned if the project is not found or the user is not an administrator." }, "200" : { "content" : { "application/json" : { "example" : "{\"expand\":\"notificationSchemeEvents,user,group,projectRole,field,all\",\"id\":10100,\"self\":\"http://your-domain.atlassian.net/rest/api/3/notificationscheme\",\"name\":\"notification scheme name\",\"description\":\"description\",\"notificationSchemeEvents\":[{\"event\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]},{\"event\":{\"id\":20,\"name\":\"Custom event\",\"description\":\"Custom event that is published together with an issue created event\",\"templateEvent\":{\"id\":1,\"name\":\"Issue created\",\"description\":\"Event published when an issue is created\"}},\"notifications\":[{\"id\":1,\"notificationType\":\"Group\",\"parameter\":\"jira-administrators\",\"group\":{\"name\":\"jira-administrators\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/group?groupname=jira-administrators\"},\"expand\":\"group\"},{\"id\":2,\"notificationType\":\"CurrentAssignee\"},{\"id\":3,\"notificationType\":\"ProjectRole\",\"parameter\":\"10360\",\"projectRole\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},\"expand\":\"projectRole\"},{\"id\":4,\"notificationType\":\"EmailAddress\",\"parameter\":\"rest-developer@atlassian.com\",\"emailAddress\":\"rest-developer@atlassian.com\"},{\"id\":5,\"notificationType\":\"User\",\"user\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"expand\":\"user\"},{\"id\":6,\"notificationType\":\"GroupCustomField\",\"parameter\":\"customfield_10101\",\"field\":{\"id\":\"customfield_10101\",\"key\":\"customfield_10101\",\"name\":\"New custom field\",\"custom\":true,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"cf[10101]\",\"New custom field\"],\"schema\":{\"type\":\"project\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:project\",\"customId\":10101}},\"expand\":\"field\"}]}]}", "schema" : { "$ref" : "#/components/schemas/NotificationScheme" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the request is not valid." } }, "operationId" : "com.atlassian.jira.rest.v2.notification.ProjectNotificationSchemeResource.getNotificationScheme_get", "summary" : "Get project notification scheme" } }, "/api/3/issuetype/{id}/avatar2" : { "post" : { "summary" : "Load issue type avatar", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueTypeResource.createIssueTypeAvatar_post", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue type is not found." }, "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Avatar" }, "example" : "{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"/secure/useravatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"/secure/useravatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"/secure/useravatar?avatarId=10040&avatarType=project\"}}" } }, "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if:\n\n * an image isn't included in the request.\n * the image type is unsupported.\n * the crop parameters extend the crop area beyond the edge of the image.\n * `cropSize` is missing.\n * the issue type ID is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "description" : "Loads an avatar for the issue type.\n\nSpecify the avatar's local file location in the body of the request. Also, include the following headers:\n\n * `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers).\n * `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.\n\nFor example: \n`curl --request POST \\ --user email@example.com: \\ --header 'X-Atlassian-Token: no-check' \\ --header 'Content-Type: image/< image_type>' \\ --data-binary \"<@/path/to/file/with/your/avatar>\" \\ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This`\n\nThe avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square's sides is set to the smaller of the height or width of the image.\n\nThe cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.\n\nAfter creating the avatar, use [ Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type's displayed avatar.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "requestBody" : { "required" : true, "content" : { "*/*" : { "schema" : {} } } }, "tags" : [ "Issue types" ], "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "description" : "The ID of the issue type.", "name" : "id", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "description" : "The X coordinate of the top-left corner of the crop region.", "name" : "x", "in" : "query", "schema" : { "default" : 0, "format" : "int32", "type" : "integer" } }, { "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "name" : "y", "description" : "The Y coordinate of the top-left corner of the crop region." }, { "description" : "The length of each side of the crop region.", "name" : "size", "required" : true, "in" : "query", "schema" : { "format" : "int32", "type" : "integer" } } ] } }, "/api/3/role/{id}" : { "delete" : { "tags" : [ "Project roles" ], "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" }, "description" : "The ID of the project role to delete. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "name" : "id" }, { "schema" : { "type" : "integer", "format" : "int64" }, "in" : "query", "name" : "swap", "description" : "The ID of the project role that will replace the one being deleted." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project role being deleted is not found." }, "400" : { "description" : "Returned if the request is invalid or if the replacement project role is not found." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have administrative permissions." }, "409" : { "description" : "Returned if the project role being deleted is in use and a replacement project role is not specified in the request." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.deleteProjectRole_delete", "summary" : "Delete project role" }, "get" : { "tags" : [ "Project roles" ], "x-atlassian-connect-scope" : "ADMIN", "parameters" : [ { "name" : "id", "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" } } ], "deprecated" : false, "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectRole" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project role is not found." }, "403" : { "description" : "Returned if the user does not have administrative permissions." } }, "description" : "Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "summary" : "Get project role by ID", "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.getProjectRoleById_get" }, "post" : { "description" : "Updates either the project role's name or its description.\n\nYou cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "404" : { "description" : "Returned if the project role is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectRole" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have administrative permissions." } }, "summary" : "Partial update project role", "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.partialUpdateProjectRole_post", "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "name" : "id", "required" : true, "in" : "path", "schema" : { "type" : "integer", "format" : "int64" } } ], "tags" : [ "Project roles" ], "requestBody" : { "content" : { "application/json" : { "example" : { "name" : "Developers", "description" : "A project role that represents developers in a project" }, "schema" : { "$ref" : "#/components/schemas/CreateUpdateRoleRequestBean" } } }, "required" : true } }, "put" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "description" : "A project role that represents developers in a project", "name" : "Developers" }, "schema" : { "$ref" : "#/components/schemas/CreateUpdateRoleRequestBean" } } } }, "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" }, "name" : "id", "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs." } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Project roles" ], "operationId" : "com.atlassian.jira.rest.v2.issue.project.RoleResource.fullyUpdateProjectRole_put", "summary" : "Fully update project role", "security" : [ { "basicAuth" : [] } ], "description" : "Updates the project role's name and description. You must include both a name and a description in the request.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "400" : { "description" : "Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace." }, "403" : { "description" : "Returned if the user does not have administrative permissions." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}", "schema" : { "$ref" : "#/components/schemas/ProjectRole" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the project role is not found." } } } }, "/api/3/user/assignable/search" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.findAssignableUsers_get", "summary" : "Find users assignable to issues", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "description" : "Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:\n\n * a new issue, by providing the `projectKeyOrId`.\n * an updated issue, by providing the `issueKey`.\n * to an issue during a transition (workflow action), by providing the `issueKey` and the transition id in `actionDescriptorId`. You can obtain the IDs of an issue's valid transitions using the `transitions` option in the `expand` parameter of [ Get issue](#api-rest-api-3-issue-issueIdOrKey-get).\n\nIn all these cases, you can pass an accountId to determine if a user can be assigned to an issue. The user is returned in the response if they can be assigned to the issue or issue transition.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the project, issue, or transition is not found." }, "400" : { "description" : "Returned if:\n\n * `issueKey` or `project` is missing.\n * neither of `query` and `accountId` are provided.\n * both `query` and `accountId` are provided." } }, "parameters" : [ { "schema" : { "type" : "string", "example" : "query" }, "in" : "query", "description" : "A query string that is matched against user attributes, such as `displayName`, and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `username` or `accountId` is specified.", "name" : "query", "x-showInExample" : "true" }, { "in" : "query", "schema" : { "type" : "string" }, "description" : "The sessionId of this request. SessionId is the same until the assignee is set.", "name" : "sessionId" }, { "name" : "username", "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "in" : "query", "schema" : { "type" : "string" } }, { "description" : "A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless `query` is specified.", "name" : "accountId", "schema" : { "type" : "string" }, "in" : "query" }, { "name" : "project", "description" : "The project ID or project key (case sensitive). Required, unless `issueKey` is specified.", "in" : "query", "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "issueKey", "description" : "The key of the issue. Required, unless `project` is specified." }, { "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt", "schema" : { "type" : "integer", "format" : "int32", "default" : 0 }, "in" : "query" }, { "in" : "query", "schema" : { "default" : 50, "type" : "integer", "format" : "int32" }, "description" : "The maximum number of items to return per page. The maximum is `1000`.", "name" : "maxResults" }, { "schema" : { "type" : "integer", "format" : "int32" }, "in" : "query", "description" : "The ID of the transition.", "name" : "actionDescriptorId" } ], "deprecated" : false, "x-atlassian-connect-scope" : "READ", "tags" : [ "User search" ] } }, "/api/3/issueLink" : { "post" : { "summary" : "Create issue link", "operationId" : "com.atlassian.jira.rest.v2.issue.LinkIssueResource.linkIssues_post", "responses" : { "400" : { "description" : "Returned if the comment is not created. The response contains an error message indicating why the comment wasn't created. The issue link is also not created." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * issue linking is disabled.\n * the user cannot view one or both of the issues. For example, the user doesn't have *Browse project* project permission for a project containing one of the issues.\n * the user does not have *link issues* project permission.\n * either of the link issues are not found.\n * the issue link type is not found." }, "201" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." } }, "description" : "Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have [Issue Linking](https://confluence.atlassian.com/x/yoXKM) enabled.\n\nThis resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use `https://your-domain.atlassian.net/rest/api/3/issue/[linked issue key]?fields=issuelinks`.\n\nIf the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse project* [project permission](https://confluence.atlassian.com/x/yodKLg) for all the projects containing the issues to be linked,\n * *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) on the project containing the from (outward) issue,\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "requestBody" : { "content" : { "application/json" : { "example" : { "outwardIssue" : { "key" : "MKY-1" }, "inwardIssue" : { "key" : "HSP-1" }, "type" : { "name" : "Duplicate" }, "comment" : { "visibility" : { "value" : "jira-software-users", "type" : "group" }, "body" : { "version" : 1, "type" : "doc", "content" : [ { "content" : [ { "type" : "text", "text" : "Linked related issue!" } ], "type" : "paragraph" } ] } } }, "schema" : { "$ref" : "#/components/schemas/LinkIssueRequestJsonBean" } } }, "description" : "The issue link request.", "required" : true }, "tags" : [ "Issue links" ], "x-atlassian-connect-scope" : "WRITE", "deprecated" : false, "parameters" : [] } }, "/api/3/issue/{issueIdOrKey}/remotelink" : { "delete" : { "responses" : { "400" : { "description" : "Returned if a global ID isn't provided." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have permission to link issues." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue." } }, "description" : "Deletes the remote issue link from the issue using the link's global ID. Where the global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is implemented, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "summary" : "Delete remote issue link by global ID", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.deleteRemoteIssueLinkByGlobalId_delete", "tags" : [ "Issue remote links" ], "x-atlassian-connect-scope" : "DELETE", "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "10000" }, "required" : true, "in" : "path" }, { "x-showInExample" : "true", "description" : "The global ID of a remote issue link.", "name" : "globalId", "required" : true, "in" : "query", "schema" : { "example" : "system=http://www.mycompany.com/support&id=1", "type" : "string" } } ], "deprecated" : false }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getRemoteIssueLinks_get", "summary" : "Get remote issue links", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass `system=http://www.mycompany.com/support&id=1` as `system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1`.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "[{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000\",\"globalId\":\"system=http://www.mycompany.com/support&id=1\",\"application\":{\"type\":\"com.acme.tracker\",\"name\":\"My Acme Tracker\"},\"relationship\":\"causes\",\"object\":{\"url\":\"http://www.mycompany.com/support?id=1\",\"title\":\"TSTSUP-111\",\"summary\":\"Customer support issue\",\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/ticket.png\",\"title\":\"Support Ticket\"},\"status\":{\"resolved\":true,\"icon\":{\"url16x16\":\"http://www.mycompany.com/support/resolved.png\",\"title\":\"Case Closed\",\"link\":\"http://www.mycompany.com/support?id=1&details=closed\"}}}},{\"id\":10001,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10001\",\"globalId\":\"system=http://www.anothercompany.com/tester&id=1234\",\"application\":{\"type\":\"com.acme.tester\",\"name\":\"My Acme Tester\"},\"relationship\":\"is tested by\",\"object\":{\"url\":\"http://www.anothercompany.com/tester/testcase/1234\",\"title\":\"Test Case #1234\",\"summary\":\"Test that the submit button saves the item\",\"icon\":{\"url16x16\":\"http://www.anothercompany.com/tester/images/testcase.gif\",\"title\":\"Test Case\"},\"status\":{\"resolved\":false,\"icon\":{\"url16x16\":\"http://www.anothercompany.com/tester/images/person/mia.gif\",\"title\":\"Tested by Mia Krystof\",\"link\":\"http://www.anothercompany.com/tester/person?accountId=5b10a2844c20165700ede21g\"}}}}]", "schema" : { "$ref" : "#/components/schemas/RemoteIssueLink" } } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the the issue or remote issue link is not found or the user does not have permission to view the issue." }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if issue linking is disabled." } }, "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "x-showInExample" : "true", "schema" : { "example" : "10000", "type" : "string" }, "in" : "path", "required" : true }, { "name" : "globalId", "description" : "The global ID of the remote issue link.", "schema" : { "type" : "string" }, "in" : "query" } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Issue remote links" ] }, "post" : { "requestBody" : { "required" : true, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RemoteIssueLinkRequest" }, "example" : { "relationship" : "causes", "globalId" : "system=http://www.mycompany.com/support&id=1", "object" : { "status" : { "resolved" : true, "icon" : { "title" : "Case Closed", "link" : "http://www.mycompany.com/support?id=1&details=closed", "url16x16" : "http://www.mycompany.com/support/resolved.png" } }, "title" : "TSTSUP-111", "icon" : { "url16x16" : "http://www.mycompany.com/support/ticket.png", "title" : "Support Ticket" }, "summary" : "Customer support issue", "url" : "http://www.mycompany.com/support?id=1" }, "application" : { "type" : "com.acme.tracker", "name" : "My Acme Tracker" } } } } }, "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "x-showInExample" : "true", "schema" : { "type" : "string", "example" : "10000" }, "required" : true, "in" : "path" } ], "deprecated" : false, "tags" : [ "Issue remote links" ], "summary" : "Create or update remote issue link", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.createOrUpdateRemoteIssueLink_post", "description" : "Creates or updates a remote issue link for an issue.\n\nIf a `globalId` is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created.\n\nThis operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Link issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RemoteIssueLinkIdentifies" }, "example" : "{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000\"}" } }, "description" : "Returned if the remote issue link is updated." }, "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view the issue." }, "201" : { "content" : { "application/json" : { "example" : "{\"id\":10000,\"self\":\"http://www.example.com/jira/rest/api/issue/MKY-1/remotelink/10000\"}", "schema" : { "$ref" : "#/components/schemas/RemoteIssueLinkIdentifies" } } }, "description" : "Returned if the remote issue link is created." }, "400" : { "content" : { "application/json" : { "example" : "{\"errorMessages\":[],\"errors\":{\"title\":\"'title' is required.\"}}" } }, "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have permission to link issues." } } } }, "/api/3/task/{taskId}/cancel" : { "post" : { "tags" : [ "Tasks" ], "x-atlassian-connect-scope" : "NONE", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "taskId", "description" : "The ID of the task." } ], "x-experimental" : true, "responses" : { "400" : { "description" : "Returned if cancellation of the task is not possible.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "403" : { "content" : { "application/json" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } } }, "description" : "Returned if the user does not have the required permissions." }, "404" : { "content" : { "application/json" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } } }, "description" : "Returned if the task is not found." }, "401" : { "content" : { "application/json" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } } }, "description" : "Returned if the authentication credentials are incorrect or missing." }, "202" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } }, "description" : "Cancels a task.\n\n**[Permissions](#permissions) required:** either of:\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * Creator of the task.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] } ], "summary" : "Cancel task", "operationId" : "com.atlassian.jira.rest.v2.task.TaskResource.cancelTask_post" } }, "/api/3/avatar/{type}/system" : { "get" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "deprecated" : false, "parameters" : [ { "x-showInExample" : "true", "name" : "type", "description" : "The avatar type.", "in" : "path", "required" : true, "schema" : { "type" : "string", "example" : "project", "enum" : [ "issuetype", "project", "user" ] } } ], "tags" : [ "Avatars" ], "summary" : "Get system avatars by type", "operationId" : "com.atlassian.jira.rest.v2.issue.AvatarResource.getAllSystemAvatars_get", "description" : "Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "{\"system\":[{\"id\":\"1000\",\"isSystemAvatar\":true,\"isSelected\":false,\"isDeletable\":false,\"urls\":{\"16x16\":\"/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project\",\"24x24\":\"/secure/useravatar?size=small&avatarId=10040&avatarType=project\",\"32x32\":\"/secure/useravatar?size=medium&avatarId=10040&avatarType=project\",\"48x48\":\"/secure/useravatar?avatarId=10040&avatarType=project\"}}]}", "schema" : { "$ref" : "#/components/schemas/SystemAvatars" } } }, "description" : "Returned if the request is successful." }, "500" : { "description" : "Returned if an error occurs while retrieving the list of avatars." } } } }, "/api/3/screens/{screenId}/tabs/{tabId}/fields" : { "get" : { "tags" : [ "Screens" ], "x-atlassian-connect-scope" : "ADMIN", "deprecated" : false, "parameters" : [ { "name" : "screenId", "description" : "The ID of the screen.", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "description" : "The ID of the screen tab.", "name" : "tabId", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "projectKey", "description" : "The key of the project." } ], "summary" : "Get all screen tab fields", "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.getAllScreenTabFields_get", "responses" : { "404" : { "description" : "Returned if the screen or screen tab is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScreenableField" } } } } }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "description" : "Returns all fields for a screen tab.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * *Administer projects* [project permission](https://confluence.atlassian.com/x/yodKLg) when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ] }, "post" : { "deprecated" : false, "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the screen.", "name" : "screenId" }, { "description" : "The ID of the screen tab.", "name" : "tabId", "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" } } ], "x-atlassian-connect-scope" : "ADMIN", "tags" : [ "Screens" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddFieldBean" }, "example" : { "fieldId" : "summary" } } }, "required" : true }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Adds a field to a screen tab.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenableField" }, "example" : "{\"id\":\"summary\",\"name\":\"Summary\"}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the screen, screen tab, or field is not found." }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.ScreensResource.addScreenTabField_post", "summary" : "Add screen tab field" } }, "/api/3/issue/{issueIdOrKey}/votes" : { "get" : { "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Votes" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/issue/MKY-1/votes\",\"votes\":24,\"hasVoted\":true,\"voters\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}]}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * voting is disabled.\n * the user does not have permission to view the issue.\n * the issue is not found." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns details about the votes on an issue.\n\nThis operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is ini\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\nNote that users with the necessary permissions for this operation but without the *View voters and watchers* project permissions are not returned details in the `voters` field.", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getVotes_get", "summary" : "Get votes", "tags" : [ "Issue votes" ], "deprecated" : false, "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } } ], "x-atlassian-connect-scope" : "READ" }, "delete" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.removeVote_delete", "summary" : "Delete vote", "responses" : { "204" : { "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if:\n\n * voting is disabled.\n * the user has not voted on the issue.\n * the user is the issue reporter.\n * the issue is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes a user's vote from an issue. This is the equivalent of the user clicking *Unvote* on an issue in Jira.\n\nThis operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "tags" : [ "Issue votes" ], "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" } ], "deprecated" : false, "x-atlassian-connect-scope" : "DELETE" }, "post" : { "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.addVote_post", "summary" : "Add vote", "responses" : { "404" : { "description" : "Returned if:\n\n * voting is disabled.\n * the user is the issue reporter.\n * the issue is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "204" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Adds the user's vote to an issue. This is the equivalent of the user clicking *Vote* on an issue in Jira.\n\nThis operation requires the **Allow users to vote on issues** option to be *ON*. This option is set in General configuration for Jira. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "tags" : [ "Issue votes" ], "deprecated" : false, "parameters" : [ { "description" : "The ID or key of the issue.", "name" : "issueIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "WRITE" } }, "/api/3/user/viewissue/search" : { "get" : { "summary" : "Find users with browse permission", "operationId" : "com.atlassian.jira.rest.v2.issue.UserResource.findUsersWithBrowsePermission_get", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5\",\"key\":\"\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32\"},\"displayName\":\"Emma Richards\",\"active\":false}]" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the issue or project is not found." }, "400" : { "description" : "Returned if:\n\n * neither of `issueKey` or `projectKey` are provided.\n * neither of `query` or `accountId` are provided.\n * both `query` and `accountId` are provided." } }, "description" : "Returns a list of users who fulfill these criteria:\n\n * their user attributes match a search string.\n * they have permission to browse issues.\n\nUse this resource to find users who can browse:\n\n * an issue, by providing the `issueKey`.\n * any issue in a project, by providing the `projectKey`.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). Anonymous calls and calls by users without the required permission return empty search results.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "tags" : [ "User search" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "x-showInExample" : "true", "description" : "A query string that is matched against user attributes, such as `displayName` and `emailAddress`, to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a `displayName` of *John Smith* and a user with an `emailAddress` of *johnson@example.com*. Required, unless `accountId` is specified.", "name" : "query", "in" : "query", "schema" : { "example" : "query", "type" : "string" } }, { "description" : "This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.", "name" : "username", "schema" : { "type" : "string" }, "in" : "query" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "accountId", "description" : "A query string that is matched against user accountId. The string must match the accountId exactly. Required, unless `query` is specified." }, { "name" : "issueKey", "description" : "The issue key for the issue. Required, unless `projectKey` is specified.", "in" : "query", "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "in" : "query", "description" : "The project key for the project (case sensitive). Required, unless `issueKey` is specified.", "name" : "projectKey" }, { "description" : "The index of the first item to return in a page of results (page offset).", "name" : "startAt", "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int32" } }, { "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "description" : "The maximum number of items to return per page. The maximum is `1000`.", "name" : "maxResults" } ], "deprecated" : false } }, "/api/3/project/{projectIdOrKey}/component" : { "get" : { "deprecated" : false, "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive)." }, { "name" : "startAt", "description" : "The index of the first item to return in a page of results (page offset).", "in" : "query", "schema" : { "default" : 0, "type" : "integer", "format" : "int64" } }, { "in" : "query", "schema" : { "format" : "int32", "type" : "integer", "default" : 50 }, "description" : "The maximum number of items to return per page. The maximum is `50`.", "name" : "maxResults" }, { "name" : "orderBy", "description" : "[Order](#ordering) the results by a field:\n\n * `description` Sorts components in alphabetical order by description.\n * `issueCount` Sorts components by the count of issues associated with the component in ascending order.\n * `lead` Sorts by the project lead's user key in alphabetical order.\n * `name` Sorts components in alphabetical order by component name.", "schema" : { "type" : "string", "enum" : [ "description", "-description", "+descriptionissueCount", "-issueCount", "+issueCountlead", "-lead", "+lead", "name", "-name", "+name" ] }, "in" : "query" }, { "name" : "query", "description" : "Filter the results using a literal string. Components with a matching `name` or `description` are returned (case insensitive).", "in" : "query", "schema" : { "type" : "string" } } ], "x-atlassian-connect-scope" : "READ", "tags" : [ "Project components" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a [paginated](#pagination) representation of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "responses" : { "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." }, "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/component?startAt=0&maxResults=2\",\"nextPage\":\"http://your-domain.atlassian.net/rest/api/3/project/PR/component?startAt=2&maxResults=2\",\"maxResults\":2,\"startAt\":0,\"total\":7,\"isLast\":false,\"values\":[{\"componentBean\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000},\"issueCount\":1,\"projectId\":10000,\"project\":\"HSP\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"realAssigneeType\":\"PROJECT_LEAD\",\"name\":\"Component 1\",\"id\":\"10000\"},{\"componentBean\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000},\"issueCount\":5,\"projectId\":10000,\"project\":\"PROJECTKEY\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"realAssigneeType\":\"PROJECT_LEAD\",\"name\":\"PXA\",\"id\":\"10050\"}]}", "schema" : { "$ref" : "#/components/schemas/PageBeanComponentWithIssueCount" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.getProjectComponentsPaginated_get", "summary" : "Get project components paginated" } }, "/atlassian-connect/1/app/module/dynamic" : { "delete" : { "summary" : "Remove modules", "operationId" : "DynamicModulesResource.removeModules_delete", "responses" : { "204" : { "description" : "Returned if the request is successful." }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "example" : { "message" : "The request is not from a Connect app." } } }, "description" : "Returned if the call is not from a Connect app." } }, "description" : "Remove all or a list of modules registered by the calling app.\n\n**[Permissions](#permissions) required:** Only Connect apps can make this request.", "x-experimental" : true, "tags" : [ "Dynamic modules" ], "x-atlassian-connect-scope" : "NONE", "deprecated" : false, "parameters" : [ { "in" : "query", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" }, "name" : "moduleKey", "description" : "The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.\nFor example, `moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field`.\nNonexistent keys are ignored." } ] }, "get" : { "parameters" : [], "deprecated" : false, "x-atlassian-connect-scope" : "NONE", "tags" : [ "Dynamic modules" ], "x-experimental" : true, "description" : "Returns all modules registered dynamically by the calling app.\n\n**[Permissions](#permissions) required:** Only Connect apps can make this request.", "responses" : { "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" }, "example" : { "message" : "The request is not from a Connect app." } } }, "description" : "Returned if the call is not from a Connect app." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectModules" } } } } }, "operationId" : "DynamicModulesResource.getModules_get", "summary" : "Get modules" }, "post" : { "summary" : "Register modules", "operationId" : "DynamicModulesResource.registerModules_post", "responses" : { "401" : { "content" : { "application/json" : { "example" : { "message" : "The request is not from a Connect app." }, "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Returned if the call is not from a Connect app." }, "200" : { "description" : "Returned if the request is successful." }, "400" : { "content" : { "application/json" : { "example" : { "message" : "Installation failed. The app com.example.app.key has duplicate module keys: [module-key]. Please contact the app vendor." }, "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } }, "description" : "Returned if:\n* any of the provided modules is invalid. For example, required properties are missing.\n* any of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.\n\nDetails of the issues encountered are included in the error message." } }, "description" : "Registers a list of modules.\n\n**[Permissions](#permissions) required:** Only Connect apps can make this request.", "x-experimental" : true, "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectModules" } } }, "required" : true }, "tags" : [ "Dynamic modules" ], "x-atlassian-connect-scope" : "NONE", "parameters" : [], "deprecated" : false } }, "/api/3/myself" : { "get" : { "summary" : "Get current user", "operationId" : "com.atlassian.jira.rest.v2.issue.CurrentUserResource.getCurrentUser_get", "description" : "Returns details for the current user.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] } ], "responses" : { "200" : { "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}}", "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "x-atlassian-connect-scope" : "READ", "parameters" : [ { "schema" : { "type" : "string" }, "in" : "query", "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about user in the response. This parameter accepts multiple values separated by a comma:\n\n * `groups` Returns all groups, including nested groups, the user belongs to.\n * `applicationRoles` Returns the application roles the user is assigned to." } ], "deprecated" : false, "tags" : [ "Myself" ] } }, "/api/3/statuscategory" : { "get" : { "operationId" : "com.atlassian.jira.rest.v2.issue.StatusCategoryResource.getStatusCategories_get", "summary" : "Get all status categories", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns a list of all status categories.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatusCategory" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}]" } }, "description" : "Returned if the request is successful." } }, "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "READ", "tags" : [ "Workflow status categories" ] } }, "/api/3/applicationrole" : { "get" : { "tags" : [ "Application roles" ], "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.admin.applicationrole.ApplicationRoleResource.getAllApplicationRoles_get", "summary" : "Get all application roles", "responses" : { "403" : { "description" : "Returned if the user is not an administrator." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ApplicationRole" }, "type" : "array" }, "example" : "[{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5 developers\",\"hasUnlimitedSeats\":false,\"platform\":false},{\"key\":\"jira-core\",\"groups\":[\"jira-core-users\"],\"name\":\"Jira Core\",\"defaultGroups\":[\"jira-core-users\"],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":1,\"remainingSeats\":1,\"userCount\":0,\"userCountDescription\":\"0 users\",\"hasUnlimitedSeats\":false,\"platform\":true}]" } } } }, "security" : [ { "basicAuth" : [] } ], "description" : "Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } }, "/api/3/project/{projectIdOrKey}/type/{newProjectTypeKey}" : { "put" : { "tags" : [ "Projects" ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "deprecated" : true, "parameters" : [ { "description" : "The project ID or project key (case sensitive).", "name" : "projectIdOrKey", "schema" : { "type" : "string" }, "required" : true, "in" : "path" }, { "description" : "The key of the new project type.", "name" : "newProjectTypeKey", "required" : true, "in" : "path", "schema" : { "enum" : [ "software", "service_desk", "business" ], "type" : "string" } } ], "summary" : "Update project type", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectResource.updateProjectType_put", "responses" : { "404" : { "description" : "Returned if the project is not found or the user does not have permission to view it." }, "200" : { "description" : "Returned if the project type is updated.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Project" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"description\":\"This project was created as an example for REST.\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"components\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000}],\"issueTypes\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"http://your-domain.atlassian.net//secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"http://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}],\"url\":\"http://your-domain.atlassian.net/browse/EX\",\"email\":\"from-jira@example.com\",\"assigneeType\":\"PROJECT_LEAD\",\"versions\":[],\"name\":\"Example\",\"roles\":{\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/EX/role/10000\"},\"avatarUrls\":{\"48x48\":\"http://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"http://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"http://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"http://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"properties\":{\"propertyKey\":\"propertyValue\"}}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the request is not valid." } }, "description" : "Deprecated, this feature is no longer supported and no alternatives are available, see [Convert project to a different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, project type cannot be updated for next-gen projects.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ] } }, "/api/3/permissionscheme/{schemeId}/permission/{permissionId}" : { "get" : { "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "description" : "The ID of the permission scheme.", "name" : "schemeId", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" }, { "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true, "name" : "permissionId", "description" : "The ID of the permission grant." }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "expand", "description" : "Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma. Note that permissions are always included when you specify any value:\n\n * `all` Returns all expandable information.\n * `field` Returns information about the custom field granted the permission.\n * `group` Returns information about the group that is granted the permission.\n * `permissions` Returns all permission grants for each permission scheme.\n * `projectRole` Returns information about the project role granted the permission.\n * `user` Returns information about the user who is granted the permission." } ], "deprecated" : false, "tags" : [ "Permission schemes" ], "description" : "Returns a permission grant.\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PermissionGrant" }, "example" : "{\"id\":10000,\"self\":\"http://your-domain.atlassian.net/rest/api/3/permissionscheme/permission/10000\",\"holder\":{\"type\":\"group\",\"parameter\":\"jira-core-users\",\"expand\":\"group\"},\"permission\":\"ADMINISTER_PROJECTS\"}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the user is not permitted to view permission schemes or if the permission scheme or permission grant is not found." } }, "summary" : "Get permission scheme grant", "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.getPermissionSchemeGrant_get" }, "delete" : { "security" : [ { "basicAuth" : [] } ], "description" : "Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "204" : { "description" : "Returned if the permission grant is deleted." }, "403" : { "description" : "Returned if the user is not permitted to edit permission schemes." }, "400" : { "description" : "Returned if permission grant with the provided ID is not found." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.permissionscheme.PermissionSchemeResource.deletePermissionSchemeEntity_delete", "summary" : "Delete permission scheme grant", "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the permission scheme to delete the permission grant from.", "name" : "schemeId" }, { "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path", "description" : "The ID of the permission grant to delete.", "name" : "permissionId" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Permission schemes" ] } }, "/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties" : { "get" : { "responses" : { "404" : { "description" : "Returned if:\n\n * the issue or worklog is not found.\n * the user does not have permission to view the issue or worklog." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}", "schema" : { "$ref" : "#/components/schemas/PropertyKeys" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the worklog ID is invalid." } }, "description" : "Returns the keys of all properties for a worklog.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get worklog property keys", "operationId" : "com.atlassian.jira.rest.v2.issue.WorklogPropertyResource.getWorklogPropertyKeys_get", "tags" : [ "Issue worklog properties" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "issueIdOrKey", "description" : "The ID or key of the issue.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the worklog.", "name" : "worklogId" } ] } }, "/api/3/project/{projectIdOrKey}/role/{id}" : { "put" : { "summary" : "Set actors for project role", "operationId" : "com.atlassian.jira.rest.v2.issue.project.ProjectRoleResource.setActors_put", "responses" : { "404" : { "description" : "Returned if:\n\n * the project is not found.\n * a user or group is not found.\n * a group or user is not active." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectRole" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}" } }, "description" : "Returned if the request is successful. The complete list of actors for the project is returned." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project." }, "400" : { "description" : "Returned if the request is not valid." } }, "description" : "Sets the actors for a project role for a project, replacing all existing actors.\n\nTo add actors to the project without overwriting the existing list, use [Add actors to project role](#api-rest-api-3-project-projectIdOrKey-role-id-post).\n\n**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "requestBody" : { "content" : { "application/json" : { "example" : { "categorisedActors" : { "atlassian-user-role-actor" : [ "12345678-9abc-def1-2345-6789abcdef12" ], "atlassian-group-role-actor" : [ "jira-developers" ] } }, "schema" : { "$ref" : "#/components/schemas/ProjectRoleActorsUpdateBean" } } }, "description" : "The groups or users to associate with the project role for this project. Provide the user account ID or group name.", "required" : true }, "tags" : [ "Project role actors" ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "schema" : { "type" : "string" }, "in" : "path", "required" : true }, { "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "name" : "id", "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path" } ], "deprecated" : false }, "post" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] }, {} ], "description" : "Adds actors to a project role for the project.\n\nTo replace all actors for the project, use [Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put).\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "400" : { "description" : "Returned if the request is not valid." }, "404" : { "description" : "Returned if:\n\n * the project is not found.\n * the user or group is not found.\n * the group or user is not active." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectRole" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}" } }, "description" : "Returned if the request is successful. The complete list of actors for the project is returned.\n\nFor example, the cURL request above adds a group, *jira-developers*. For the response below to be returned as a result of that request, the user *Mia Krystof* would have previously been added as a `user` actor for this project." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing or if the calling user lacks administrative permissions for the project." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.project.ProjectRoleResource.addActorUsers_post", "summary" : "Add actors to project role", "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The project ID or project key (case sensitive).", "name" : "projectIdOrKey" }, { "name" : "id", "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "path", "required" : true } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Project role actors" ], "requestBody" : { "content" : { "application/json" : { "example" : { "group" : [ "jira-developers" ] }, "schema" : { "$ref" : "#/components/schemas/ActorsMap" } } }, "description" : "The groups or users to associate with the project role for this project. Provide the user account ID or group name.", "required" : true } }, "delete" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Deletes actors from a project role for the project.\n\nTo remove default actors from the project role, use [Delete default actors from project role This operation can be accessed anonymously. ](#api-rest-api-3-role-id-actors-delete)\n\n[ ](#api-rest-api-3-role-id-actors-delete)**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "404" : { "description" : "Returned if:\n\n * the project or project role is not found.\n * the calling user does not have administrative permission." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the request is not valid." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.project.ProjectRoleResource.deleteActor_delete", "summary" : "Delete actors from project role", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive)." }, { "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "name" : "id", "required" : true, "in" : "path", "schema" : { "format" : "int64", "type" : "integer" } }, { "schema" : { "example" : "5b10ac8d82e05b22cc7d4ef5", "type" : "string" }, "in" : "query", "description" : "The user account ID of the user to remove from the project role.", "name" : "user", "x-showInExample" : "true" }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "group", "description" : "The name of the group to remove from the project role." } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "tags" : [ "Project role actors" ] }, "get" : { "tags" : [ "Project roles" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive)." }, { "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path", "description" : "The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs.", "name" : "id" } ], "responses" : { "404" : { "description" : "Returned if:\n\n * the project or project role is not found.\n * the user does not have administrative permission." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"name\":\"\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}", "schema" : { "$ref" : "#/components/schemas/ProjectRole" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the request is not valid." } }, "description" : "Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.\n\nTo check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-3-user-get) with the `groups` expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project or *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get project role for project", "operationId" : "com.atlassian.jira.rest.v2.issue.project.ProjectRoleResource.getProjectRole_get" } }, "/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}" : { "delete" : { "tags" : [ "Avatars" ], "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The type of the entity. Valid values are `project` and `issuetype`.", "name" : "type" }, { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID of the entity item.", "name" : "owningObjectId" }, { "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path", "description" : "The ID of the avatar.", "name" : "id" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "operationId" : "com.atlassian.jira.rest.v2.issue.UniversalAvatarResource.deleteAvatar_delete", "summary" : "Delete avatar", "responses" : { "404" : { "description" : "Returned if the entity type, entity ID, or avatar ID is invalid." }, "403" : { "description" : "Returned if the user does not have permission to delete the avatar, the avatar is not deletedable." }, "204" : { "description" : "Returned if the request is successful." }, "400" : { "description" : "Returned if the request is invalid." } }, "security" : [ { "basicAuth" : [] }, {} ], "description" : "Deletes an avatar from a project or issue type.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)." } }, "/api/3/field/{fieldKey}/option/{optionId}/issue" : { "delete" : { "parameters" : [ { "name" : "replaceWith", "description" : "The ID of the option that will replace the currently selected option.", "schema" : { "format" : "int64", "type" : "integer" }, "in" : "query" }, { "name" : "jql", "description" : "A JQL query that specifies the issues to be updated. For example, *project=10000*.", "in" : "query", "schema" : { "type" : "string" } }, { "description" : "The field key is specified in the following format: **$(app-key)\\\\\\_\\\\\\_$(field-key)**. For example, *example-add-on\\\\\\_\\\\\\_example-issue-field*.", "name" : "fieldKey", "required" : true, "in" : "path", "schema" : { "type" : "string" } }, { "description" : "The ID of the option to be deselected.", "name" : "optionId", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" } ], "deprecated" : false, "x-atlassian-connect-scope" : "NONE", "tags" : [ "Issue field options" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-configuration" ] } ], "description" : "Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query.\n\nThis is an [asynchronous operation](#async). The response object contains a link to the long-running task.\n\nNote that this operation **cannot be used with the built-in custom fields**. It only works with issue fields added by Connect apps, as described above.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app providing the field.", "responses" : { "303" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaskProgressBeanRemoveOptionFromIssuesResult" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/task/1\",\"id\":\"1\",\"description\":\"Remove option 1 from issues matched by '*', and replace with option 3\",\"status\":\"COMPLETE\",\"result\":{\"modifiedIssues\":[10001,10010],\"unmodifiedIssues\":[10005],\"errors\":{\"errors\":{},\"errorMessages\":[\"Option 2 cannot be set on issue MKY-5 as it is not in the correct scope\"],\"httpStatusCode\":{\"present\":true}}},\"elapsedRuntime\":42}" } }, "description" : "Returned if the long-running task to deselect the option is started." }, "400" : { "description" : "Returned if the JQL query is invalid." }, "404" : { "description" : "Returned if the field is not found or does not support options, or the options to be replaced are not found." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.field.IssueFieldOptionResource.replaceIssueFieldOption_delete", "summary" : "Replace issue field option" } }, "/api/3/project/{projectIdOrKey}/role" : { "get" : { "tags" : [ "Project roles" ], "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive).", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing or if the user lacks administrative permissions for the project." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"Administrators\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10002\",\"Users\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10001\",\"Developers\":\"http://your-domain.atlassian.net/rest/api/3/project/MKY/role/10000\"}", "schema" : { "type" : "object", "additionalProperties" : { "type" : "string", "format" : "uri" } } } } }, "404" : { "description" : "Returned if the project is not found or or if the user does not have administrative permissions for the project." } }, "description" : "Returns a list of [project roles](https://confluence.atlassian.com/x/3odKLg) for the project returning the name and self URL for each role.\n\nNote that all project roles are shared with all projects in Jira Cloud. See [Get all project roles](#api-rest-api-3-role-get) for more information.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for any project on the site*Administer Jira* or [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get project roles for project", "operationId" : "com.atlassian.jira.rest.v2.issue.project.ProjectRoleResource.getProjectRoles_get" } }, "/api/3/status" : { "get" : { "x-atlassian-connect-scope" : "READ", "parameters" : [], "deprecated" : false, "tags" : [ "Workflow statuses" ], "description" : "Returns a list of all statuses associated with workflows.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}}]", "schema" : { "items" : { "$ref" : "#/components/schemas/StatusDetails" }, "type" : "array" } } }, "description" : "Returned if the request is successful." } }, "summary" : "Get all statuses", "operationId" : "com.atlassian.jira.rest.v2.issue.StatusResource.getStatuses_get" } }, "/api/3/issue/bulk" : { "post" : { "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Creates issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set.\n\nThe content of each issue or subtask is defined using `update` and `fields`. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issues' create screens. Note that the `description`, `environment`, and any `textarea` type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (`textfield`) accept a string and don't handle Atlassian Document Format content.\n\nCreating a subtask differs from creating an issue as follows:\n\n * `issueType` must be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).\n * `parent` the must contain the ID or key of the parent issue.\n\n**[Permissions](#permissions) required:** *Browse projects* and *Create issues* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which each issue or subtask is created.", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "201" : { "content" : { "application/json" : { "example" : "{\"issues\":[{\"id\":\"10000\",\"key\":\"ED-24\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10000\",\"transition\":{\"status\":200,\"errorCollection\":{\"errorMessages\":[],\"errors\":{}}}},{\"id\":\"10001\",\"key\":\"ED-25\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/issue/10001\"}],\"errors\":[]}", "schema" : { "$ref" : "#/components/schemas/CreatedIssues" } } }, "description" : "Returned if any of the issue or subtask creation requests were successful. A request may be unsuccessful when it:\n\n * is missing required fields.\n * contains invalid field values.\n * contains fields that cannot be set for the issue type.\n * is by a user who does not have the necessary permissions.\n * is to create a subtype in a project different that of the the parent issue.\n * is for a subtask when the option to create subtasks is disabled.\n * is invalid for any other reason." }, "400" : { "content" : { "application/json" : { "example" : "{\"issues\":[],\"errors\":[{\"status\":400,\"elementErrors\":{\"errorMessages\":[],\"errors\":{\"issuetype\":\"The issue type selected is invalid.\",\"project\":\"Sub-tasks must be created in the same project as the parent.\"}},\"failedElementNumber\":0},{\"status\":400,\"elementErrors\":{\"errorMessages\":[],\"errors\":{\"issuetype\":\"The issue type selected is invalid.\",\"project\":\"Sub-tasks must be created in the same project as the parent.\"}},\"failedElementNumber\":1}]}", "schema" : { "$ref" : "#/components/schemas/CreatedIssues" } } }, "description" : "Returned if all requests are invalid. Requests may be unsuccessful when they:\n\n * are missing required fields.\n * contain invalid field values.\n * contain fields that cannot be set for the issue type.\n * are by a user who does not have the necessary permissions.\n * are to create a subtype in a project different that of the the parent issue.\n * is for a subtask when the option to create subtasks is disabled.\n * are invalid for any other reason." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.createIssues_post", "summary" : "Bulk create issue", "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "WRITE", "tags" : [ "Issues" ], "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "issueUpdates" : [ { "update" : { "worklog" : [ { "add" : { "started" : "2019-07-05T11:05:00.000+0000", "timeSpent" : "60m" } } ] }, "fields" : { "customfield_40000" : { "type" : "doc", "content" : [ { "content" : [ { "type" : "text", "text" : "Occurs on all orders" } ], "type" : "paragraph" } ], "version" : 1 }, "customfield_50000" : { "version" : 1, "content" : [ { "type" : "paragraph", "content" : [ { "text" : "Could impact day-to-day work.", "type" : "text" } ] } ], "type" : "doc" }, "labels" : [ "bugfix", "blitz_test" ], "environment" : { "version" : 1, "content" : [ { "type" : "paragraph", "content" : [ { "type" : "text", "text" : "UAT" } ] } ], "type" : "doc" }, "reporter" : { "id" : "5b10a2844c20165700ede21g" }, "versions" : [ { "id" : "10000" } ], "customfield_80000" : { "value" : "red" }, "customfield_30000" : [ "10000", "10002" ], "duedate" : "2011-03-11T00:00:00.000Z", "assignee" : { "id" : "5b109f2e9729b51b54dc274d" }, "customfield_60000" : "jira-software-users", "issuetype" : { "id" : "10000" }, "description" : { "content" : [ { "type" : "paragraph", "content" : [ { "type" : "text", "text" : "Order entry fails when selecting supplier." } ] } ], "type" : "doc", "version" : 1 }, "customfield_10000" : "09/Jun/19", "security" : { "id" : "10000" }, "summary" : "Main order flow broken", "timetracking" : { "originalEstimate" : "10", "remainingEstimate" : "5" }, "customfield_20000" : "06/Jul/19 3:25 PM", "priority" : { "id" : "20000" }, "components" : [ { "id" : "10000" } ], "customfield_70000" : [ "jira-administrators", "jira-software-users" ], "fixVersions" : [ { "id" : "10001" } ], "project" : { "id" : "10000" } } }, { "fields" : { "project" : { "id" : "1000" }, "fixVersions" : [ { "id" : "10001" } ], "components" : [ { "id" : "10000" } ], "customfield_70000" : [ "jira-administrators", "jira-software-users" ], "customfield_20000" : "06/Jul/19 3:25 PM", "priority" : { "id" : "20000" }, "summary" : "Order stuck in pending", "timetracking" : { "remainingEstimate" : "5", "originalEstimate" : "15" }, "description" : { "version" : 1, "content" : [ { "content" : [ { "type" : "text", "text" : "Order remains pending after approved." } ], "type" : "paragraph" } ], "type" : "doc" }, "security" : { "id" : "10000" }, "customfield_10000" : "09/Jun/19", "issuetype" : { "id" : "10000" }, "customfield_60000" : "jira-software-users", "customfield_80000" : { "value" : "red" }, "customfield_30000" : [ "10000", "10002" ], "assignee" : { "id" : "5b109f2e9729b51b54dc274d" }, "duedate" : "2019-04-16T00:00:00.000Z", "versions" : [ { "id" : "10000" } ], "reporter" : { "id" : "5b10a2844c20165700ede21g" }, "customfield_50000" : { "version" : 1, "content" : [ { "type" : "paragraph", "content" : [ { "text" : "Could impact day-to-day work.", "type" : "text" } ] } ], "type" : "doc" }, "environment" : { "type" : "doc", "content" : [ { "type" : "paragraph", "content" : [ { "text" : "UAT", "type" : "text" } ] } ], "version" : 1 }, "labels" : [ "new_release" ], "customfield_40000" : { "content" : [ { "content" : [ { "text" : "Occurs on all orders", "type" : "text" } ], "type" : "paragraph" } ], "type" : "doc", "version" : 1 } }, "update" : {} } ] }, "schema" : { "$ref" : "#/components/schemas/IssuesUpdateBean" } } } } } }, "/api/3/issuesecurityschemes/{id}" : { "get" : { "tags" : [ "Issue security schemes" ], "deprecated" : false, "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true, "name" : "id", "description" : "The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs." } ], "x-atlassian-connect-scope" : "PROJECT_ADMIN", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueSecuritySchemeResource.getIssueSecurityScheme_get", "summary" : "Get issue security scheme", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000\",\"id\":10000,\"name\":\"Default Issue Security Scheme\",\"description\":\"Description for the default issue security scheme\",\"defaultSecurityLevelId\":10021,\"levels\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/securitylevel/10021\",\"id\":\"10021\",\"description\":\"Only the reporter and internal staff can see this issue.\",\"name\":\"Reporter Only\"}]}", "schema" : { "$ref" : "#/components/schemas/SecurityScheme" } } } }, "403" : { "description" : "Returned if the user does not have the administrator permission and the scheme is not used in any project where the user has administrative permission." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "manage:jira-project" ] }, {} ], "description" : "Returns an issue security scheme along with its security levels.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).\n * *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for a project that uses the requested issue security scheme." } }, "/api/3/comment/{commentId}/properties/{propertyKey}" : { "put" : { "requestBody" : { "content" : { "application/json" : { "schema" : {} } }, "required" : true }, "x-atlassian-connect-scope" : "WRITE", "deprecated" : false, "parameters" : [ { "name" : "commentId", "description" : "The ID of the comment.", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "propertyKey", "description" : "The key of the property. The maximum length is 255 characters.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "tags" : [ "Issue comment properties" ], "summary" : "Set comment property", "operationId" : "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.setCommentProperty_put", "description" : "Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.\n\nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.\n\n**[Permissions](#permissions) required:** either of:\n\n * *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to create or update the value of a property on any comment.\n * *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to create or update the value of a property on a comment created by the user.\n\nAlso, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "responses" : { "200" : { "description" : "Returned if the comment property is updated.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the comment is not found." }, "201" : { "description" : "Returned if the comment property is created.", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." } } }, "delete" : { "tags" : [ "Issue comment properties" ], "deprecated" : false, "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the comment.", "name" : "commentId" }, { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The key of the property.", "name" : "propertyKey" } ], "x-atlassian-connect-scope" : "DELETE", "operationId" : "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.deleteCommentProperty_delete", "summary" : "Delete comment property", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if the comment or the property is not found or the user has the necessary project permissions but isn't a member of the role or group visibility of the comment is restricted to." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user does not have the required project permissions." }, "400" : { "description" : "Returned if the request is invalid." } }, "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "description" : "Deletes a comment property.\n\n**[Permissions](#permissions) required:** either of:\n\n * *Edit All Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from any comment.\n * *Edit Own Comments* [project permission](https://confluence.atlassian.com/x/yodKLg) to delete a property from a comment created by the user.\n\nAlso, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group." }, "get" : { "summary" : "Get comment property", "operationId" : "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.getCommentProperty_get", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EntityProperty" }, "example" : "{\"key\":\"issue.support\",\"value\":{\"system.conversation.id\":\"b1bf38be-5e94-4b40-a3b8-9278735ee1e6\",\"system.support.time\":\"1m\"}}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the comment or the property is not found." }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user does not have the required permissions." } }, "description" : "Returns the value of a comment property.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n * If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "tags" : [ "Issue comment properties" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "required" : true, "in" : "path", "schema" : { "type" : "string" }, "description" : "The ID of the comment.", "name" : "commentId" }, { "name" : "propertyKey", "description" : "The key of the property.", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "deprecated" : false } }, "/api/3/workflowscheme/{id}/workflow" : { "get" : { "summary" : "Get issue types for workflows in workflow scheme", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getWorkflow_get", "description" : "Returns the workflow-issue type mappings for a workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "security" : [ { "basicAuth" : [] } ], "responses" : { "404" : { "description" : "Returned if either the workflow scheme or workflow is not found." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypesWorkflowMapping" }, "example" : "{\"workflow\":\"jira\",\"issueTypes\":[\"10000\",\"10001\"],\"defaultMapping\":false}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user is not permitted to access workflows." } }, "x-atlassian-connect-scope" : "INACCESSIBLE", "parameters" : [ { "name" : "id", "description" : "The ID of the workflow scheme.", "schema" : { "type" : "integer", "format" : "int64" }, "in" : "path", "required" : true }, { "in" : "query", "schema" : { "type" : "string" }, "name" : "workflowName", "description" : "The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow." }, { "in" : "query", "schema" : { "default" : false, "type" : "boolean" }, "name" : "returnDraftIfExists", "description" : "Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned." } ], "deprecated" : false, "tags" : [ "Workflow schemes" ] }, "delete" : { "security" : [ { "basicAuth" : [] } ], "description" : "Deletes the workflow-issue type mapping for a workflow in a workflow scheme.\n\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "400" : { "description" : "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is not true." }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow is not found.\n * The workflow is not specified." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteWorkflowMapping_delete", "summary" : "Delete issue types for workflow in workflow scheme", "parameters" : [ { "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path", "description" : "The ID of the workflow scheme.", "name" : "id" }, { "in" : "query", "required" : true, "schema" : { "type" : "string" }, "name" : "workflowName", "description" : "The name of the workflow." }, { "description" : "Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to `false`.", "name" : "updateDraftIfNeeded", "in" : "query", "schema" : { "type" : "boolean" } } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow schemes" ] }, "put" : { "security" : [ { "basicAuth" : [] } ], "description" : "Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.\n\nNote that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "404" : { "description" : "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow is not found.\n * The workflow is not specified." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":101010,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"jira\",\"issueTypeMappings\":{\"10000\":\"scrum workflow\",\"10001\":\"builds workflow\"},\"draft\":false,\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/101010\"}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if the request is invalid." }, "403" : { "description" : "Returned if the user is not permitted to modify workflows." } }, "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.updateWorkflowMapping_put", "summary" : "Set issue types for workflow in workflow scheme", "parameters" : [ { "description" : "The ID of the workflow scheme.", "name" : "id", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" }, { "schema" : { "type" : "string" }, "in" : "query", "required" : true, "name" : "workflowName", "description" : "The name of the workflow." } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow schemes" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IssueTypesWorkflowMapping" }, "example" : { "issueTypes" : [ "10000" ], "workflow" : "jira", "updateDraftIfNeeded" : true } } }, "required" : true } } }, "/api/3/jql/autocompletedata" : { "get" : { "deprecated" : false, "parameters" : [], "x-atlassian-connect-scope" : "READ", "tags" : [ "JQL" ], "operationId" : "com.atlassian.jira.rest.v2.search.SearchAutoCompleteResource.getAutoComplete_get", "summary" : "Get field reference data", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "description" : "Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** None.", "responses" : { "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"visibleFieldNames\":[{\"value\":\"summary\",\"displayName\":\"summary\",\"orderable\":\"true\",\"searchable\":\"true\",\"operators\":[\"~\",\"!~\",\"is\",\"is not\"],\"types\":[\"java.lang.String\"]},{\"value\":\"Sprint\",\"displayName\":\"Sprint - cf[10880]\",\"orderable\":\"true\",\"searchable\":\"true\",\"auto\":\"true\",\"cfid\":\"cf[10880]\",\"operators\":[\"=\",\"!=\",\"in\",\"not in\",\"is\",\"is not\"],\"types\":[\"com.atlassian.greenhopper.service.sprint.Sprint\"]}],\"visibleFunctionNames\":[{\"value\":\"standardIssueTypes()\",\"displayName\":\"standardIssueTypes()\",\"isList\":\"true\",\"types\":[\"com.atlassian.jira.issue.issuetype.IssueType\"]}],\"jqlReservedWords\":[\"empty\",\"and\",\"or\",\"in\",\"distinct\"]}", "schema" : { "$ref" : "#/components/schemas/JQLReferenceData" } } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect." } } } }, "/api/3/project/{projectIdOrKey}/properties" : { "get" : { "summary" : "Get project property keys", "operationId" : "com.atlassian.jira.rest.v2.issue.ProjectPropertyResource.getProjectPropertyKeys_get", "description" : "Returns all [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys for the project.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the project is not found." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PropertyKeys" }, "example" : "{\"keys\":[{\"self\":\"http://your-domain.atlassian.net/jira/rest/api/3/issue/EX-2/properties/issue.support\",\"key\":\"issue.support\"}]}" } }, "description" : "Returned if the request is successful." }, "401" : { "description" : "Returned if the authentication credentials are incorrect." }, "400" : { "description" : "Returned if the request is not valid." }, "403" : { "description" : "Returned if the user does not have permission to view the project." } }, "x-atlassian-connect-scope" : "READ", "parameters" : [ { "in" : "path", "required" : true, "schema" : { "type" : "string" }, "name" : "projectIdOrKey", "description" : "The project ID or project key (case sensitive)." } ], "deprecated" : false, "tags" : [ "Project properties" ] } }, "/api/3/statuscategory/{idOrKey}" : { "get" : { "tags" : [ "Workflow status categories" ], "x-atlassian-connect-scope" : "READ", "parameters" : [ { "name" : "idOrKey", "description" : "The ID or key of the status category.", "schema" : { "type" : "string" }, "in" : "path", "required" : true } ], "deprecated" : false, "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StatusCategory" }, "example" : "{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}" } }, "description" : "Returned if the request is successful." }, "404" : { "description" : "Returned if the status category is not found." } }, "description" : "Returns a status category. Status categories provided a mechanism for categorizing [statuses](#api-rest-api-3-status-idOrName-get).\n\n**[Permissions](#permissions) required:** Permission to access Jira.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "summary" : "Get status category", "operationId" : "com.atlassian.jira.rest.v2.issue.StatusCategoryResource.getStatusCategory_get" } }, "/api/3/users/search" : { "get" : { "parameters" : [ { "schema" : { "default" : 0, "format" : "int32", "type" : "integer" }, "in" : "query", "name" : "startAt", "description" : "The index of the first item to return." }, { "description" : "The maximum number of items to return.", "name" : "maxResults", "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "in" : "query" } ], "deprecated" : false, "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Users" ], "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-user" ] }, {} ], "description" : "Returns a list of all (active and inactive) users.\n\n**[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } }, "example" : "[{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5\",\"key\":\"\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/AA-3.png?size=32&s=32\"},\"displayName\":\"Emma Richards\",\"active\":false}]" } }, "description" : "Returned if the request is successful." }, "409" : { "description" : "Returned if the request takes longer than 10 seconds or is interrupted." }, "403" : { "description" : "Returned if the user doesn't have the required permission." }, "400" : { "description" : "Returned if the request is invalid." } }, "operationId" : "com.atlassian.jira.rest.v2.issue.UsersResource.getAllUsers_get", "summary" : "Get all users" } }, "/api/3/issue/{issueIdOrKey}/transitions" : { "post" : { "responses" : { "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "400" : { "description" : "Returned if:\n\n * no transition is specified.\n * the user does not have permission to transition the issue.\n * a field that isn't included on the transition screen is defined in `fields` or `update`.\n * a field is specified in both `fields` and `update`.\n * the request is invalid for any other reason." }, "204" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "description" : "Returned if the request is successful." } }, "description" : "Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.\n\nTo update the fields on the transition screen, specify the fields in the `fields` or `update` parameters in the request body. Get details about the fields using [ Get transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the `transitions.fields` expand.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required:**\n\n * *Browse projects* and *Transition issues* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "write:jira-work" ] }, {} ], "summary" : "Transition issue", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.doTransition_post", "tags" : [ "Issues" ], "x-atlassian-connect-scope" : "WRITE", "parameters" : [ { "schema" : { "type" : "string" }, "required" : true, "in" : "path", "description" : "The ID or key of the issue.", "name" : "issueIdOrKey" } ], "deprecated" : false, "requestBody" : { "required" : true, "content" : { "application/json" : { "example" : { "transition" : { "id" : "5" }, "historyMetadata" : { "activityDescription" : "Complete order processing", "generator" : { "type" : "mysystem-application", "id" : "mysystem-1" }, "type" : "myplugin:type", "cause" : { "type" : "mysystem-event", "id" : "myevent" }, "description" : "From the order testing process", "extraData" : { "Step" : "4", "Iteration" : "10a" }, "actor" : { "id" : "tony", "displayName" : "Tony", "avatarUrl" : "http://mysystem/avatar/tony.jpg", "type" : "mysystem-user", "url" : "http://mysystem/users/tony" } }, "update" : { "comment" : [ { "add" : { "body" : { "type" : "doc", "content" : [ { "type" : "paragraph", "content" : [ { "type" : "text", "text" : "Bug has been fixed" } ] } ], "version" : 1 } } } ] }, "fields" : { "resolution" : { "name" : "Fixed" }, "assignee" : { "name" : "bob" } } }, "schema" : { "$ref" : "#/components/schemas/IssueUpdateDetails" } } } } }, "get" : { "x-atlassian-connect-scope" : "READ", "deprecated" : false, "parameters" : [ { "schema" : { "type" : "string" }, "in" : "path", "required" : true, "name" : "issueIdOrKey", "description" : "The ID or key of the issue." }, { "name" : "expand", "description" : "Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts `transitions.fields` which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the `fields` and `update` fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post).", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "transitionId", "description" : "The ID of the transition.", "in" : "query", "schema" : { "type" : "string" } }, { "in" : "query", "schema" : { "type" : "boolean", "default" : false }, "name" : "skipRemoteOnlyCondition", "description" : "Indicates whether transitions with the condition *Hide From User Condition* are included in the response." } ], "tags" : [ "Issues" ], "summary" : "Get transitions", "operationId" : "com.atlassian.jira.rest.v2.issue.IssueResource.getTransitions_get", "description" : "Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.\n\nNote, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required: A list or transition is returned only when the user has:**\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.\n\nHowever, if the user does not have the *Transition issues* [ project permission](https://confluence.atlassian.com/x/yodKLg) the response will not list any transitions.", "security" : [ { "basicAuth" : [] }, { "OAuth2" : [ "read:jira-work" ] }, {} ], "responses" : { "404" : { "description" : "Returned if the issue is not found or the user does not have permission to view it." }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "example" : "{\"transitions\":[{\"id\":\"2\",\"name\":\"Close Issue\",\"to\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},\"hasScreen\":false,\"isGlobal\":false,\"isInitial\":false,\"isConditional\":false,\"fields\":{\"summary\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"}}},{\"id\":\"711\",\"name\":\"QA Review\",\"to\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"http://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}},\"hasScreen\":true,\"fields\":{\"summary\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"},\"colour\":{\"required\":false,\"schema\":{\"type\":\"array\",\"items\":\"option\",\"custom\":\"com.atlassian.jira.plugin.system.customfieldtypes:multiselect\",\"customId\":10001},\"name\":\"My Multi Select\",\"key\":\"field_key\",\"hasDefaultValue\":false,\"operations\":[\"set\",\"add\"],\"allowedValues\":[\"red\",\"blue\"],\"defaultValue\":\"red\"}}}]}", "schema" : { "$ref" : "#/components/schemas/Transitions" } } } } } } }, "/api/3/workflowscheme/{id}/draft" : { "delete" : { "deprecated" : false, "parameters" : [ { "schema" : { "type" : "integer", "format" : "int64" }, "required" : true, "in" : "path", "description" : "The ID of the active workflow scheme that the draft was created from.", "name" : "id" } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow scheme drafts" ], "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.deleteWorkflowSchemeDraft_delete", "summary" : "Delete draft workflow scheme", "security" : [ { "basicAuth" : [] } ], "description" : "Deletes a draft workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "404" : { "description" : "Returned if:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft." }, "204" : { "description" : "Returned if the request is successful." }, "403" : { "description" : "Returned if the user is not permitted to manage workflow schemes." } } }, "get" : { "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.getWorkflowSchemeDraft_get", "summary" : "Get draft workflow scheme", "security" : [ { "basicAuth" : [] } ], "description" : "Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information. \nNote that:\n\n * Only active workflow schemes can have draft workflow schemes.\n * An active workflow scheme can only have one draft workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "responses" : { "404" : { "description" : "Returned if:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}" } } }, "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "403" : { "description" : "Returned if the user is not permitted to create workflow schemes." } }, "deprecated" : false, "parameters" : [ { "description" : "The ID of the active workflow scheme that the draft was created from.", "name" : "id", "schema" : { "format" : "int64", "type" : "integer" }, "required" : true, "in" : "path" } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "tags" : [ "Workflow scheme drafts" ] }, "put" : { "tags" : [ "Workflow scheme drafts" ], "deprecated" : false, "parameters" : [ { "name" : "id", "description" : "The ID of the active workflow scheme that the draft was created from.", "in" : "path", "required" : true, "schema" : { "format" : "int64", "type" : "integer" } } ], "x-atlassian-connect-scope" : "INACCESSIBLE", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : { "updateDraftIfNeeded" : false, "defaultWorkflow" : "jira", "issueTypeMappings" : { "10000" : "scrum workflow" }, "description" : "The description of the example workflow scheme.", "name" : "Example workflow scheme" } } }, "required" : true }, "responses" : { "401" : { "description" : "Returned if the authentication credentials are incorrect or missing." }, "200" : { "description" : "Returned if the request is successful.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowScheme" }, "example" : "{\"id\":17218781,\"name\":\"Example workflow scheme\",\"description\":\"The description of the example workflow scheme.\",\"defaultWorkflow\":\"scrum workflow\",\"issueTypeMappings\":{\"10000\":\"jira\",\"10001\":\"jira\"},\"originalDefaultWorkflow\":\"jira\",\"originalIssueTypeMappings\":{\"10001\":\"builds workflow\"},\"draft\":true,\"lastModifiedUser\":{\"self\":\"http://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"name\":\"\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"groups\":{\"size\":3,\"items\":[]},\"applicationRoles\":{\"size\":1,\"items\":[]}},\"lastModified\":\"Today 6:38 PM\",\"self\":\"http://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft\"}" } } }, "404" : { "description" : "Returned if:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft." }, "403" : { "description" : "Returned if the user is not permitted to create workflow schemes." }, "400" : { "description" : "Returned if the request is invalid." } }, "security" : [ { "basicAuth" : [] } ], "description" : "Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId" : "com.atlassian.jira.rest.v2.admin.workflowscheme.WorkflowSchemeResource.updateWorkflowSchemeDraft_put", "summary" : "Update draft workflow scheme" } } } }