Last active
December 12, 2019 15:42
-
-
Save ravishchawla/3ee42fb73878dd36bf30b210b6680f36 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi":"3.0.1", | |
| "info":{ | |
| "title":"The Jira Cloud platform REST API", | |
| "description":"Jira Cloud platform REST API documentation", | |
| "termsOfService":"http://atlassian.com/terms/", | |
| "contact":{ | |
| "email":"ecosystem@atlassian.com" | |
| }, | |
| "license":{ | |
| "name":"Apache 2.0", | |
| "url":"http://www.apache.org/licenses/LICENSE-2.0.html" | |
| }, | |
| "version":"1001.0.0-SNAPSHOT" | |
| }, | |
| "externalDocs":{ | |
| "description":"Find out more about Atlassian products and services.", | |
| "url":"http://www.atlassian.com" | |
| }, | |
| "servers":[ | |
| { | |
| "url":"" | |
| } | |
| ], | |
| "tags":[ | |
| { | |
| "name":"Users", | |
| "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":"User search", | |
| "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. The endpoints return a maximum of only `1000` users. If you want to get a list of all users please use the [/rest/api/3/users/search](#api-rest-api-3-users-search-get) endpoint instead." | |
| } | |
| ], | |
| "paths":{ | |
| "/rest/api/2/user/search":{ | |
| "get":{ | |
| "tags":[ | |
| "User search" | |
| ], | |
| "summary":"Find users", | |
| "description":"Returns a list of users that match the search string and property.\n\nThis operation takes the users in the range defined by `startAt` and `maxResults`, up to the thousandth user, and then returns only the users from that range that match the search string and property. This means the operation usually returns fewer users than specified in `maxResults`. To get a larger number of users, use [Get all users](#api-rest-api-2-users-search-get) and filter the records in your code.\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.", | |
| "operationId":"com.atlassian.jira.rest.v2.issue.UserResource.findUsers_get", | |
| "parameters":[ | |
| { | |
| "name":"query", | |
| "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.", | |
| "schema":{ | |
| "type":"string", | |
| "example":"query" | |
| }, | |
| "x-showInExample":"true" | |
| }, | |
| { | |
| "name":"username", | |
| "in":"query", | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"accountId", | |
| "in":"query", | |
| "description":"A query string that is matched exactly against a user `accountId`. Required, unless `query` or `property` is specified.", | |
| "schema":{ | |
| "maxLength":128, | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"startAt", | |
| "in":"query", | |
| "description":"The index of the first item to return in a page of results (page offset).", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":0 | |
| } | |
| }, | |
| { | |
| "name":"maxResults", | |
| "in":"query", | |
| "description":"The maximum number of items to return per page. The maximum is `1000`.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":50 | |
| } | |
| }, | |
| { | |
| "name":"property", | |
| "in":"query", | |
| "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` is specified.", | |
| "schema":{ | |
| "type":"string" | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"Returned if the request is successful.", | |
| "content":{ | |
| "application/json":{ | |
| "schema":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/components/schemas/User" | |
| } | |
| }, | |
| "example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/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\":\"https://your-domain.atlassian.net/rest/api/2/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}]" | |
| } | |
| } | |
| }, | |
| "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." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-user" | |
| ] | |
| }, | |
| { | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"READ" | |
| } | |
| }, | |
| "/rest/api/2/user/search/query":{ | |
| "get":{ | |
| "tags":[ | |
| "User search" | |
| ], | |
| "summary":"Find users by query", | |
| "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\"`", | |
| "operationId":"com.atlassian.jira.rest.v2.search.UserSearchResource.findUsersByQuery_get", | |
| "parameters":[ | |
| { | |
| "name":"query", | |
| "in":"query", | |
| "description":"The search query.", | |
| "required":true, | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"startAt", | |
| "in":"query", | |
| "description":"The index of the first item to return in a page of results (page offset).", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int64", | |
| "default":0 | |
| } | |
| }, | |
| { | |
| "name":"maxResults", | |
| "in":"query", | |
| "description":"The maximum number of items to return per page. The maximum is `1000`.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":100 | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"Returned if the request is successful.", | |
| "content":{ | |
| "application/json":{ | |
| "schema":{ | |
| "$ref":"#/components/schemas/PageBeanUser" | |
| } | |
| } | |
| } | |
| }, | |
| "400":{ | |
| "description":"Returned if the query is invalid." | |
| }, | |
| "401":{ | |
| "description":"Returned if the authentication credentials are incorrect or missing." | |
| }, | |
| "403":{ | |
| "description":"Returned if the user does not have the necessary permission." | |
| }, | |
| "408":{ | |
| "description":"Returned if the search is timed out." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-user" | |
| ] | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"READ" | |
| } | |
| }, | |
| "/rest/api/2/user/search/query/key":{ | |
| "get":{ | |
| "tags":[ | |
| "User search" | |
| ], | |
| "summary":"Find user keys by query", | |
| "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\"`", | |
| "operationId":"com.atlassian.jira.rest.v2.search.UserSearchResource.findUserKeysByQuery_get", | |
| "parameters":[ | |
| { | |
| "name":"query", | |
| "in":"query", | |
| "description":"The search query.", | |
| "required":true, | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"startAt", | |
| "in":"query", | |
| "description":"The index of the first item to return in a page of results (page offset).", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int64", | |
| "default":0 | |
| } | |
| }, | |
| { | |
| "name":"maxResults", | |
| "in":"query", | |
| "description":"The maximum number of items to return per page. The maximum is `1000`.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":100 | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"Returned if the request is successful.", | |
| "content":{ | |
| "application/json":{ | |
| "schema":{ | |
| "$ref":"#/components/schemas/PageBeanUserKey" | |
| } | |
| } | |
| } | |
| }, | |
| "400":{ | |
| "description":"Returned if the query is invalid." | |
| }, | |
| "401":{ | |
| "description":"Returned if the authentication credentials are incorrect or missing." | |
| }, | |
| "403":{ | |
| "description":"Returned if the user does not have the necessary permission." | |
| }, | |
| "408":{ | |
| "description":"Returned if the search is timed out." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-user" | |
| ] | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"READ" | |
| } | |
| }, | |
| "/rest/api/2/user/viewissue/search":{ | |
| "get":{ | |
| "tags":[ | |
| "User search" | |
| ], | |
| "summary":"Find users with browse permission", | |
| "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.", | |
| "operationId":"com.atlassian.jira.rest.v2.issue.UserResource.findUsersWithBrowsePermission_get", | |
| "parameters":[ | |
| { | |
| "name":"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 `accountId` is specified.", | |
| "schema":{ | |
| "type":"string", | |
| "example":"query" | |
| }, | |
| "x-showInExample":"true" | |
| }, | |
| { | |
| "name":"username", | |
| "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.", | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"accountId", | |
| "in":"query", | |
| "description":"A query string that is matched exactly against user `accountId`. Required, unless `query` is specified.", | |
| "schema":{ | |
| "maxLength":128, | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"issueKey", | |
| "in":"query", | |
| "description":"The issue key for the issue. Required, unless `projectKey` is specified.", | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"projectKey", | |
| "in":"query", | |
| "description":"The project key for the project (case sensitive). Required, unless `issueKey` is specified.", | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"startAt", | |
| "in":"query", | |
| "description":"The index of the first item to return in a page of results (page offset).", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":0 | |
| } | |
| }, | |
| { | |
| "name":"maxResults", | |
| "in":"query", | |
| "description":"The maximum number of items to return per page. The maximum is `1000`.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":50 | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"Returned if the request is successful.", | |
| "content":{ | |
| "application/json":{ | |
| "schema":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/components/schemas/User" | |
| } | |
| }, | |
| "example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/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\":\"https://your-domain.atlassian.net/rest/api/2/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}]" | |
| } | |
| } | |
| }, | |
| "400":{ | |
| "description":"Returned if:\n\n * `issueKey` or `projectKey` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided." | |
| }, | |
| "401":{ | |
| "description":"Returned if the authentication credentials are incorrect or missing." | |
| }, | |
| "404":{ | |
| "description":"Returned if the issue or project is not found." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-user" | |
| ] | |
| }, | |
| { | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"READ" | |
| } | |
| }, | |
| "/rest/api/2/users/search":{ | |
| "get":{ | |
| "tags":[ | |
| "Users" | |
| ], | |
| "summary":"Get all users", | |
| "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).", | |
| "operationId":"com.atlassian.jira.rest.v2.issue.UsersResource.getAllUsers_get", | |
| "parameters":[ | |
| { | |
| "name":"startAt", | |
| "in":"query", | |
| "description":"The index of the first item to return.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":0 | |
| } | |
| }, | |
| { | |
| "name":"maxResults", | |
| "in":"query", | |
| "description":"The maximum number of items to return.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":50 | |
| } | |
| } | |
| ], | |
| "responses":{ | |
| "200":{ | |
| "description":"Returned if the request is successful.", | |
| "content":{ | |
| "application/json":{ | |
| "schema":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/components/schemas/User" | |
| } | |
| }, | |
| "example":"[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/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\":\"https://your-domain.atlassian.net/rest/api/2/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}]" | |
| } | |
| } | |
| }, | |
| "400":{ | |
| "description":"Returned if the request is invalid." | |
| }, | |
| "403":{ | |
| "description":"Returned if the user doesn't have the required permission." | |
| }, | |
| "409":{ | |
| "description":"Returned if the request takes longer than 10 seconds or is interrupted." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-user" | |
| ] | |
| }, | |
| { | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"INACCESSIBLE" | |
| } | |
| }, | |
| "/rest/api/2/search":{ | |
| "get":{ | |
| "tags":[ | |
| "Issue search" | |
| ], | |
| "summary":"Search for issues using JQL (GET)", | |
| "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-2-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.", | |
| "operationId":"com.atlassian.jira.rest.v2.search.SearchResource.searchForIssuesUsingJql_get", | |
| "parameters":[ | |
| { | |
| "name":"jql", | |
| "in":"query", | |
| "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.", | |
| "schema":{ | |
| "type":"string", | |
| "example":"project = HSP" | |
| }, | |
| "x-showInExample":"true" | |
| }, | |
| { | |
| "name":"startAt", | |
| "in":"query", | |
| "description":"The index of the first item to return in a page of results (page offset).", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":0 | |
| } | |
| }, | |
| { | |
| "name":"maxResults", | |
| "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.", | |
| "schema":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "default":50 | |
| } | |
| }, | |
| { | |
| "name":"validateQuery", | |
| "in":"query", | |
| "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":"string", | |
| "enum":[ | |
| "strict", | |
| "warn", | |
| "none", | |
| "true", | |
| "false" | |
| ], | |
| "default":"strict" | |
| } | |
| }, | |
| { | |
| "name":"fields", | |
| "in":"query", | |
| "description":"A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:\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-2-issue-issueIdOrKey-get) where the default is all fields.", | |
| "schema":{ | |
| "type":"array", | |
| "items":{ | |
| "type":"string", | |
| "default":"*navigable" | |
| } | |
| } | |
| }, | |
| { | |
| "name":"expand", | |
| "in":"query", | |
| "description":"Use [expand](#expansion) to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:\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.", | |
| "schema":{ | |
| "type":"string" | |
| } | |
| }, | |
| { | |
| "name":"properties", | |
| "in":"query", | |
| "description":"A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, `properties=prop1,prop2&properties=prop3`. A maximum of 5 issue property keys can be specified.", | |
| "schema":{ | |
| "type":"array", | |
| "items":{ | |
| "type":"string" | |
| } | |
| } | |
| }, | |
| { | |
| "name":"fieldsByKeys", | |
| "in":"query", | |
| "description":"Reference fields by their key (rather than ID).", | |
| "schema":{ | |
| "type":"boolean", | |
| "default":false | |
| } | |
| } | |
| ], | |
| "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\":\"https://your-domain.atlassian.net/rest/api/2/issue/10002\",\"key\":\"ED-1\",\"fields\":{\"watcher\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10001,\"self\":\"https://your-domain.atlassian.net/rest/api/2/attachments/10001\",\"filename\":\"debuglog.txt\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/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-12-03T06:07:44.437+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10001\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10002\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"ED-2\",\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/ED-2\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":\"Main order flow broken\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2019-12-03T06:07:42.175+0000\"}},\"comment\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":\"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/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-12-03T06:07:42.905+0000\",\"updated\":\"2019-12-03T06:07:42.905+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\":\"https://your-domain.atlassian.net/rest/api/2/issue/PR-2\",\"fields\":{\"status\":{\"iconUrl\":\"https://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\":\"https://your-domain.atlassian.net/rest/api/2/issue/PR-3\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":\"I did some work here.\",\"updated\":\"2019-12-03T06:07:43.334+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-12-03T06:07:43.334+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'.\"]}" | |
| } | |
| } | |
| }, | |
| "400":{ | |
| "description":"Returned if the JQL query is invalid." | |
| }, | |
| "401":{ | |
| "description":"Returned if the authentication credentials are incorrect or missing." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-work" | |
| ] | |
| }, | |
| { | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"READ" | |
| }, | |
| "post":{ | |
| "tags":[ | |
| "Issue search" | |
| ], | |
| "summary":"Search for issues using JQL (POST)", | |
| "description":"Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).\n\nThere is a [GET](#api-rest-api-2-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.", | |
| "operationId":"com.atlassian.jira.rest.v2.search.SearchResource.searchForIssuesUsingJql_post", | |
| "parameters":[ | |
| ], | |
| "requestBody":{ | |
| "description":"A JSON object containing the search request.", | |
| "content":{ | |
| "application/json":{ | |
| "schema":{ | |
| "$ref":"#/components/schemas/SearchRequestBean" | |
| }, | |
| "example":{ | |
| "expand":[ | |
| "names", | |
| "schema", | |
| "operations" | |
| ], | |
| "jql":"project = HSP", | |
| "maxResults":15, | |
| "fieldsByKeys":false, | |
| "fields":[ | |
| "summary", | |
| "status", | |
| "assignee" | |
| ], | |
| "startAt":0 | |
| } | |
| } | |
| }, | |
| "required":true | |
| }, | |
| "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\":\"https://your-domain.atlassian.net/rest/api/2/issue/10002\",\"key\":\"ED-1\",\"fields\":{\"watcher\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/EX-1/watchers\",\"isWatching\":false,\"watchCount\":1,\"watchers\":[{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false}]},\"attachment\":[{\"id\":10001,\"self\":\"https://your-domain.atlassian.net/rest/api/2/attachments/10001\",\"filename\":\"debuglog.txt\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/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-12-03T06:07:44.437+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"https://your-domain.atlassian.net/jira/attachments/10001\",\"thumbnail\":\"https://your-domain.atlassian.net/jira/secure/thumbnail/10002\"}],\"sub-tasks\":[{\"id\":\"10000\",\"type\":{\"id\":\"10000\",\"name\":\"\",\"inward\":\"Parent\",\"outward\":\"Sub-task\"},\"outwardIssue\":{\"id\":\"10003\",\"key\":\"ED-2\",\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/ED-2\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"description\":\"Main order flow broken\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/2/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2019-12-03T06:07:42.175+0000\"}},\"comment\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/10010/comment/10000\",\"id\":\"10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"body\":\"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/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"created\":\"2019-12-03T06:07:42.905+0000\",\"updated\":\"2019-12-03T06:07:42.905+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\":\"https://your-domain.atlassian.net/rest/api/2/issue/PR-2\",\"fields\":{\"status\":{\"iconUrl\":\"https://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\":\"https://your-domain.atlassian.net/rest/api/2/issue/PR-3\",\"fields\":{\"status\":{\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/statuses/open.png\",\"name\":\"Open\"}}}}],\"worklog\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/2/issue/10010/worklog/10000\",\"author\":{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"updateAuthor\":{\"self\":\"http://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"displayName\":\"Mia Krystof\",\"active\":false},\"comment\":\"I did some work here.\",\"updated\":\"2019-12-03T06:07:43.334+0000\",\"visibility\":{\"type\":\"group\",\"value\":\"jira-developers\"},\"started\":\"2019-12-03T06:07:43.334+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'.\"]}" | |
| } | |
| } | |
| }, | |
| "400":{ | |
| "description":"Returned if the JQL query is invalid." | |
| }, | |
| "401":{ | |
| "description":"Returned if the authentication credentials are incorrect or missing." | |
| } | |
| }, | |
| "deprecated":false, | |
| "security":[ | |
| { | |
| "basicAuth":[ | |
| ] | |
| }, | |
| { | |
| "OAuth2":[ | |
| "read:jira-work" | |
| ] | |
| }, | |
| { | |
| } | |
| ], | |
| "x-atlassian-connect-scope":"READ" | |
| } | |
| } | |
| }, | |
| "components":{ | |
| "schemas": { | |
| "User":{ | |
| "type":"object", | |
| "properties":{ | |
| "self":{ | |
| "type":"string", | |
| "description":"The URL of the user.", | |
| "format":"uri", | |
| "readOnly":true | |
| }, | |
| "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." | |
| }, | |
| "accountId":{ | |
| "maxLength":128, | |
| "type":"string", | |
| "description":"The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests." | |
| }, | |
| "accountType":{ | |
| "type":"string", | |
| "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, | |
| "enum":[ | |
| "atlassian", | |
| "app", | |
| "customer", | |
| "unknown" | |
| ] | |
| }, | |
| "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." | |
| }, | |
| "emailAddress":{ | |
| "type":"string", | |
| "description":"The email address of the user. Depending on the user’s privacy setting, this may be returned as null.", | |
| "readOnly":true | |
| }, | |
| "avatarUrls":{ | |
| "description":"The avatars of the user.", | |
| "readOnly":true, | |
| "allOf":[ | |
| { | |
| "$ref":"#/components/schemas/AvatarUrlsBean" | |
| } | |
| ] | |
| }, | |
| "displayName":{ | |
| "type":"string", | |
| "description":"The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.", | |
| "readOnly":true | |
| }, | |
| "active":{ | |
| "type":"boolean", | |
| "description":"Indicates whether the user is active.", | |
| "readOnly":true | |
| }, | |
| "timeZone":{ | |
| "type":"string", | |
| "description":"The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.", | |
| "readOnly":true | |
| }, | |
| "locale":{ | |
| "type":"string", | |
| "description":"The locale of the user. Depending on the user’s privacy setting, this may be returned as null.", | |
| "readOnly":true | |
| }, | |
| "groups":{ | |
| "description":"The groups that the user belongs to.", | |
| "readOnly":true, | |
| "allOf":[ | |
| { | |
| "$ref":"#/components/schemas/SimpleListWrapperGroupName" | |
| } | |
| ] | |
| }, | |
| "applicationRoles":{ | |
| "description":"The application roles the user is assigned to.", | |
| "readOnly":true, | |
| "allOf":[ | |
| { | |
| "$ref":"#/components/schemas/SimpleListWrapperApplicationRole" | |
| } | |
| ] | |
| }, | |
| "expand":{ | |
| "type":"string", | |
| "description":"Expand options that include additional user details in the response.", | |
| "readOnly":true, | |
| "xml":{ | |
| "attribute":true | |
| } | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "description":"A user.", | |
| "xml":{ | |
| "name":"user" | |
| } | |
| }, | |
| "PageBeanUser":{ | |
| "type":"object", | |
| "properties":{ | |
| "self":{ | |
| "type":"string", | |
| "description":"The URL of the page.", | |
| "format":"uri", | |
| "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", | |
| "description":"The maximum number of items that could be returned.", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "startAt":{ | |
| "type":"integer", | |
| "description":"The index of the first item returned.", | |
| "format":"int64", | |
| "readOnly":true | |
| }, | |
| "total":{ | |
| "type":"integer", | |
| "description":"The number of items returned.", | |
| "format":"int64", | |
| "readOnly":true | |
| }, | |
| "isLast":{ | |
| "type":"boolean", | |
| "description":"Indicates whether this is the last page.", | |
| "readOnly":true | |
| }, | |
| "values":{ | |
| "type":"array", | |
| "description":"The list of items.", | |
| "readOnly":true, | |
| "items":{ | |
| "$ref":"#/components/schemas/User" | |
| } | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "description":"A page of items." | |
| }, | |
| "PageBeanUserKey":{ | |
| "type":"object", | |
| "properties":{ | |
| "self":{ | |
| "type":"string", | |
| "description":"The URL of the page.", | |
| "format":"uri", | |
| "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", | |
| "description":"The maximum number of items that could be returned.", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "startAt":{ | |
| "type":"integer", | |
| "description":"The index of the first item returned.", | |
| "format":"int64", | |
| "readOnly":true | |
| }, | |
| "total":{ | |
| "type":"integer", | |
| "description":"The number of items returned.", | |
| "format":"int64", | |
| "readOnly":true | |
| }, | |
| "isLast":{ | |
| "type":"boolean", | |
| "description":"Indicates whether this is the last page.", | |
| "readOnly":true | |
| }, | |
| "values":{ | |
| "type":"array", | |
| "description":"The list of items.", | |
| "readOnly":true, | |
| "items":{ | |
| "$ref":"#/components/schemas/UserKey" | |
| } | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "description":"A page of items." | |
| }, | |
| "SearchRequestBean":{ | |
| "type":"object", | |
| "properties":{ | |
| "jql":{ | |
| "type":"string", | |
| "description":"A [JQL](https://confluence.atlassian.com/x/egORLQ) expression." | |
| }, | |
| "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" | |
| }, | |
| "maxResults":{ | |
| "type":"integer", | |
| "description":"The maximum number of items to return per page. The default is `50` and the maximum is `100`.", | |
| "format":"int32" | |
| }, | |
| "fields":{ | |
| "type":"array", | |
| "description":"A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:\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-2-issue-issueIdOrKey-get) where the default is all fields.", | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "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":{ | |
| "type":"array", | |
| "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.", | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "properties":{ | |
| "type":"array", | |
| "description":"A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.", | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "fieldsByKeys":{ | |
| "type":"boolean", | |
| "description":"Reference fields by their key (rather than ID). The default is `false`." | |
| } | |
| }, | |
| "additionalProperties":false | |
| }, | |
| "SearchResults":{ | |
| "type":"object", | |
| "properties":{ | |
| "expand":{ | |
| "type":"string", | |
| "description":"Expand options that include additional search result details in the response.", | |
| "readOnly":true | |
| }, | |
| "startAt":{ | |
| "type":"integer", | |
| "description":"The index of the first item returned on the page.", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "maxResults":{ | |
| "type":"integer", | |
| "description":"The maximum number of results that could be on the page.", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "total":{ | |
| "type":"integer", | |
| "description":"The number of results on the page.", | |
| "format":"int32", | |
| "readOnly":true | |
| }, | |
| "issues":{ | |
| "type":"array", | |
| "description":"The list of issues found by the search.", | |
| "readOnly":true, | |
| "items":{ | |
| "$ref":"#/components/schemas/IssueBean" | |
| } | |
| }, | |
| "warningMessages":{ | |
| "type":"array", | |
| "description":"Any warnings related to the JQL query.", | |
| "readOnly":true, | |
| "items":{ | |
| "type":"string", | |
| "readOnly":true | |
| } | |
| }, | |
| "names":{ | |
| "type":"object", | |
| "additionalProperties":{ | |
| "type":"string", | |
| "readOnly":true | |
| }, | |
| "description":"The ID and name of each field in the search results.", | |
| "readOnly":true | |
| }, | |
| "schema":{ | |
| "type":"object", | |
| "additionalProperties":{ | |
| "$ref":"#/components/schemas/JsonTypeBean" | |
| }, | |
| "description":"The schema describing the field types in the search results.", | |
| "readOnly":true | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "description":"The result of a JQL search." | |
| }, | |
| "AvatarUrlsBean":{ | |
| "type":"object", | |
| "properties":{ | |
| "16x16":{ | |
| "type":"string", | |
| "description":"The URL of the item's 16x16 pixel avatar.", | |
| "format":"uri" | |
| }, | |
| "24x24":{ | |
| "type":"string", | |
| "description":"The URL of the item's 24x24 pixel avatar.", | |
| "format":"uri" | |
| }, | |
| "32x32":{ | |
| "type":"string", | |
| "description":"The URL of the item's 32x32 pixel avatar.", | |
| "format":"uri" | |
| }, | |
| "48x48":{ | |
| "type":"string", | |
| "description":"The URL of the item's 48x48 pixel avatar.", | |
| "format":"uri" | |
| } | |
| }, | |
| "additionalProperties":false | |
| }, | |
| "SimpleListWrapperGroupName":{ | |
| "type":"object", | |
| "properties":{ | |
| "size":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "xml":{ | |
| "attribute":true | |
| } | |
| }, | |
| "items":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/components/schemas/GroupName" | |
| } | |
| }, | |
| "pagingCallback":{ | |
| "$ref":"#/components/schemas/ListWrapperCallbackGroupName" | |
| }, | |
| "callback":{ | |
| "$ref":"#/components/schemas/ListWrapperCallbackGroupName" | |
| }, | |
| "max-results":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "xml":{ | |
| "name":"max-results", | |
| "attribute":true | |
| } | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "xml":{ | |
| "name":"list" | |
| } | |
| }, | |
| "SimpleListWrapperApplicationRole":{ | |
| "type":"object", | |
| "properties":{ | |
| "size":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "xml":{ | |
| "attribute":true | |
| } | |
| }, | |
| "items":{ | |
| "type":"array", | |
| "items":{ | |
| "$ref":"#/components/schemas/ApplicationRole" | |
| } | |
| }, | |
| "pagingCallback":{ | |
| "$ref":"#/components/schemas/ListWrapperCallbackApplicationRole" | |
| }, | |
| "callback":{ | |
| "$ref":"#/components/schemas/ListWrapperCallbackApplicationRole" | |
| }, | |
| "max-results":{ | |
| "type":"integer", | |
| "format":"int32", | |
| "xml":{ | |
| "name":"max-results", | |
| "attribute":true | |
| } | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "xml":{ | |
| "name":"list" | |
| } | |
| }, | |
| "ListWrapperCallbackApplicationRole":{ | |
| "type":"object", | |
| "additionalProperties":false | |
| }, | |
| "GroupName":{ | |
| "type":"object", | |
| "properties":{ | |
| "name":{ | |
| "type":"string", | |
| "description":"The name of group." | |
| }, | |
| "self":{ | |
| "type":"string", | |
| "description":"The URL for these group details.", | |
| "format":"uri", | |
| "readOnly":true | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "description":"Details about a group name." | |
| }, | |
| "ListWrapperCallbackGroupName":{ | |
| "type":"object", | |
| "additionalProperties":false | |
| }, | |
| "UserKey":{ | |
| "type":"object", | |
| "additionalProperties":false | |
| }, | |
| "IssueBean":{ | |
| "type":"object", | |
| "additionalProperties":false | |
| }, | |
| "JsonTypeBean":{ | |
| "type":"object", | |
| "additionalProperties":false | |
| }, | |
| "ApplicationRole":{ | |
| "type":"object", | |
| "properties":{ | |
| "key":{ | |
| "type":"string", | |
| "description":"The key of the application role." | |
| }, | |
| "groups":{ | |
| "uniqueItems":true, | |
| "type":"array", | |
| "description":"The groups associated with the application role.", | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "name":{ | |
| "type":"string", | |
| "description":"The display name of the application role." | |
| }, | |
| "defaultGroups":{ | |
| "uniqueItems":true, | |
| "type":"array", | |
| "description":"The groups that are granted default access for this application role.", | |
| "items":{ | |
| "type":"string" | |
| } | |
| }, | |
| "selectedByDefault":{ | |
| "type":"boolean", | |
| "description":"Determines whether this application role should be selected by default on user creation." | |
| }, | |
| "defined":{ | |
| "type":"boolean", | |
| "description":"Deprecated." | |
| }, | |
| "numberOfSeats":{ | |
| "type":"integer", | |
| "description":"The maximum count of users on your license.", | |
| "format":"int32" | |
| }, | |
| "remainingSeats":{ | |
| "type":"integer", | |
| "description":"The count of users remaining on your license.", | |
| "format":"int32" | |
| }, | |
| "userCount":{ | |
| "type":"integer", | |
| "description":"The number of users counting against your license.", | |
| "format":"int32" | |
| }, | |
| "userCountDescription":{ | |
| "type":"string", | |
| "description":"The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license." | |
| }, | |
| "hasUnlimitedSeats":{ | |
| "type":"boolean" | |
| }, | |
| "platform":{ | |
| "type":"boolean", | |
| "description":"Indicates if the application role belongs to Jira platform (`jira-core`)." | |
| } | |
| }, | |
| "additionalProperties":false, | |
| "description":"Details of an application role." | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment