api-stable.json

{"Get all application roles":{"name":"Get all application roles","http_method":"GET","path":"/rest/api/3/applicationrole","description":"Returns all application roles. In Jira, application roles are managed using the Application access configuration page.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/applicationrole' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"1b5aa4d03f0864a26a5bef022f5e88110e3f035f6a8f262d578da675c0694fb1"},"Get application role":{"name":"Get application role","http_method":"GET","path":"/rest/api/3/applicationrole/{key}","description":"Returns an application role.","params":[{"name":"key","type":"string","description":"The key of the application role. Use the Get all application roles operation to get the key for each application role."}],"command":"curl --request GET \\\n  --url '/rest/api/3/applicationrole/{key}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c34ab916d95c46b6b6f60e520bb7674f156c740aa897d86e50c18c60a1755309"},"Get audit records":{"name":"Get audit records","http_method":"GET","path":"/rest/api/3/auditing/record","description":"Returns a list of audit records. The list can be filtered to include items:","params":[{"name":"offset","type":"integer","description":"The number of records to skip before returning the first result.","default":"0"},{"name":"limit","type":"integer","description":"The maximum number of results to return. The maximum is 1000.","default":"1000"},{"name":"filter","type":"string","description":"The query string."},{"name":"from","type":"string","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.","default":"date-time"},{"name":"to","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.","default":"date-time"}],"command":"curl --request GET \\\n  --url '/rest/api/3/auditing/record' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"ca48eab972a77196b77b8a982e75db57b46a17e53ebbef23f1262ebac771ec8d"},"Get system avatars by type":{"name":"Get system avatars by type","http_method":"GET","path":"/rest/api/3/avatar/{type}/system","description":"Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user.","params":[{"name":"type","type":"string","description":"The avatar type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/avatar/{type}/system' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"fe72263c0cd0415feb2bb065732b71e73d46377ad7ef31f5c59ebbac7f2e72a9"},"Get avatars":{"name":"Get avatars","http_method":"GET","path":"/rest/api/3/universal_avatar/type/{type}/owner/{entityId}","description":"Returns the system and custom avatars for a project or issue type.","params":[{"name":"type","type":"string","description":"The type of the entity. Valid values are project and issuetype."},{"name":"entityId","type":"string","description":"The ID of the entity item."}],"command":"curl --request GET \\\n  --url '/rest/api/3/universal_avatar/type/{type}/owner/{entityId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"cc71665cfc1ec598f834badb5daf048524cacc2f793e4bf5d3565b215b3d0fd6"},"Load avatar":{"name":"Load avatar","http_method":"POST","path":"/rest/api/3/universal_avatar/type/{type}/owner/{entityId}","description":"Loads a custom avatar for a project or issue type.","params":[{"name":"type","type":"string","description":"The type of the entity. Valid values are project and issuetype."},{"name":"entityId","type":"string","description":"The ID of the entity item."},{"name":"x","type":"integer","description":"The X coordinate of the top-left corner of the crop region.","default":"0"},{"name":"y","type":"integer","description":"The Y coordinate of the top-left corner of the crop region.","default":"0"},{"name":"size","type":"integer","description":"The length of each side of the crop region.","default":"int32"}],"command":"curl --request POST \\\n  --url '/rest/api/3/universal_avatar/type/{type}/owner/{entityId}?size={size}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"2f16d5419313b9a669686fec3d98ac125796886a117aa4a0f86cf99294140637"},"Delete avatar":{"name":"Delete avatar","http_method":"DELETE","path":"/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}","description":"Deletes an avatar from a project or issue type.","params":[{"name":"type","type":"string","description":"The type of the entity. Valid values are project and issuetype."},{"name":"owningObjectId","type":"string","description":"The ID of the entity item."},{"name":"id","type":"integer","description":"The ID of the avatar.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"82ef312ea59988f0cd25bbd9c239067fcbe3ba238ff50e37466e2adc066ccc76"},"Get all dashboards":{"name":"Get all dashboards","http_method":"GET","path":"/rest/api/3/dashboard","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.","params":[{"name":"filter","type":"string","description":"The filter applied to the list of dashboards. Valid values are:"},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"20"}],"command":"curl --request GET \\\n  --url '/rest/api/3/dashboard' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"f6757cad3ef64761be5c28a867ece59f149eee2d20f3e066fe8eb4b79bb029a9"},"Search for dashboards":{"name":"Search for dashboards","http_method":"GET","path":"/rest/api/3/dashboard/search","description":"Searches for dashboards. This operation is similar to Get dashboards 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.","params":[{"name":"dashboardName","type":"string","description":"String used to perform a case-insensitive partial match with name."},{"name":"accountId","type":"string","description":"User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter."},{"name":"owner","type":"string","description":"This parameter is deprecated because of privacy changes. Use accountId instead. See the 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":"groupname","type":"string","description":"Group name used to returns dashboards that are shared with a group that matches sharePermissions.group.name."},{"name":"projectId","type":"integer","description":"Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.","default":"int64"},{"name":"orderBy","type":"string","description":"Orders the results using one of these dashboard properties:","default":"name"},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"50"},{"name":"expand","type":"string","description":"Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/dashboard/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b917f7f9c0fbc1d263bc1d7e59621c8d892138529531f8fcdaa666518727f9f6"},"Get dashboard item property keys":{"name":"Get dashboard item property keys","http_method":"GET","path":"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties","description":"Returns the keys of all properties for a dashboard item.","params":[{"name":"dashboardId","type":"string","description":"The ID of the dashboard."},{"name":"itemId","type":"string","description":"The ID of the dashboard item."}],"command":"curl --request GET \\\n  --url '/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"23e3e4fb1e32ea72e809ed190bbc22710cf14db6c99ea52b3e4991bfdf422c49"},"Get dashboard item property":{"name":"Get dashboard item property","http_method":"GET","path":"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}","description":"Returns the key and value of a dashboard item property.","params":[{"name":"dashboardId","type":"string","description":"The ID of the dashboard."},{"name":"itemId","type":"string","description":"The ID of the dashboard item."},{"name":"propertyKey","type":"string","description":"The key of the dashboard item property."}],"command":"curl --request GET \\\n  --url '/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e9bc073ca9aaf58b2f0ab4505a767e335c8e00e6644909271bd9956fe4497ca9"},"Set dashboard item property":{"name":"Set dashboard item property","http_method":"PUT","path":"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}","description":"Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.","params":[{"name":"dashboardId","type":"string","description":"The ID of the dashboard."},{"name":"itemId","type":"string","description":"The ID of the dashboard item."},{"name":"propertyKey","type":"string","description":"The key of the dashboard item property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{}'","digest":"b3bffa3e2e4c5b996f3cc92bddd43b503f8821ea11968f482bbcd71301aec855"},"Delete dashboard item property":{"name":"Delete dashboard item property","http_method":"DELETE","path":"/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}","description":"Deletes a dashboard item property.","params":[{"name":"dashboardId","type":"string","description":"The ID of the dashboard."},{"name":"itemId","type":"string","description":"The ID of the dashboard item."},{"name":"propertyKey","type":"string","description":"The key of the dashboard item property."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"290da40ce7dd9b58d099f23f3ea58ab832a22f1af5b4e5b05a903a85f4536b12"},"Get dashboard":{"name":"Get dashboard","http_method":"GET","path":"/rest/api/3/dashboard/{id}","description":"Returns a dashboard.","params":[{"name":"id","type":"string","description":"The ID of the dashboard."}],"command":"curl --request GET \\\n  --url '/rest/api/3/dashboard/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"17b6294042f28179826ebd28889ce7687cdb2db3b754155e5579bed6b33579ea"},"Get filters":{"name":"Get filters","http_method":"GET","path":"/rest/api/3/filter","description":"GET /rest/api/3/filter","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"6681da8b23b59ef1381676f797957c3e2fedfb37519341a0e3d605f28261d4b7"},"Create filter":{"name":"Create filter","http_method":"POST","path":"/rest/api/3/filter","description":"Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request POST \\\n  --url '/rest/api/3/filter' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"jql\": \"type = Bug and resolution is empty\",\n  \"name\": \"All Open Bugs\",\n  \"description\": \"Lists all open bugs\"\n}'","digest":"29a43c79792bef593ea39e6f669e024d8247458e99408e1bede3e2d603771774"},"Get favorite filters":{"name":"Get favorite filters","http_method":"GET","path":"/rest/api/3/filter/favourite","description":"Returns the visible favorite filters of the user.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/favourite' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"973c0ef33fd90fe2b236b29b67c0ff9a2a5149cbe9094117423f9b1649decc2b"},"Get my filters":{"name":"Get my filters","http_method":"GET","path":"/rest/api/3/filter/my","description":"Returns the filters owned by the user. If includeFavourites is true, the user's visible favorite filters are also returned.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"},{"name":"includeFavourites","type":"boolean","description":"Include the user's favorite filters in the response.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/my' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"13fc3fc8a0e0c495fbb764be1a6f8ae8644a379a9831f6ccc53e090fc0dfae97"},"Search for filters":{"name":"Search for filters","http_method":"GET","path":"/rest/api/3/filter/search","description":"Searches for filters. This operation is similar to Get filters 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.","params":[{"name":"filterName","type":"string","description":"String used to perform a case-insensitive partial match with name."},{"name":"accountId","type":"string","description":"User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner."},{"name":"owner","type":"string","description":"This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId."},{"name":"groupname","type":"string","description":"Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname."},{"name":"projectId","type":"integer","description":"Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id.","default":"int64"},{"name":"orderBy","type":"string","description":"Orders the results using one of these filter properties:","default":"name"},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"50"},{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d8d11d2039ff547a788d8299d9da32bf73b5a1d8882279129756a7572bb15601"},"Get filter":{"name":"Get filter","http_method":"GET","path":"/rest/api/3/filter/{id}","description":"Returns a filter.","params":[{"name":"id","type":"integer","description":"The ID of the filter to return.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"97a6f9be825502ff67306bf304827aec1b352c86d6e9af71c37da98f0b7c97ca"},"Update filter":{"name":"Update filter","http_method":"PUT","path":"/rest/api/3/filter/{id}","description":"Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.","params":[{"name":"id","type":"integer","description":"The ID of the filter to update.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/filter/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"jql\": \"type = Bug and resolution is empty\",\n  \"name\": \"All Open Bugs\",\n  \"description\": \"Lists all open bugs\"\n}'","digest":"325fa0018f277f337f4ab0450b86091d720dfe6e330e174ee040499e757ae2cf"},"Delete filter":{"name":"Delete filter","http_method":"DELETE","path":"/rest/api/3/filter/{id}","description":"Delete a filter.","params":[{"name":"id","type":"integer","description":"The ID of the filter to delete.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/filter/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"107f908ecbf717fe6db130cd6fab9a449380281d96e719a0088f1c87f965d8be"},"Get columns":{"name":"Get columns","http_method":"GET","path":"/rest/api/3/filter/{id}/columns","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.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/{id}/columns' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"f26efb9ce767e2be57b59833e589eb78a91158f9b24c7f48a07aa4048166d586"},"Set columns":{"name":"Set columns","http_method":"PUT","path":"/rest/api/3/filter/{id}/columns","description":"Sets the columns for a filter. Only navigable fields can be set as columns. Use Get fields to get the list fields in Jira. A navigable field has navigable set to true.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/filter/{id}/columns' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"177fbbbddac3a0ee889911c4fa145e0347e68be382dd6ca32ee736b3e50d3155"},"Reset columns":{"name":"Reset columns","http_method":"DELETE","path":"/rest/api/3/filter/{id}/columns","description":"Reset the user's column configuration for the filter to the default.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/filter/{id}/columns' \\\n  --user 'email@example.com:<api_token>'","digest":"d1dac10cf11ab8984443d8cedc7ca74445977ee4f84a77c2627f4b90c704ca0a"},"Add filter as favorite":{"name":"Add filter as favorite","http_method":"PUT","path":"/rest/api/3/filter/{id}/favourite","description":"Add a filter as a favorite for the user.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/filter/{id}/favourite' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"5486ab88373e69111803817a856eb0da62362586cb07cc8e7f4d20bd1b54e9d1"},"Remove filter as favorite":{"name":"Remove filter as favorite","http_method":"DELETE","path":"/rest/api/3/filter/{id}/favourite","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.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/filter/{id}/favourite' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"82acbb999e63365b0e888367747a69fab73490a5acb4653903ba35494d53e9d9"},"Get default share scope":{"name":"Get default share scope","http_method":"GET","path":"/rest/api/3/filter/defaultShareScope","description":"Returns the default sharing settings for new filters and dashboards for a user.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/defaultShareScope' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"8ecff787e07831b10907f590245071eba5554223a87972ce2a00258b9fad5d44"},"Set default share scope":{"name":"Set default share scope","http_method":"PUT","path":"/rest/api/3/filter/defaultShareScope","description":"Sets the default sharing for new filters and dashboards for a user.","params":[{"name":"scope","type":"string","description":"The scope of the default sharing for new filters and dashboards:"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/filter/defaultShareScope' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"scope\": \"{scope}\"\n}'","digest":"48cc669334218ce2811c6190c11a5e71fa3207db95a96297873e56917175a3e3"},"Get share permissions":{"name":"Get share permissions","http_method":"GET","path":"/rest/api/3/filter/{id}/permission","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.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/{id}/permission' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"eada9b2cf1f7610e13cec0aea5c0233fed7c5b2deda0827b095721d9489404f7"},"Add share permission":{"name":"Add share permission","http_method":"POST","path":"/rest/api/3/filter/{id}/permission","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.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/filter/{id}/permission' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"type\": \"group\",\n  \"groupname\": \"jira-administrators\"\n}'","digest":"167f83865c07bd2e18951f03bb323b7051d58a055f8ad18adabd9f32e83b90c1"},"Get share permission":{"name":"Get share permission","http_method":"GET","path":"/rest/api/3/filter/{id}/permission/{permissionId}","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.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"},{"name":"permissionId","type":"integer","description":"The ID of the share permission.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/filter/{id}/permission/{permissionId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"145e32979a771bc972d8b8f8fec0a3cd42dce95a42e4efbd93b976471ddc318a"},"Delete share permission":{"name":"Delete share permission","http_method":"DELETE","path":"/rest/api/3/filter/{id}/permission/{permissionId}","description":"Deletes a share permission from a filter.","params":[{"name":"id","type":"integer","description":"The ID of the filter.","default":"int64"},{"name":"permissionId","type":"integer","description":"The ID of the share permission.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/filter/{id}/permission/{permissionId}' \\\n  --user 'email@example.com:<api_token>'","digest":"0a9790da170112e0c6ad8cbfc37dcee898f6a68436abc2319d4981c7994ab52d"},"Find users and groups":{"name":"Find users and groups","http_method":"GET","path":"/rest/api/3/groupuserpicker","description":"Returns a list of users and groups matching a string. The string is used:","params":[{"name":"query","type":"string","description":"The search string."},{"name":"maxResults","type":"integer","description":"The maximum number of items to return in each list. The maximum is 1000.","default":"50"},{"name":"showAvatar","type":"boolean","description":"Indicates whether the user avatar should be returned. If an invalid value is provided, the default value is used.","default":"false"},{"name":"fieldId","type":"string","description":"The custom field ID of the field this request is for."},{"name":"projectId","type":"Array<string>","description":"The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present."},{"name":"issueTypeId","type":"Array<string>","description":"The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. 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":"avatarSize","type":"string","description":"The size of the avatar to return. If an invalid value is provided, the default value is used.","default":"xsmall"},{"name":"caseInsensitive","type":"boolean","description":"Indicates whether the search for groups should be case insensitive.","default":"false"},{"name":"excludeConnectAddons","type":"boolean","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.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/groupuserpicker?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b8a665bc30bf19024d76529c28b50692a5f8483c68dc6b0eb9f4f424aa245c24"},"Get group":{"name":"Get group","http_method":"GET","path":"/rest/api/3/group","description":"GET /rest/api/3/group","params":[{"name":"groupname","type":"string","description":"The name of the group."},{"name":"expand","type":"string","description":"List of fields to expand."}],"command":"curl --request GET \\\n  --url '/rest/api/3/group?groupname={groupname}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"2edfe7e781707ff4c5ab1e89676dc223ecd8472a662375d547a35155fc342436"},"Create group":{"name":"Create group","http_method":"POST","path":"/rest/api/3/group","description":"Creates a group.","params":[{"name":"name","type":"string","description":"The name of the group."},{"name":"Additional Properties","type":"anything","description":"Extra properties of any type may be provided to this object."}],"command":"curl --request POST \\\n  --url '/rest/api/3/group' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"{name}\"\n}'","digest":"66f52ea78caa92ddc1e215d029ef7a3bb6e0e4b2257e26743deb84f5128872c2"},"Remove group":{"name":"Remove group","http_method":"DELETE","path":"/rest/api/3/group","description":"Deletes a group.","params":[{"name":"groupname","type":"string","description":"The name of the group."},{"name":"swapGroup","type":"string","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."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/group?groupname={groupname}' \\\n  --user 'email@example.com:<api_token>'","digest":"3021fe15a061f478cebb69b43fee09dd40191129df611bb88ba0402be1152523"},"Get users from group":{"name":"Get users from group","http_method":"GET","path":"/rest/api/3/group/member","description":"Returns all users in a group.","params":[{"name":"groupname","type":"string","description":"The name of the group."},{"name":"includeInactiveUsers","type":"boolean","description":"Include inactive users.","default":"false"},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 50.","default":"50"}],"command":"curl --request GET \\\n  --url '/rest/api/3/group/member?groupname={groupname}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"f66944429c4f67a922581e0f024cd2832ffd48f0442399d97d252771e174775e"},"Add user to group":{"name":"Add user to group","http_method":"POST","path":"/rest/api/3/group/user","description":"Adds a user to a group.","params":[{"name":"groupname","type":"string","description":"The name of the group (case sensitive)."}],"command":"curl --request POST \\\n  --url '/rest/api/3/group/user?groupname={groupname}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"accountId\": \"5b10ac8d82e05b22cc7d4ef5\"\n}'","digest":"56c867977dc02d5fc963e12c37d0387bdb66037b3f4456190a64582daf72ef98"},"Remove user from group":{"name":"Remove user from group","http_method":"DELETE","path":"/rest/api/3/group/user","description":"Removes a user from a group.","params":[{"name":"groupname","type":"string","description":"The name of the group."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/group/user?groupname={groupname}&accountId={accountId}' \\\n  --user 'email@example.com:<api_token>'","digest":"9ba18d52e8690d63425c8697cfd0abce668a57ceb85263a2ef6898ae6d3e8a8a"},"Find groups":{"name":"Find groups","http_method":"GET","path":"/rest/api/3/groups/picker","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.","params":[{"name":"accountId","type":"string","description":"This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use Get user groups."},{"name":"query","type":"string","description":"The string to find in group names."},{"name":"exclude","type":"Array<string>","description":"A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&exclude=group2."},{"name":"maxResults","type":"integer","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.","default":"int32"},{"name":"userName","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request GET \\\n  --url '/rest/api/3/groups/picker' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"04f65b723204b6abe2705cb2cc6d082e92a0f5247634075321f01f4b5fc8e972"},"Create issue":{"name":"Create issue","http_method":"POST","path":"/rest/api/3/issue","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.","params":[{"name":"updateHistory","type":"boolean","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.","default":"false"}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"update\": {\n  },\n  \"fields\": {\n    \"summary\": \"Main order flow broken\",\n    \"parent\": {\n      \"key\": \"PROJ-123\"\n    },\n    \"issuetype\": {\n      \"id\": \"10000\"\n    },\n    \"components\": [\n      {\n        \"id\": \"10000\"\n      }\n    ],\n    \"customfield_20000\": \"06/Jul/19 3:25 PM\",\n    \"customfield_40000\": {\n      \"type\": \"doc\",\n      \"version\": 1,\n      \"content\": [\n        {\n          \"type\": \"paragraph\",\n          \"content\": [\n            {\n              \"text\": \"Occurs on all orders\",\n              \"type\": \"text\"\n            }\n          ]\n        }\n      ]\n    },\n    \"customfield_70000\": [\n      \"jira-administrators\",\n      \"jira-software-users\"\n    ],\n    \"project\": {\n      \"id\": \"10000\"\n    },\n    \"description\": {\n      \"type\": \"doc\",\n      \"version\": 1,\n      \"content\": [\n        {\n          \"type\": \"paragraph\",\n          \"content\": [\n            {\n              \"text\": \"Order entry fails when selecting supplier.\",\n              \"type\": \"text\"\n            }\n          ]\n        }\n      ]\n    },\n    \"reporter\": {\n      \"id\": \"5b10a2844c20165700ede21g\"\n    },\n    \"fixVersions\": [\n      {\n        \"id\": \"10001\"\n      }\n    ],\n    \"customfield_10000\": \"09/Jun/19\",\n    \"priority\": {\n      \"id\": \"20000\"\n    },\n    \"labels\": [\n      \"bugfix\",\n      \"blitz_test\"\n    ],\n    \"timetracking\": {\n      \"remainingEstimate\": \"5\",\n      \"originalEstimate\": \"10\"\n    },\n    \"customfield_30000\": [\n      \"10000\",\n      \"10002\"\n    ],\n    \"customfield_80000\": {\n      \"value\": \"red\"\n    },\n    \"security\": {\n      \"id\": \"10000\"\n    },\n    \"environment\": {\n      \"type\": \"doc\",\n      \"version\": 1,\n      \"content\": [\n        {\n          \"type\": \"paragraph\",\n          \"content\": [\n            {\n              \"text\": \"UAT\",\n              \"type\": \"text\"\n            }\n          ]\n        }\n      ]\n    },\n    \"versions\": [\n      {\n        \"id\": \"10000\"\n      }\n    ],\n    \"duedate\": \"2019-05-11T00:00:00.000Z\",\n    \"customfield_60000\": \"jira-software-users\",\n    \"customfield_50000\": {\n      \"type\": \"doc\",\n      \"version\": 1,\n      \"content\": [\n        {\n          \"type\": \"paragraph\",\n          \"content\": [\n            {\n              \"text\": \"Could impact day-to-day work.\",\n              \"type\": \"text\"\n            }\n          ]\n        }\n      ]\n    },\n    \"assignee\": {\n      \"id\": \"5b109f2e9729b51b54dc274d\"\n    }\n  }\n}'","digest":"a213febf188ff5dd3ae8c2330b01623fc845f9efc62cb3ff3362a1ccda7eb61d"},"Bulk create issue":{"name":"Bulk create issue","http_method":"POST","path":"/rest/api/3/issue/bulk","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.","params":[{"name":"issueUpdates","type":"Array<IssueUpdateDetails>"},{"name":"Additional Properties","type":"anything","description":"Extra properties of any type may be provided to this object."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/bulk' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"issueUpdates\": \"{issueUpdates}\"\n}'","digest":"453b165bbfd753029e0f6bafcb89b1ad2fd0e0311708bc3dd8a2d93071daecf6"},"Get create issue metadata":{"name":"Get create issue metadata","http_method":"GET","path":"/rest/api/3/issue/createmeta","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 and Create issues.","params":[{"name":"projectIds","type":"Array<string>","description":"List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided with projectKeys."},{"name":"projectKeys","type":"Array<string>","description":"List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided with projectIds."},{"name":"issuetypeIds","type":"Array<string>","description":"List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames."},{"name":"issuetypeNames","type":"Array<string>","description":"List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided with issuetypeIds."},{"name":"expand","type":"string","description":"Use expand 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 and Create issues."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/createmeta' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"262b1e78fde4032b7495e55061c591cc960dbd8fd500ca83088059d21a56cef3"},"Get issue":{"name":"Get issue","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}","description":"Returns the details for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"fields","type":"Array<string>","description":"A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values:"},{"name":"fieldsByKeys","type":"boolean","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.","default":"false"},{"name":"expand","type":"string","description":"Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:"},{"name":"properties","type":"Array<string>","description":"A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:"},{"name":"updateHistory","type":"boolean","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 lastViewed field.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"09678c99c741975479386fc9296e2909b636f3f496554623c2d3744434c3b2ad"},"Edit issue":{"name":"Edit issue","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}","description":"Edits an issue. A transition may be applied and issue properties updated as part of the edit.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"notifyUsers","type":"boolean","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.","default":"true"},{"name":"overrideScreenSecurity","type":"boolean","description":"Indicates whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.","default":"false"},{"name":"overrideEditableFlag","type":"boolean","description":"Indicates whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.","default":"false"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"historyMetadata\": {\n    \"actor\": {\n      \"avatarUrl\": \"http://mysystem/avatar/tony.jpg\",\n      \"displayName\": \"Tony\",\n      \"id\": \"tony\",\n      \"type\": \"mysystem-user\",\n      \"url\": \"http://mysystem/users/tony\"\n    },\n    \"extraData\": {\n      \"Iteration\": \"10a\",\n      \"Step\": \"4\"\n    },\n    \"description\": \"From the order testing process\",\n    \"generator\": {\n      \"id\": \"mysystem-1\",\n      \"type\": \"mysystem-application\"\n    },\n    \"cause\": {\n      \"id\": \"myevent\",\n      \"type\": \"mysystem-event\"\n    },\n    \"activityDescription\": \"Complete order processing\",\n    \"type\": \"myplugin:type\"\n  },\n  \"update\": {\n    \"summary\": [\n      {\n        \"set\": \"Bug in business logic\"\n      }\n    ],\n    \"parent\": [\n      {\n        \"set\": {\n          \"none\": true\n        }\n      }\n    ],\n    \"components\": [\n      {\n        \"set\": \"\"\n      }\n    ],\n    \"timetracking\": [\n      {\n        \"edit\": {\n          \"remainingEstimate\": \"4d\",\n          \"originalEstimate\": \"1w 1d\"\n        }\n      }\n    ],\n    \"labels\": [\n      {\n        \"add\": \"triaged\"\n      },\n      {\n        \"remove\": \"blocker\"\n      }\n    ]\n  },\n  \"fields\": {\n    \"summary\": \"Completed orders still displaying in pending\",\n    \"customfield_10010\": 1,\n    \"customfield_10000\": {\n      \"type\": \"doc\",\n      \"version\": 1,\n      \"content\": [\n        {\n          \"type\": \"paragraph\",\n          \"content\": [\n            {\n              \"text\": \"Investigation underway\",\n              \"type\": \"text\"\n            }\n          ]\n        }\n      ]\n    }\n  },\n  \"properties\": [\n    {\n      \"value\": \"Order number 10784\",\n      \"key\": \"key1\"\n    },\n    {\n      \"value\": \"Order number 10923\",\n      \"key\": \"key2\"\n    }\n  ]\n}'","digest":"a50751557aab0da5310247c4582f7e29cd67f999cb416a77cc687a62633d5186"},"Delete issue":{"name":"Delete issue","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}","description":"Deletes an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"deleteSubtasks","type":"string","description":"Indicates whether the issue's subtasks are deleted when the issue is deleted.","default":"false"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"b13ad1ae60b24ad869c70f692c7318f7cd5d4182cbdc18e7c9f84d9acba12625"},"Assign issue":{"name":"Assign issue","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}/assignee","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.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue to be assigned."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/assignee' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"accountId\": \"5b10ac8d82e05b22cc7d4ef5\"\n}'","digest":"bae61b2e34fb49d757a76a6885e76f8a698bd0cf62f9b6c0646518879de150ed"},"Get change logs":{"name":"Get change logs","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/changelog","description":"Returns all changelogs for an issue sorted by date, starting from the oldest.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"100"}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/changelog' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d6543405b39bd732b8749a6f712f641eb48528843f25a0fe755a779542d58bb5"},"Get edit issue metadata":{"name":"Get edit issue metadata","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/editmeta","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.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"overrideScreenSecurity","type":"boolean","description":"Indicates whether hidden fields should be returned. Available to connect app users with admin permissions.","default":"false"},{"name":"overrideEditableFlag","type":"boolean","description":"Indicates whether non-editable fields should be returned. Available to connect app users with admin permissions.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/editmeta' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"5d45b4aaa57f3ce8d6e031c46fb9a4b51992fb8b7c392379826c5e66f481fac9"},"Send notification for issue":{"name":"Send notification for issue","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/notify","description":"Creates an email notification for an issue and adds it to the mail queue.","params":[{"name":"issueIdOrKey","type":"string","description":"ID or key of the issue that the notification is sent for."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/notify' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"htmlBody\": \"The <strong>latest</strong> test results for this ticket are now available.\",\n  \"subject\": \"Latest test results\",\n  \"textBody\": \"The latest test results for this ticket are now available.\",\n  \"to\": {\n    \"voters\": true,\n    \"watchers\": true,\n    \"groups\": [\n      {\n        \"name\": \"notification-group\"\n      }\n    ],\n    \"reporter\": false,\n    \"assignee\": false,\n    \"users\": [\n      {\n        \"accountId\": \"5b10a2844c20165700ede21g\",\n        \"active\": false\n      }\n    ]\n  },\n  \"restrict\": {\n    \"permissions\": [\n      {\n        \"key\": \"BROWSE\"\n      }\n    ],\n    \"groups\": [\n      {\n        \"name\": \"notification-group\"\n      }\n    ]\n  }\n}'","digest":"6c4a49b00a44c5216b2eee1fcb0c89cf962b6aaa97e20ebebe7d1c48ee85977d"},"Get transitions":{"name":"Get transitions","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/transitions","description":"Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue's status.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"expand","type":"string","description":"Use expand 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."},{"name":"transitionId","type":"string","description":"The ID of the transition."},{"name":"skipRemoteOnlyCondition","type":"boolean","description":"Indicates whether transitions with the condition Hide From User Condition are included in the response.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/transitions' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"aaf372f38fa9e1b86068a1f878d27900131d789943f3477b84e2a0bf828309b5"},"Transition issue":{"name":"Transition issue","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/transitions","description":"Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/transitions' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"historyMetadata\": {\n    \"actor\": {\n      \"avatarUrl\": \"http://mysystem/avatar/tony.jpg\",\n      \"displayName\": \"Tony\",\n      \"id\": \"tony\",\n      \"type\": \"mysystem-user\",\n      \"url\": \"http://mysystem/users/tony\"\n    },\n    \"extraData\": {\n      \"Iteration\": \"10a\",\n      \"Step\": \"4\"\n    },\n    \"description\": \"From the order testing process\",\n    \"generator\": {\n      \"id\": \"mysystem-1\",\n      \"type\": \"mysystem-application\"\n    },\n    \"cause\": {\n      \"id\": \"myevent\",\n      \"type\": \"mysystem-event\"\n    },\n    \"activityDescription\": \"Complete order processing\",\n    \"type\": \"myplugin:type\"\n  },\n  \"update\": {\n    \"comment\": [\n      {\n        \"add\": {\n          \"body\": {\n            \"type\": \"doc\",\n            \"version\": 1,\n            \"content\": [\n              {\n                \"type\": \"paragraph\",\n                \"content\": [\n                  {\n                    \"text\": \"Bug has been fixed\",\n                    \"type\": \"text\"\n                  }\n                ]\n              }\n            ]\n          }\n        }\n      }\n    ]\n  },\n  \"fields\": {\n    \"assignee\": {\n      \"name\": \"bob\"\n    },\n    \"resolution\": {\n      \"name\": \"Fixed\"\n    }\n  },\n  \"transition\": {\n    \"id\": \"5\"\n  }\n}'","digest":"b8424d38a1107fd75dd38aec3567105d390b807873d37b2ec3b82d1d6c14c059"},"Get Jira attachment settings":{"name":"Get Jira attachment settings","http_method":"GET","path":"/rest/api/3/attachment/meta","description":"Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/attachment/meta' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"58a89877def03beef6ee121bdebe5c36795eaedd8cfd4df63b7040e2a324d29b"},"Get attachment metadata":{"name":"Get attachment metadata","http_method":"GET","path":"/rest/api/3/attachment/{id}","description":"Returns the metadata for an attachment. Note that the attachment itself is not returned.","params":[{"name":"id","type":"string","description":"The ID of the attachment."}],"command":"curl --request GET \\\n  --url '/rest/api/3/attachment/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"cb0155042be5fa0045cd90de09bb77d9b27e213abfae005bbfacae1fcfba1beb"},"Delete attachment":{"name":"Delete attachment","http_method":"DELETE","path":"/rest/api/3/attachment/{id}","description":"Deletes an attachment from an issue.","params":[{"name":"id","type":"string","description":"The ID of the attachment."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/attachment/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"3bc02be18a7b9be5477fa2e1916969736a0c19395be0974ae699733287ac7f99"},"Get all metadata for an expanded attachment":{"name":"Get all metadata for an expanded attachment","http_method":"GET","path":"/rest/api/3/attachment/{id}/expand/human","description":"GET /rest/api/3/attachment/{id}/expand/human","params":[{"name":"id","type":"string","description":"The ID of the attachment."}],"command":"curl --request GET \\\n  --url '/rest/api/3/attachment/{id}/expand/human' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"ea1b323e334163b256dfe91f535c3f4e2684e868b5bab2e1529380c9691f7c11"},"Get contents metadata for an expanded attachment":{"name":"Get contents metadata for an expanded attachment","http_method":"GET","path":"/rest/api/3/attachment/{id}/expand/raw","description":"GET /rest/api/3/attachment/{id}/expand/raw","params":[{"name":"id","type":"string","description":"The ID of the attachment."}],"command":"curl --request GET \\\n  --url '/rest/api/3/attachment/{id}/expand/raw' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b7aa6ec1c368a4aa21384c0943be1663465527d3fda06a25efb7ef6172d879fe"},"Add attachment":{"name":"Add attachment","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/attachments","description":"Adds one or more attachments to an issue. Attachments are posted as multipart/form-data (RFC 1867).","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue that attachments are added to."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/attachments' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"280a53bc84c83a0fb0a2ea1b1d9e4f5d06489cac95f8e956d81f17495564cdf3"},"Get comments by IDs":{"name":"Get comments by IDs","http_method":"POST","path":"/rest/api/3/comment/list","description":"Returns the comments for a list of comment IDs.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request POST \\\n  --url '/rest/api/3/comment/list' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"ids\": [\n    1,\n    2,\n    5,\n    10\n  ]\n}'","digest":"b72981d3d61b4e17b1aa8674ae0cf23ddc68aa8a192dc51972dc1ced984a460b"},"Get comments":{"name":"Get comments","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/comment","description":"Returns all comments for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"50"},{"name":"orderBy","type":"string","description":"The field to order returned comments by. Only accepts the value created, which orders comments by their created date."},{"name":"expand","type":"string","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/comment' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7abce1edb991ef90ca1508063896bcb7a0c78581511c7cca4da21d50396bddb8"},"Add comment":{"name":"Add comment","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/comment","description":"Adds a comment to an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"expand","type":"string","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/comment' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"visibility\": {\n    \"type\": \"role\",\n    \"value\": \"Administrators\"\n  },\n  \"body\": {\n    \"type\": \"doc\",\n    \"version\": 1,\n    \"content\": [\n      {\n        \"type\": \"paragraph\",\n        \"content\": [\n          {\n            \"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.\",\n            \"type\": \"text\"\n          }\n        ]\n      }\n    ]\n  }\n}'","digest":"3bb17b816eee50fdffcb09802df5d138f6c0ee8b0a5a28e66d172b95a78d0768"},"Get comment":{"name":"Get comment","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/comment/{id}","description":"Returns a comment.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"id","type":"string","description":"The ID of the comment."},{"name":"expand","type":"string","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/comment/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"6a9aa1d90995ff3cc0336fca9a65470ee712dbcabc3fbd6a5b156da327571f5a"},"Update comment":{"name":"Update comment","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}/comment/{id}","description":"Updates a comment.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"id","type":"string","description":"The ID of the comment."},{"name":"expand","type":"string","description":"Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/comment/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"visibility\": {\n    \"type\": \"role\",\n    \"value\": \"Administrators\"\n  },\n  \"body\": {\n    \"type\": \"doc\",\n    \"version\": 1,\n    \"content\": [\n      {\n        \"type\": \"paragraph\",\n        \"content\": [\n          {\n            \"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.\",\n            \"type\": \"text\"\n          }\n        ]\n      }\n    ]\n  }\n}'","digest":"1cc9f99d7b0afb99d86a60ac75996f09cfa93c9730d0ea8df75bca25ae82179e"},"Delete comment":{"name":"Delete comment","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/comment/{id}","description":"Deletes a comment.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"id","type":"string","description":"The ID of the comment."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/comment/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"74f5d54a0f3b810de9e656d658513c334c9d0bea300e5703df5f502ba240aa8a"},"Get comment property keys":{"name":"Get comment property keys","http_method":"GET","path":"/rest/api/3/comment/{commentId}/properties","description":"Returns the keys of all the properties of a comment.","params":[{"name":"commentId","type":"string","description":"The ID of the comment."}],"command":"curl --request GET \\\n  --url '/rest/api/3/comment/{commentId}/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b3372f99cdfd93df30abd9a8456f4ff098ed87c293ef37a00cc05a150f8ba8ee"},"Get comment property":{"name":"Get comment property","http_method":"GET","path":"/rest/api/3/comment/{commentId}/properties/{propertyKey}","description":"Returns the value of a comment property.","params":[{"name":"commentId","type":"string","description":"The ID of the comment."},{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request GET \\\n  --url '/rest/api/3/comment/{commentId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"a39e5e9f4845c15656eab78f70e3a5a540246f98376ac1e71c5822b0623880b3"},"Set comment property":{"name":"Set comment property","http_method":"PUT","path":"/rest/api/3/comment/{commentId}/properties/{propertyKey}","description":"Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.","params":[{"name":"commentId","type":"string","description":"The ID of the comment."},{"name":"propertyKey","type":"string","description":"The key of the property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/comment/{commentId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{}'","digest":"63675f228c40a3e5528f5466b83ee8e8704532479c9f1f64a2cad68b5ad00400"},"Delete comment property":{"name":"Delete comment property","http_method":"DELETE","path":"/rest/api/3/comment/{commentId}/properties/{propertyKey}","description":"Deletes a comment property.","params":[{"name":"commentId","type":"string","description":"The ID of the comment."},{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/comment/{commentId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"9641b92171f0de28fbb65e5d574a02b4aa3df77c771cdb51632532d1c44a33a6"},"Get options for field":{"name":"Get options for field","http_method":"GET","path":"/rest/api/3/customField/{fieldId}/option","description":"Returns the options for a built-in custom select field.","params":[{"name":"fieldId","type":"integer","description":"The ID of the custom field.","default":"int64"},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"1000"}],"command":"curl --request GET \\\n  --url '/rest/api/3/customField/{fieldId}/option' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e215dfe8db8ff9cdec980452843185dec3d8066dea54c7aa4cc10ecbcbe43c19"},"Create custom field options":{"name":"Create custom field options","http_method":"POST","path":"/rest/api/3/customField/{fieldId}/option","description":"Creates options for a built-in custom select field.","params":[{"name":"fieldId","type":"integer","description":"The ID of the custom field.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/customField/{fieldId}/option' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"options\": [\n    {\n      \"value\": \"Option value\"\n    },\n    {\n      \"value\": \"Other option value\"\n    },\n    {\n      \"value\": \"Third option value\"\n    }\n  ]\n}'","digest":"93e9dda219a9e0701639a994f0bf411bb7411078545c175df329c6cb8744a661"},"Get custom field option":{"name":"Get custom field option","http_method":"GET","path":"/rest/api/3/customFieldOption/{id}","description":"Returns a custom field option. For example, an option in a cascading select list.","params":[{"name":"id","type":"string","description":"The ID of the custom field option. To find this ID,  configure the custom field and edit its options in Jira. Click the option and its ID will show in the URL as the selectedParentOptionId parameter."}],"command":"curl --request GET \\\n  --url '/rest/api/3/customFieldOption/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"2afeeaf37bb02f43fea058cccb21fc432d27a02ee94528d55b0b5087813079f5"},"Get fields":{"name":"Get fields","http_method":"GET","path":"/rest/api/3/field","description":"Returns system and custom issue fields according to the following rules:","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/field' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7b874ff2149627508cf84b72a1b924e496d8b569ba445f8aa755f6a1cee5b944"},"Create custom field":{"name":"Create custom field","http_method":"POST","path":"/rest/api/3/field","description":"Creates a custom field.","params":[{"name":"name","type":"string","description":"The name of the custom field, which is displayed in Jira. This is not the unique identifier."},{"name":"description","type":"string","description":"The description of the custom field, which is displayed in Jira."},{"name":"type","type":"string","description":"The type of the custom field. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppicker."},{"name":"searcherKey","type":"string","description":"The searcher defines the way the field is searched in Jira. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher.The 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):"}],"command":"curl --request POST \\\n  --url '/rest/api/3/field' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"searcherKey\": \"{searcherKey}\",\n  \"name\": \"{name}\",\n  \"description\": \"{description}\",\n  \"type\": \"{type}\"\n}'","digest":"6d31875932bb768d4113109f689459250365986af255bc59a30983df9a9f2264"},"Get fields paginated":{"name":"Get fields paginated","http_method":"GET","path":"/rest/api/3/field/search","description":"GET /rest/api/3/field/search","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"50"},{"name":"type","type":"Array<string>","description":"The type of fields to search."},{"name":"query","type":"string","description":"String used to perform a case-insensitive partial match with field names."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/field/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"4c48be6d937438ba1672562d44b62b063c6127594fd545c5b496a866acb2fe17"},"Get all issue field options":{"name":"Get all issue field options","http_method":"GET","path":"/rest/api/3/field/{fieldKey}/option","description":"Returns all options defined for a select list issue field. A select list issue field is a type of issue field that allows a user to select n value from a list of options.","params":[{"name":"fieldKey","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":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"50"}],"command":"curl --request GET \\\n  --url '/rest/api/3/field/{fieldKey}/option' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7dd44e23f5165d9ba06086b3860d67a96905e3c5a90dc4827b59ef74c71d08fc"},"Create issue field option":{"name":"Create issue field option","http_method":"POST","path":"/rest/api/3/field/{fieldKey}/option","description":"Creates an option for a select list issue field.","params":[{"name":"fieldKey","type":"string","description":"The field key is specified in the following format: $(app-key)\\_\\_$(field-key). For example, example-add-on\\_\\_example-issue-field."}],"command":"curl --request POST \\\n  --url '/rest/api/3/field/{fieldKey}/option' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"value\": \"Team 1\",\n  \"config\": {\n    \"scope\": {\n      \"projects2\": [\n        {\n          \"attributes\": [\n            \"notSelectable\"\n          ],\n          \"id\": 1002\n        },\n        {\n          \"attributes\": [\n            \"notSelectable\"\n          ],\n          \"id\": 1001\n        }\n      ],\n      \"projects\": [\n\n      ],\n      \"global\": {\n      }\n    },\n    \"attributes\": [\n\n    ]\n  },\n  \"properties\": {\n    \"leader\": {\n      \"name\": \"Leader Name\",\n      \"email\": \"lname@example.com\"\n    },\n    \"members\": 42,\n    \"founded\": \"2016-06-06T00:00:00.000Z\",\n    \"description\": \"The team's description\"\n  }\n}'","digest":"17d0420138c88f884e8da37e4c52b4f510e53f3727caf1f174639eeb035fa631"},"Get selectable issue field options":{"name":"Get selectable issue field options","http_method":"GET","path":"/rest/api/3/field/{fieldKey}/option/suggestions/edit","description":"Returns options defined for a select list issue field that can be viewed and selected by the user.","params":[{"name":"fieldKey","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":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"50"},{"name":"projectId","type":"integer","description":"Filters the results to options that are only available in the specified project.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/field/{fieldKey}/option/suggestions/edit' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"55901cd98c592b9ea5735a2a15c64c92ff7593dd0f82d86cf326eea6fbebb289"},"Get visible issue field options":{"name":"Get visible issue field options","http_method":"GET","path":"/rest/api/3/field/{fieldKey}/option/suggestions/search","description":"Returns options defined for a select list issue field that can be viewed by the user.","params":[{"name":"fieldKey","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":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"int32"},{"name":"projectId","type":"integer","description":"Filters the results to options that are only available in the specified project.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/field/{fieldKey}/option/suggestions/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e3a1739256f49608af53a0d696dd60740e9f58e91d655871e0093d86acb73ccd"},"Get issue field option":{"name":"Get issue field option","http_method":"GET","path":"/rest/api/3/field/{fieldKey}/option/{optionId}","description":"Returns an option from a select list issue field.","params":[{"name":"fieldKey","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":"optionId","type":"integer","description":"The ID of the option to be returned.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/field/{fieldKey}/option/{optionId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e30bc1deb9588d2263ffedbb9ff8892060adea5ac8c7940e81e7924a0b5daac9"},"Update issue field option":{"name":"Update issue field option","http_method":"PUT","path":"/rest/api/3/field/{fieldKey}/option/{optionId}","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.","params":[{"name":"fieldKey","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":"optionId","type":"integer","description":"The ID of the option to be updated.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/field/{fieldKey}/option/{optionId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"id\": 1,\n  \"value\": \"Team 1\",\n  \"config\": {\n    \"scope\": {\n      \"projects2\": [\n        {\n          \"attributes\": [\n            \"notSelectable\"\n          ],\n          \"id\": 1002\n        },\n        {\n          \"attributes\": [\n            \"notSelectable\"\n          ],\n          \"id\": 1001\n        }\n      ],\n      \"projects\": [\n\n      ],\n      \"global\": {\n      }\n    },\n    \"attributes\": [\n\n    ]\n  },\n  \"properties\": {\n    \"leader\": {\n      \"name\": \"Leader Name\",\n      \"email\": \"lname@example.com\"\n    },\n    \"members\": 42,\n    \"founded\": \"2016-06-06T00:00:00.000Z\",\n    \"description\": \"The team's description\"\n  }\n}'","digest":"a65304069e44dd97aca4476f41715f8eee4c56c232b4b9fc253f9ef322a2402b"},"Delete issue field option":{"name":"Delete issue field option","http_method":"DELETE","path":"/rest/api/3/field/{fieldKey}/option/{optionId}","description":"Deletes an option from a select list issue field.","params":[{"name":"fieldKey","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":"optionId","type":"integer","description":"The ID of the option to be deleted.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/field/{fieldKey}/option/{optionId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b01ea5b2123e6f2f54610a04db2f225aab5c0f277a57f9a1bb2f471242e03661"},"Replace issue field option":{"name":"Replace issue field option","http_method":"DELETE","path":"/rest/api/3/field/{fieldKey}/option/{optionId}/issue","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.","params":[{"name":"fieldKey","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":"optionId","type":"integer","description":"The ID of the option to be deselected.","default":"int64"},{"name":"replaceWith","type":"integer","description":"The ID of the option that will replace the currently selected option.","default":"int64"},{"name":"jql","type":"string","description":"A JQL query that specifies the issues to be updated. For example, project=10000."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/field/{fieldKey}/option/{optionId}/issue' \\\n  --user 'email@example.com:<api_token>'","digest":"d2406825ec9096099962fd46c3f5f21a80b0748c7fc63f2583b9db7e6d75e4ae"},"Create issue link":{"name":"Create issue link","http_method":"POST","path":"/rest/api/3/issueLink","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 enabled.","params":[{"name":"type","description":"This object is used as follows:"},{"name":"inwardIssue","description":"The ID or key of a linked issue."},{"name":"outwardIssue","description":"The ID or key of a linked issue."},{"name":"comment","description":"A comment."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issueLink' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"outwardIssue\": \"{outwardIssue}\",\n  \"comment\": \"{comment}\",\n  \"inwardIssue\": \"{inwardIssue}\",\n  \"type\": \"{type}\"\n}'","digest":"89a2aa3a61be19d757395659bae631fe4e1ce09da61557ac452289e1df2bee78"},"Get issue link":{"name":"Get issue link","http_method":"GET","path":"/rest/api/3/issueLink/{linkId}","description":"Returns an issue link.","params":[{"name":"linkId","type":"string","description":"The ID of the issue link."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issueLink/{linkId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"6141fa7bc815ed21b6e0c8861ccef7e8b6018171adacb79f4d95fa94e6f2ecc8"},"Delete issue link":{"name":"Delete issue link","http_method":"DELETE","path":"/rest/api/3/issueLink/{linkId}","description":"Deletes an issue link.","params":[{"name":"linkId","type":"string","description":"The ID of the issue link."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issueLink/{linkId}' \\\n  --user 'email@example.com:<api_token>'","digest":"9ad3a6e8f929d646a70d236f5417081e13718e39216c237336fb8491f638664d"},"Get issue link types":{"name":"Get issue link types","http_method":"GET","path":"/rest/api/3/issueLinkType","description":"Returns a list of all issue link types.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/issueLinkType' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d35b66a9d34df66996f5aa901e3aae57a4287c64dd0aa05d4e1e38db3e897bb9"},"Create issue link type":{"name":"Create issue link type","http_method":"POST","path":"/rest/api/3/issueLinkType","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.","params":[{"name":"id","type":"string","description":"The ID of the issue link type and is used as follows:"},{"name":"name","type":"string","description":"The name of the issue link type and is used as follows:"},{"name":"inward","type":"string","description":"The description of the issue link type inward link and is used as follows:"},{"name":"outward","type":"string","description":"The description of the issue link type outward link and is used as follows:"}],"command":"curl --request POST \\\n  --url '/rest/api/3/issueLinkType' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"inward\": \"{inward}\",\n  \"name\": \"{name}\",\n  \"outward\": \"{outward}\"\n}'","digest":"5cb06943b13d7f604afb084b996b73f9abdf2b85ef1d5fa1155e96dfc3adb0ff"},"Get issue link type":{"name":"Get issue link type","http_method":"GET","path":"/rest/api/3/issueLinkType/{issueLinkTypeId}","description":"Returns an issue link type.","params":[{"name":"issueLinkTypeId","type":"string","description":"The ID of the issue link type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issueLinkType/{issueLinkTypeId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"2ec119fe3d54e3dccb74e9ff38ddec69a03726591f20f51f0ae490bf3de5334b"},"Update issue link type":{"name":"Update issue link type","http_method":"PUT","path":"/rest/api/3/issueLinkType/{issueLinkTypeId}","description":"Updates an issue link type.","params":[{"name":"issueLinkTypeId","type":"string","description":"The ID of the issue link type."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issueLinkType/{issueLinkTypeId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"inward\": \"Duplicated by\",\n  \"name\": \"Duplicate\",\n  \"outward\": \"Duplicates\"\n}'","digest":"bcd3f94fee1bd02b5acecb5d3c62594eac35c5cbc4c3874d48fe9bea8d540da9"},"Delete issue link type":{"name":"Delete issue link type","http_method":"DELETE","path":"/rest/api/3/issueLinkType/{issueLinkTypeId}","description":"Deletes an issue link type.","params":[{"name":"issueLinkTypeId","type":"string","description":"The ID of the issue link type."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issueLinkType/{issueLinkTypeId}' \\\n  --user 'email@example.com:<api_token>'","digest":"35f86cfb52a3f1fc72a948d9560f77855aa9443d38c6759514209c597bea3f75"},"Get issue navigator default columns":{"name":"Get issue navigator default columns","http_method":"GET","path":"/rest/api/3/settings/columns","description":"Returns the default issue navigator columns.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/settings/columns' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"14373f2455ed82f0f17d65627d03096ceafb79012538438529893fa17be4a069"},"Set issue navigator default columns":{"name":"Set issue navigator default columns","http_method":"PUT","path":"/rest/api/3/settings/columns","description":"Sets the default issue navigator columns.","params":[],"command":"curl --request PUT \\\n  --url '/rest/api/3/settings/columns' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c5d0866103cb12bee91dccd4c2027eaead0f848443f0539b4b087ed46ea50c62"},"Get notification schemes paginated":{"name":"Get notification schemes paginated","http_method":"GET","path":"/rest/api/3/notificationscheme","description":"Returns a paginated list of notification schemes in order by display name.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 50.","default":"50"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/notificationscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"4fae7b9a93f4a97a01101388be7372c5786f6395368e3015376f3fdc162126ef"},"Get notification scheme":{"name":"Get notification scheme","http_method":"GET","path":"/rest/api/3/notificationscheme/{id}","description":"Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.","params":[{"name":"id","type":"integer","description":"The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/notificationscheme/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"37bc320809d421ebaaeb0915e907a52988018dacf4924609351bdc18e4fa002c"},"Get priorities":{"name":"Get priorities","http_method":"GET","path":"/rest/api/3/priority","description":"Returns the list of all issue priorities.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/priority' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"154237a70a24dee10df5dc0e145c584b7d2d6f33d37d217aa8245d50473d21c2"},"Get priority":{"name":"Get priority","http_method":"GET","path":"/rest/api/3/priority/{id}","description":"Returns an issue priority.","params":[{"name":"id","type":"string","description":"The ID of the issue priority."}],"command":"curl --request GET \\\n  --url '/rest/api/3/priority/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9c013e168900f0af9764684e2031f30545365804cc91802a88a7d49e188d8000"},"Bulk set issues properties":{"name":"Bulk set issues properties","http_method":"POST","path":"/rest/api/3/issue/properties","description":"POST /rest/api/3/issue/properties","params":[{"name":"entitiesIds","type":"Array<integer>","description":"A list of entity IDs.","default":"1"},{"name":"properties","description":"A list of entity property keys and values.","default":"1"}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"entitiesIds\": \"{entitiesIds}\",\n  \"properties\": \"{properties}\"\n}'","digest":"3bb44e6e6c04c3fa59877e7185bb62a91ff377933bd2de404776e3374bdff541"},"Bulk set issue property":{"name":"Bulk set issue property","http_method":"PUT","path":"/rest/api/3/issue/properties/{propertyKey}","description":"Sets a property value on multiple issues. The issues to be updated can be specified by a filter.","params":[{"name":"propertyKey","type":"string","description":"The key of the property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"filter\": {\n    \"hasProperty\": true,\n    \"entityIds\": [\n      10100,\n      100010\n    ],\n    \"currentValue\": {\n      \"owner\": \"admin\",\n      \"weight\": 50\n    }\n  },\n  \"value\": {\n    \"owner\": \"admin\",\n    \"weight\": 100\n  }\n}'","digest":"ecbba6025e9287ece19322dc058c1646abf309fef17e677184145ba936da5492"},"Bulk delete issue property":{"name":"Bulk delete issue property","http_method":"DELETE","path":"/rest/api/3/issue/properties/{propertyKey}","description":"Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.","params":[{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"entityIds\": [\n    10100,\n    100010\n  ],\n  \"currentValue\": \"deprecated value\"\n}'","digest":"5d0a48b8ad821e1c3025f70142096bc166c103eb3cbfc00ecb3c01e50f712a0f"},"Get issue property keys":{"name":"Get issue property keys","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/properties","description":"Returns the URLs and keys of an issue's properties.","params":[{"name":"issueIdOrKey","type":"string","description":"The key or ID of the issue."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"30d531eaad281df912e13c3b98e984c9c503f7d6516927530e2df3f2e0707550"},"Get issue property":{"name":"Get issue property","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}","description":"Returns the key and value of an issue's property.","params":[{"name":"issueIdOrKey","type":"string","description":"The key or ID of the issue."},{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"292f15ad26b4587bee50fb9c4b026e6f18207ca2544f52efef2f2d263512107c"},"Set issue property":{"name":"Set issue property","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}","description":"Sets the value of an issue's property. Use this resource to store custom data against an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"propertyKey","type":"string","description":"The key of the issue property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{}'","digest":"d6ef5cce21497ffb09c42bce4ab0287e71c69c4a0d7ffe7f95eb81d630faa14f"},"Delete issue property":{"name":"Delete issue property","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}","description":"Deletes an issue's property.","params":[{"name":"issueIdOrKey","type":"string","description":"The key or ID of the issue."},{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"ade019816c523e6eafe6dd32b9366f05c141cad2f6025e530e10c3829f0f6698"},"Get remote issue links":{"name":"Get remote issue links","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/remotelink","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.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"globalId","type":"string","description":"The global ID of the remote issue link."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/remotelink' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e0c144d89da6c06fa42399010a6d22bbaaf1018d2cf75ad5c096262a9d569bc8"},"Create or update remote issue link":{"name":"Create or update remote issue link","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/remotelink","description":"Creates or updates a remote issue link for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/remotelink' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"application\": {\n    \"name\": \"My Acme Tracker\",\n    \"type\": \"com.acme.tracker\"\n  },\n  \"globalId\": \"system=http://www.mycompany.com/support&id=1\",\n  \"relationship\": \"causes\",\n  \"object\": {\n    \"summary\": \"Customer support issue\",\n    \"icon\": {\n      \"url16x16\": \"http://www.mycompany.com/support/ticket.png\",\n      \"title\": \"Support Ticket\"\n    },\n    \"title\": \"TSTSUP-111\",\n    \"url\": \"http://www.mycompany.com/support?id=1\",\n    \"status\": {\n      \"icon\": {\n        \"url16x16\": \"http://www.mycompany.com/support/resolved.png\",\n        \"link\": \"http://www.mycompany.com/support?id=1&details=closed\",\n        \"title\": \"Case Closed\"\n      },\n      \"resolved\": true\n    }\n  }\n}'","digest":"82145484d938916394a298d7063f1b26e1a392f41568ba8c271c65c5ea71047d"},"Delete remote issue link by global ID":{"name":"Delete remote issue link by global ID","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/remotelink","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.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"globalId","type":"string","description":"The global ID of a remote issue link."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/remotelink?globalId={globalId}' \\\n  --user 'email@example.com:<api_token>'","digest":"1af41944561d85933b5030ddc350f8e19a1eb7dd59cc0958600f2d70274cd985"},"Get remote issue link by ID":{"name":"Get remote issue link by ID","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}","description":"Returns a remote issue link for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"linkId","type":"string","description":"The ID of the remote issue link."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"471a19f8e3006b3fc457118ee4635718f07b7deba25f64be299cbc46f4b32164"},"Update remote issue link by ID":{"name":"Update remote issue link by ID","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}","description":"Updates a remote issue link for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"linkId","type":"string","description":"The ID of the remote issue link."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"application\": {\n    \"name\": \"My Acme Tracker\",\n    \"type\": \"com.acme.tracker\"\n  },\n  \"globalId\": \"system=http://www.mycompany.com/support&id=1\",\n  \"relationship\": \"causes\",\n  \"object\": {\n    \"summary\": \"Customer support issue\",\n    \"icon\": {\n      \"url16x16\": \"http://www.mycompany.com/support/ticket.png\",\n      \"title\": \"Support Ticket\"\n    },\n    \"title\": \"TSTSUP-111\",\n    \"url\": \"http://www.mycompany.com/support?id=1\",\n    \"status\": {\n      \"icon\": {\n        \"url16x16\": \"http://www.mycompany.com/support/resolved.png\",\n        \"link\": \"http://www.mycompany.com/support?id=1&details=closed\",\n        \"title\": \"Case Closed\"\n      },\n      \"resolved\": true\n    }\n  }\n}'","digest":"8cc5385c0b7234931e99a0dc77faea499c9cb01497b065dbff38c4e24c2f6af5"},"Delete remote issue link by ID":{"name":"Delete remote issue link by ID","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}","description":"Deletes a remote issue link from an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"linkId","type":"string","description":"The ID of a remote issue link."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}' \\\n  --user 'email@example.com:<api_token>'","digest":"4e067c7f1a99a2905e7f9087d3ec51b74aa0fed40bf0274bd65053046ff2528a"},"Get resolutions":{"name":"Get resolutions","http_method":"GET","path":"/rest/api/3/resolution","description":"Returns a list of all issue resolution values.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/resolution' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"51c1c83af8088ae375002d428b579b450f8d5d539898b57f29b1bcc831f2d8a8"},"Get resolution":{"name":"Get resolution","http_method":"GET","path":"/rest/api/3/resolution/{id}","description":"Returns an issue resolution value.","params":[{"name":"id","type":"string","description":"The ID of the issue resolution value."}],"command":"curl --request GET \\\n  --url '/rest/api/3/resolution/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"aa08186e199105c2c290df066596afa5cd3f9aa651203cfde2a3f1270351d432"},"Get issue picker suggestions":{"name":"Get issue picker suggestions","http_method":"GET","path":"/rest/api/3/issue/picker","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.","params":[{"name":"query","type":"string","description":"A string to match against text fields in the issue such as title, description, or comments."},{"name":"currentJQL","type":"string","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."},{"name":"currentIssueKey","type":"string","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":"currentProjectId","type":"string","description":"The ID of a project that suggested issues must belong to."},{"name":"showSubTasks","type":"boolean","description":"Indicate whether to include subtasks in the suggestions list."},{"name":"showSubTaskParent","type":"boolean","description":"When currentIssueKey is a subtask, indicates whether to include the parent issue in the suggestions if it matches the query."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/picker?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"42500ba9b00e0c73a3050e06ede3b2dd50e2de30945d90c216f9ab9d3d5ff1a1"},"Check issues against JQL":{"name":"Check issues against JQL","http_method":"POST","path":"/rest/api/3/jql/match","description":"Checks whether one or more issues would be returned by one or more JQL queries.","params":[{"name":"jqls","type":"Array<string>","description":"A list of JQL queries."},{"name":"issueIds","type":"Array<integer>","description":"A list of issue IDs.","default":"true"}],"command":"curl --request POST \\\n  --url '/rest/api/3/jql/match' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"issueIds\": \"{issueIds}\",\n  \"jqls\": \"{jqls}\"\n}'","digest":"bebfa6ed74e9d7980165dee3b629927ab7dc6f6837ca317e46f8610eab1e4c83"},"Search for issues using JQL (GET)":{"name":"Search for issues using JQL (GET)","http_method":"GET","path":"/rest/api/3/search","description":"Searches for issues using JQL.","params":[{"name":"jql","type":"string","description":"The JQL that defines the search. Note:"},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","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.","default":"50"},{"name":"validateQuery","type":"string","description":"Determines how to validate the JQL query and treat the validation results. Supported values are:","default":"strict"},{"name":"fields","type":"Array<string>","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. Allowed values:"},{"name":"expand","type":"string","description":"Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:"},{"name":"properties","type":"Array<string>","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."},{"name":"fieldsByKeys","type":"boolean","description":"Reference fields by their key (rather than ID).","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/search?jql={jql}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"4ddd705fa41996599408931053fae4e7dfcb1371c16dc1d322b068d7a23f7ec7"},"Search for issues using JQL (POST)":{"name":"Search for issues using JQL (POST)","http_method":"POST","path":"/rest/api/3/search","description":"Searches for issues using JQL.","params":[{"name":"jql","type":"string","description":"A JQL expression."},{"name":"startAt","type":"integer","description":"The index of the first item to return in the page of results (page offset). The base index is 0.","default":"int32"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The default is 50 and the maximum is 100.","default":"int32"},{"name":"fields","type":"Array<string>","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. Allowed values"},{"name":"validateQuery","type":"string","description":"Determines how to validate the JQL query and treat the validation results. Supported values:"},{"name":"expand","type":"Array<string>","description":"Use expand 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:"},{"name":"properties","type":"Array<string>","description":"A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list."},{"name":"fieldsByKeys","type":"boolean","description":"Reference fields by their key (rather than ID). The default is false."}],"command":"curl --request POST \\\n  --url '/rest/api/3/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"expand\": \"{expand}\",\n  \"jql\": \"{jql}\",\n  \"maxResults\": \"{maxResults}\",\n  \"fieldsByKeys\": \"{fieldsByKeys}\",\n  \"fields\": \"{fields}\",\n  \"startAt\": \"{startAt}\"\n}'","digest":"76201feef5271e5f6a9c19d9431b15a8e1161ec880c66794c3b72a411b4c7d2d"},"Get issue security level":{"name":"Get issue security level","http_method":"GET","path":"/rest/api/3/securitylevel/{id}","description":"Returns details of an issue security level.","params":[{"name":"id","type":"string","description":"The ID of the issue security level."}],"command":"curl --request GET \\\n  --url '/rest/api/3/securitylevel/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7ed7aef1c10d8fd1cb69cf387096161c02d5e172f9210141062e7b6ad890f3f1"},"Get issue security schemes":{"name":"Get issue security schemes","http_method":"GET","path":"/rest/api/3/issuesecurityschemes","description":"Returns all issue security schemes.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/issuesecurityschemes' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"6767c81760733903b0864f8069b7c67aa23e41a955f9b936f35c5ed44cd9642c"},"Get issue security scheme":{"name":"Get issue security scheme","http_method":"GET","path":"/rest/api/3/issuesecurityschemes/{id}","description":"Returns an issue security scheme along with its security levels.","params":[{"name":"id","type":"integer","description":"The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/issuesecurityschemes/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"bb21af564ae45586588b3c9772c3fbbd0ae729931ad4ebe57829739636c5de34"},"Get all issue types for user":{"name":"Get all issue types for user","http_method":"GET","path":"/rest/api/3/issuetype","description":"Returns all issue types.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/issuetype' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"93445d56773bea9f832c5a975be5403c536a36a7a9b96da2e58c1619a769fd98"},"Create issue type":{"name":"Create issue type","http_method":"POST","path":"/rest/api/3/issuetype","description":"Creates an issue type and adds it to the default issue type scheme.","params":[{"name":"name","type":"string","description":"The unique name for the issue type. The maximum length is 60 characters. Required."},{"name":"description","type":"string","description":"The description of the issue type."},{"name":"type","type":"string","description":"Whether the issue type is subtype or standard. Defaults to standard."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issuetype' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"{name}\",\n  \"description\": \"{description}\",\n  \"type\": \"{type}\"\n}'","digest":"a45abba27d6ac0d65c8ee40ac492bd6899cbbc61224dd84cb16661dc517740e8"},"Get issue type":{"name":"Get issue type","http_method":"GET","path":"/rest/api/3/issuetype/{id}","description":"Returns an issue type.","params":[{"name":"id","type":"string","description":"The ID of the issue type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issuetype/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"f73f9158681d56261b07810ea54497e461238e404b9507b036b42e50ef41cd00"},"Update issue type":{"name":"Update issue type","http_method":"PUT","path":"/rest/api/3/issuetype/{id}","description":"Updates the issue type.","params":[{"name":"id","type":"string","description":"The ID of the issue type."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issuetype/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"avatarId\": 1,\n  \"name\": \"name\",\n  \"description\": \"description\"\n}'","digest":"0ef280c1b2c98a3db49fe1ca8e7788712be6d6b92ffe17782ad56d563afd315c"},"Delete issue type":{"name":"Delete issue type","http_method":"DELETE","path":"/rest/api/3/issuetype/{id}","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 resource.","params":[{"name":"id","type":"string","description":"The ID of the issue type."},{"name":"alternativeIssueTypeId","type":"string","description":"The ID of the replacement issue type."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issuetype/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"c10b93f037cc23ef9e4a7b497be83fc61fd655014b2c9a49f09e0a17265bb4e3"},"Get alternative issue types":{"name":"Get alternative issue types","http_method":"GET","path":"/rest/api/3/issuetype/{id}/alternatives","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.","params":[{"name":"id","type":"string","description":"The ID of the issue type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issuetype/{id}/alternatives' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9a487894a721d6a6a868bb289fb511057a2e904b142613d39b66963a9dd4653d"},"Load issue type avatar":{"name":"Load issue type avatar","http_method":"POST","path":"/rest/api/3/issuetype/{id}/avatar2","description":"Loads an avatar for the issue type.","params":[{"name":"id","type":"string","description":"The ID of the issue type."},{"name":"x","type":"integer","description":"The X coordinate of the top-left corner of the crop region.","default":"0"},{"name":"y","type":"integer","description":"The Y coordinate of the top-left corner of the crop region.","default":"0"},{"name":"size","type":"integer","description":"The length of each side of the crop region.","default":"int32"}],"command":"curl --request POST \\\n  --url '/rest/api/3/issuetype/{id}/avatar2?size={size}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c5e3ed121738638f37ee17526b53a9df47957c309fe35099bb96823039f91f72"},"Get the hierarchy":{"name":"Get the hierarchy","http_method":"GET","path":"/rest/api/3/project/{projectId}/hierarchy","description":"Get the project hierarchy.","params":[{"name":"projectId","type":"integer","description":"The ID of the project.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectId}/hierarchy' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"32d00592ecea034a022952dcb2b59b8853c2db75c8e4ed5762271087792d00f7"},"Get issue type property keys":{"name":"Get issue type property keys","http_method":"GET","path":"/rest/api/3/issuetype/{issueTypeId}/properties","description":"Returns all the issue type property keys of the issue type.","params":[{"name":"issueTypeId","type":"string","description":"The ID of the issue type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issuetype/{issueTypeId}/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"beca0e7dde1935560f6d681b41e874491ab2d2c169d9536357e18d1479e950ad"},"Get issue type property":{"name":"Get issue type property","http_method":"GET","path":"/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}","description":"Returns the key and value of the issue type property.","params":[{"name":"issueTypeId","type":"string","description":"The ID of the issue type."},{"name":"propertyKey","type":"string","description":"The key of the property. Use Get issue type property keys to get a list of all issue type property keys."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"5060f3c4efba266faf4b5f5144ba7c0a72d16451f90ff7d06d4f464519844453"},"Set issue type property":{"name":"Set issue type property","http_method":"PUT","path":"/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}","description":"Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type.","params":[{"name":"issueTypeId","type":"string","description":"The ID of the issue type."},{"name":"propertyKey","type":"string","description":"The key of the issue type property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"number\": 5,\n  \"string\": \"string-value\"\n}'","digest":"18a88113aea4690d230a9e6150e25f0e5c89c3399cb9f98d0e728dc65db7bc29"},"Delete issue type property":{"name":"Delete issue type property","http_method":"DELETE","path":"/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}","description":"Deletes the issue type property.","params":[{"name":"issueTypeId","type":"string","description":"The ID of the issue type."},{"name":"propertyKey","type":"string","description":"The key of the property. Use Get issue type property keys to get a list of all issue type property keys."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"28e3c68a5fd59d934aadd05ad4fc978f22774aed87063f4c4d9437982c2c4d87"},"Get votes":{"name":"Get votes","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/votes","description":"Returns details about the votes on an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/votes' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"611af9a82053c3e9fe8cb049bde8775b71c51d5fcf451201585f243a9cf56961"},"Add vote":{"name":"Add vote","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/votes","description":"Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/votes' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b0b974703d6dbd414eed3fc789e06884c2e2d73cb18735a22917b06d8787bf45"},"Delete vote":{"name":"Delete vote","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/votes","description":"Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/votes' \\\n  --user 'email@example.com:<api_token>'","digest":"eacfa86397fafca2e8c95cac34f3178e7934eb97101a0cbf08f83d00372ddc9f"},"Get issue watchers":{"name":"Get issue watchers","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/watchers","description":"Returns the watchers for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/watchers' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"5b99ac8667893bf4646da9cb9c4d1a66ee68f43c88c102b8c19b9170b56e72a5"},"Add watcher":{"name":"Add watcher","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/watchers","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.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/watchers' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '\"<string>\"'","digest":"f9d5a2a527b87aea06124381bd027301640071d506b4f5eb6c35761b1911d003"},"Delete watcher":{"name":"Delete watcher","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/watchers","description":"Deletes a user as a watcher of an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/watchers?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>'","digest":"542476126284ff0e9097554019eb0ce9dd650dc95555764ed06b918df5699018"},"Get issue worklogs":{"name":"Get issue worklogs","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/worklog","description":"Returns all worklogs for an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1048576.","default":"1048576"},{"name":"expand","type":"string","description":"Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties.","default":""}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"616b098ff513db54b9012de8e38a469ddc458ec2c2d6e484e87c25f645c8f5c6"},"Add worklog":{"name":"Add worklog","http_method":"POST","path":"/rest/api/3/issue/{issueIdOrKey}/worklog","description":"Adds a worklog to an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key the issue."},{"name":"notifyUsers","type":"boolean","description":"Indicates whether users watching the issue are notified by email.","default":"true"},{"name":"adjustEstimate","type":"string","description":"Defines how to update the issue's time estimate, the options are:","default":"auto"},{"name":"newEstimate","type":"string","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":"reduceBy","type":"string","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":"expand","type":"string","description":"Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.","default":""},{"name":"overrideEditableFlag","type":"boolean","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.","default":"false"}],"command":"curl --request POST \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"timeSpentSeconds\": 12000,\n  \"visibility\": {\n    \"type\": \"group\",\n    \"value\": \"jira-developers\"\n  },\n  \"comment\": {\n    \"type\": \"doc\",\n    \"version\": 1,\n    \"content\": [\n      {\n        \"type\": \"paragraph\",\n        \"content\": [\n          {\n            \"text\": \"I did some work here.\",\n            \"type\": \"text\"\n          }\n        ]\n      }\n    ]\n  },\n  \"started\": \"2019-10-25T06:03:31.173+0000\"\n}'","digest":"31618e3cf07c7e3967f925bf3e98284ffceee13ae15909421aebfffcd026b041"},"Get worklog":{"name":"Get worklog","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{id}","description":"Returns a worklog.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"id","type":"string","description":"The ID of the worklog."},{"name":"expand","type":"string","description":"Use expand to include additional information about work logs in the response. This parameter accepts","default":""}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"154a6e2121a17c46fb5288646146ef16001db440760aa8accbcb5b7e55ca704c"},"Update worklog":{"name":"Update worklog","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{id}","description":"Updates a worklog.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key the issue."},{"name":"id","type":"string","description":"The ID of the worklog."},{"name":"notifyUsers","type":"boolean","description":"Indicates whether users watching the issue are notified by email.","default":"true"},{"name":"adjustEstimate","type":"string","description":"Defines how to update the issue's time estimate, the options are:","default":"auto"},{"name":"newEstimate","type":"string","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":"expand","type":"string","description":"Use expand to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties.","default":""},{"name":"overrideEditableFlag","type":"boolean","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.","default":"false"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"timeSpentSeconds\": 12000,\n  \"visibility\": {\n    \"type\": \"group\",\n    \"value\": \"jira-developers\"\n  },\n  \"comment\": {\n    \"type\": \"doc\",\n    \"version\": 1,\n    \"content\": [\n      {\n        \"type\": \"paragraph\",\n        \"content\": [\n          {\n            \"text\": \"I did some work here.\",\n            \"type\": \"text\"\n          }\n        ]\n      }\n    ]\n  },\n  \"started\": \"2019-10-25T06:03:31.173+0000\"\n}'","digest":"5186b152e365fc123b0d4a60391d4213ede277dd6f76b181e9d9b32047a472cc"},"Delete worklog":{"name":"Delete worklog","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{id}","description":"Deletes a worklog from an issue.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"id","type":"string","description":"The ID of the worklog."},{"name":"notifyUsers","type":"boolean","description":"Indicates whether users watching the issue are notified by email.","default":"true"},{"name":"adjustEstimate","type":"string","description":"Defines how to update the issue's time estimate, the options are:","default":"auto"},{"name":"newEstimate","type":"string","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":"increaseBy","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":"overrideEditableFlag","type":"boolean","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.","default":"false"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"764874323c225fdb22e0db33a809a32e2396db5a0eb306bf0ab9f33421b57ea4"},"Get IDs of deleted worklogs":{"name":"Get IDs of deleted worklogs","http_method":"GET","path":"/rest/api/3/worklog/deleted","description":"Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.","params":[{"name":"since","type":"integer","description":"The date and time, in UNIX timestamp format, after which deleted worklogs are returned.","default":"0"}],"command":"curl --request GET \\\n  --url '/rest/api/3/worklog/deleted' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7d6e8ac4c96fc1d4f628961c739ff58483dddb277bd89dc0c458c26e359a533e"},"Get worklogs":{"name":"Get worklogs","http_method":"POST","path":"/rest/api/3/worklog/list","description":"Returns worklog details for a list of worklog IDs.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.","default":""}],"command":"curl --request POST \\\n  --url '/rest/api/3/worklog/list' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"ids\": [\n    1,\n    2,\n    5,\n    10\n  ]\n}'","digest":"bbbc33fa991ea393febcf2115fa58ea56d80af453ea683c3f353730706bc6d3b"},"Get IDs of updated worklogs":{"name":"Get IDs of updated worklogs","http_method":"GET","path":"/rest/api/3/worklog/updated","description":"Returns a list of IDs and update timestamps for worklogs updated after a date and time.","params":[{"name":"since","type":"integer","description":"The date and time, in UNIX timestamp format, after which updated worklogs are returned.","default":"0"},{"name":"expand","type":"string","description":"Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.","default":""}],"command":"curl --request GET \\\n  --url '/rest/api/3/worklog/updated' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"92862b28d81ba0f8f85579cd82288586217930badd7466175ff235b633eb6b0d"},"Get worklog property keys":{"name":"Get worklog property keys","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties","description":"Returns the keys of all properties for a worklog.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"worklogId","type":"string","description":"The ID of the worklog."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c2d453497bfd1e401f250b1b7aacaec9aed83a0e1dda984842360e518f183278"},"Get worklog property":{"name":"Get worklog property","http_method":"GET","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}","description":"Returns the value of a worklog property.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"worklogId","type":"string","description":"The ID of the worklog."},{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request GET \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9da35ab529dcaef7604c2b1805974e1f1fd8d64d19d64aa949146d353576e0bd"},"Set worklog property":{"name":"Set worklog property","http_method":"PUT","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}","description":"Sets the value of a worklog property. Use this operation to store custom data against the worklog.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"worklogId","type":"string","description":"The ID of the worklog."},{"name":"propertyKey","type":"string","description":"The key of the issue property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{}'","digest":"9baae9c4629a97c68c4648133a002038a0bdd4f0fa278cad9451d72e288e6533"},"Delete worklog property":{"name":"Delete worklog property","http_method":"DELETE","path":"/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}","description":"Deletes a worklog property.","params":[{"name":"issueIdOrKey","type":"string","description":"The ID or key of the issue."},{"name":"worklogId","type":"string","description":"The ID of the worklog."},{"name":"propertyKey","type":"string","description":"The key of the property."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"112851c0bb5d3d570d60b8f573d8b463316c476e8d023942ddacd6ad95bc4659"},"Evaluate Jira expression":{"name":"Evaluate Jira expression","http_method":"POST","path":"/rest/api/3/expression/eval","description":"Evaluates a Jira expression and returns its value.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts meta.complexity, which 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. Useful when designing and debugging your expressions."}],"command":"curl --request POST \\\n  --url '/rest/api/3/expression/eval' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"expression\": \"{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }\",\n  \"context\": {\n    \"issue\": {\n      \"key\": \"ACJIRA-1470\"\n    },\n    \"sprint\": 10001,\n    \"project\": {\n      \"key\": \"ACJIRA\"\n    },\n    \"serviceDesk\": 10023,\n    \"issues\": {\n      \"jql\": {\n        \"maxResults\": 100,\n        \"query\": \"project = HSP\",\n        \"startAt\": 0,\n        \"validation\": \"strict\"\n      }\n    },\n    \"board\": 10100,\n    \"customerRequest\": 1450\n  }\n}'","digest":"9ee3e31cf2654691c60191fc5b20131eed92df76cd6d9362e5760377f0bc86d8"},"Get application property":{"name":"Get application property","http_method":"GET","path":"/rest/api/3/application-properties","description":"Returns all application properties or an application property.","params":[{"name":"key","type":"string","description":"The key of the application property."},{"name":"permissionLevel","type":"string","description":"The permission level of all items being returned in the list."},{"name":"keyFilter","type":"string","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.."}],"command":"curl --request GET \\\n  --url '/rest/api/3/application-properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"0ef37941e6aa164e4afb32c9ad4be4232c8a68d76c9b7e570d4002a021bbbf25"},"Get advanced settings":{"name":"Get advanced settings","http_method":"GET","path":"/rest/api/3/application-properties/advanced-settings","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).","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/application-properties/advanced-settings' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"41a685b816d36e27aae821f5fd27aa86229f8af1c08367a0c260a8d81277cb12"},"Set application property":{"name":"Set application property","http_method":"PUT","path":"/rest/api/3/application-properties/{id}","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.","params":[{"name":"id","type":"string","description":"The key of the application property to update."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/application-properties/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"id\": \"jira.home\",\n  \"value\": \"/var/jira/jira-home\"\n}'","digest":"3f4df7f1ec2147749e2f3788cc265d29893e4b6eda2313630aa110ee8e6097bb"},"Get global settings":{"name":"Get global settings","http_method":"GET","path":"/rest/api/3/configuration","description":"Returns the global settings 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.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/configuration' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"4e34fa30ae9d483efbe299c585ed7fa5d4fa45f18705db8fd1209ad90923eb37"},"Get field reference data":{"name":"Get field reference data","http_method":"GET","path":"/rest/api/3/jql/autocompletedata","description":"Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, 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.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/jql/autocompletedata' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d9633e662e6fd1f1dddb2322c83ba62bfdfc0bb761dc9bb61951483762dc8645"},"Get field auto complete suggestions":{"name":"Get field auto complete suggestions","http_method":"GET","path":"/rest/api/3/jql/autocompletedata/suggestions","description":"Returns the JQL search auto complete suggestions for a field.","params":[{"name":"fieldName","type":"string","description":"The name of the field."},{"name":"fieldValue","type":"string","description":"The partial field item name entered by the user."},{"name":"predicateName","type":"string","description":"The name of the  CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to."},{"name":"predicateValue","type":"string","description":"The partial predicate item name entered by the user."}],"command":"curl --request GET \\\n  --url '/rest/api/3/jql/autocompletedata/suggestions?fieldName={fieldName}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"528dbeb9c8b29edde43d1804014e8356fb22c480c638ed3036690b1aeb5e897b"},"Parse JQL query":{"name":"Parse JQL query","http_method":"POST","path":"/rest/api/3/jql/parse","description":"POST /rest/api/3/jql/parse","params":[{"name":"queries","type":"Array<string>","description":"A list of queries to parse.","default":"1"}],"command":"curl --request POST \\\n  --url '/rest/api/3/jql/parse' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"queries\": \"{queries}\"\n}'","digest":"9203ddc99117a64bf134c92d473ac3ea4005cade6b8fcb7108cb3038911bebd1"},"Convert user identifiers to account IDs in JQL queries":{"name":"Convert user identifiers to account IDs in JQL queries","http_method":"POST","path":"/rest/api/3/jql/pdcleaner","description":"Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.","params":[{"name":"queryStrings","type":"Array<string>","description":"A list of queries with user identifiers. Maximum of 100 queries."}],"command":"curl --request POST \\\n  --url '/rest/api/3/jql/pdcleaner' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"queryStrings\": \"{queryStrings}\"\n}'","digest":"c217fb29036d792585e5033b410d05006c6f943bcd018b4dd0ce9f81fe7828b4"},"Get all labels":{"name":"Get all labels","http_method":"GET","path":"/rest/api/3/label","description":"Returns a paginated list of available labels.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"1000"}],"command":"curl --request GET \\\n  --url '/rest/api/3/label' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"241cdc8375afd425c64b6a28161ce2eeb57b31dcc33addc882b5016ee534ee75"},"Get preference":{"name":"Get preference","http_method":"GET","path":"/rest/api/3/mypreferences","description":"Returns the value of a preference of the current user.","params":[{"name":"key","type":"string","description":"The key of the preference."}],"command":"curl --request GET \\\n  --url '/rest/api/3/mypreferences?key={key}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"dac8849c5d5e3434a625dd36ebc9d89e15d5c9eebd7f8e369489d7fa61b03261"},"Set preference":{"name":"Set preference","http_method":"PUT","path":"/rest/api/3/mypreferences","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:","params":[{"name":"key","type":"string","description":"The key of the preference. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/mypreferences?key={key}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '\"<string>\"'","digest":"bf10ada60d475d9bc339551f9de281265021f8e466b0d94197cb9cd1cc095006"},"Delete preference":{"name":"Delete preference","http_method":"DELETE","path":"/rest/api/3/mypreferences","description":"Deletes a preference of the user, which restores the default value of system defined settings.","params":[{"name":"key","type":"string","description":"The key of the preference."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/mypreferences?key={key}' \\\n  --user 'email@example.com:<api_token>'","digest":"daaac4f28808c5242e3ce42c9bce899faa53953f83afe1267c6650f1dfd0d727"},"Get locale":{"name":"Get locale","http_method":"GET","path":"/rest/api/3/mypreferences/locale","description":"Returns the locale for the user.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/mypreferences/locale' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"4a76c38c0cf54c0f0ecb4210628f364b06b243f2320108f62d12634da69e11b3"},"Set locale":{"name":"Set locale","http_method":"PUT","path":"/rest/api/3/mypreferences/locale","description":"PUT /rest/api/3/mypreferences/locale","params":[{"name":"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."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/mypreferences/locale' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"locale\": \"{locale}\"\n}'","digest":"42b5d9a07f54b9b1b319f180bcc06e82a10d150cef2689ac715f5440281521c7"},"Delete locale":{"name":"Delete locale","http_method":"DELETE","path":"/rest/api/3/mypreferences/locale","description":"DELETE /rest/api/3/mypreferences/locale","params":[],"command":"curl --request DELETE \\\n  --url '/rest/api/3/mypreferences/locale' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"a9a1fdff7f32c5bb643d0c1fdf641173fead43a945fbbb560337e8ac6dbf0110"},"Get current user":{"name":"Get current user","http_method":"GET","path":"/rest/api/3/myself","description":"Returns details for the current user.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/myself' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"576898483e2f9e699d24ba8b4984861d7f98fb408cec45e954472961279f70af"},"Get my permissions":{"name":"Get my permissions","http_method":"GET","path":"/rest/api/3/mypermissions","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.","params":[{"name":"projectKey","type":"string","description":"The key of project. Ignored if projectId is provided."},{"name":"projectId","type":"string","description":"The ID of project."},{"name":"issueKey","type":"string","description":"The key of the issue. Ignored if issueId is provided."},{"name":"issueId","type":"string","description":"The ID of the issue."},{"name":"permissions","type":"string","description":"A list of permission keys. This parameter accepts a comma-separated list.  Omitting this parameter is deprecated. To get the list of available permissions, use Get all permissions. Note that deprecated keys cannot be used. Deprecated keys are not returned by Get all permissions but are returned by this operation if permissions is omitted."},{"name":"projectUuid","type":"string"},{"name":"projectConfigurationUuid","type":"string"}],"command":"curl --request GET \\\n  --url '/rest/api/3/mypermissions?permissions={permissions}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b9063e1694725691d12a9f668620d2e913b306812c08d876dda2ee6643c1a61a"},"Get all permissions":{"name":"Get all permissions","http_method":"GET","path":"/rest/api/3/permissions","description":"Returns all permissions, including:","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/permissions' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9da1ed27a14f25c22837a547585897fd47c3f98c56bccfb374223da64a845826"},"Get bulk permissions":{"name":"Get bulk permissions","http_method":"POST","path":"/rest/api/3/permissions/check","description":"Returns:","params":[{"name":"projectPermissions","type":"Array<BulkProjectPermissions>","description":"Project permissions with associated projects and issues to look up.","default":"true"},{"name":"globalPermissions","type":"Array<string>","description":"Global permissions to look up.","default":"true"}],"command":"curl --request POST \\\n  --url '/rest/api/3/permissions/check' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"globalPermissions\": \"{globalPermissions}\",\n  \"projectPermissions\": \"{projectPermissions}\"\n}'","digest":"0d98597433347fc6be1604ed0f7d47be5d1dc76f1cab7e512e6dc6ed5ff2af56"},"Get permitted projects":{"name":"Get permitted projects","http_method":"POST","path":"/rest/api/3/permissions/project","description":"Returns all the projects where the user is granted a list of project permissions.","params":[{"name":"permissions","type":"Array<string>","description":"A list of permission keys."}],"command":"curl --request POST \\\n  --url '/rest/api/3/permissions/project' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"permissions\": \"{permissions}\"\n}'","digest":"0692ceb9ed6ea638fdafdf58cdef336e386cccca87fa5b098e036172270beb32"},"Get all permission schemes":{"name":"Get all permission schemes","http_method":"GET","path":"/rest/api/3/permissionscheme","description":"Returns all permission schemes.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/permissionscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"74fd0adb83dff0592cd034c83cfd0432f53020ab61f587ebafa7a34327454c41"},"Create permission scheme":{"name":"Create permission scheme","http_method":"POST","path":"/rest/api/3/permissionscheme","description":"Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:"}],"command":"curl --request POST \\\n  --url '/rest/api/3/permissionscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"permissions\": [\n    {\n      \"holder\": {\n        \"parameter\": \"jira-core-users\",\n        \"type\": \"group\"\n      },\n      \"permission\": \"ADMINISTER_PROJECTS\"\n    }\n  ],\n  \"name\": \"Example permission scheme\",\n  \"description\": \"description\"\n}'","digest":"bc656a60e89004e45fc03742573f3a7ab1a08cdab5221f23ffcf0731353a47f8"},"Get permission scheme":{"name":"Get permission scheme","http_method":"GET","path":"/rest/api/3/permissionscheme/{schemeId}","description":"Returns a permission scheme.","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme to return.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/permissionscheme/{schemeId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"14306892192090cecd663dc9ba622ffa8055d046e47d201e6372c408a39236ef"},"Update permission scheme":{"name":"Update permission scheme","http_method":"PUT","path":"/rest/api/3/permissionscheme/{schemeId}","description":"Updates a permission scheme. Below are some important things to note when using this resource:","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme to update.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/permissionscheme/{schemeId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"permissions\": [\n    {\n      \"holder\": {\n        \"parameter\": \"jira-core-users\",\n        \"type\": \"group\"\n      },\n      \"permission\": \"ADMINISTER_PROJECTS\"\n    }\n  ],\n  \"name\": \"Example permission scheme\",\n  \"description\": \"description\"\n}'","digest":"a89a46f01da8835f5233920add829bdc48dc7f6eb541bf13a18b94e33740f35a"},"Delete permission scheme":{"name":"Delete permission scheme","http_method":"DELETE","path":"/rest/api/3/permissionscheme/{schemeId}","description":"Deletes a permission scheme.","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme being deleted.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/permissionscheme/{schemeId}' \\\n  --user 'email@example.com:<api_token>'","digest":"2ff9213a67b52d9eefbc226d3bf1d45a9d93d190c68633d449b5b300a9da2f2b"},"Get permission scheme grants":{"name":"Get permission scheme grants","http_method":"GET","path":"/rest/api/3/permissionscheme/{schemeId}/permission","description":"Returns all permission grants for a permission scheme.","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/permissionscheme/{schemeId}/permission' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"dd672c7c424a5976f7555fa2dcf319a7edfe22e88007fe410d8fdd1e53e4f50f"},"Create permission grant":{"name":"Create permission grant","http_method":"POST","path":"/rest/api/3/permissionscheme/{schemeId}/permission","description":"Creates a permission grant in a permission scheme.","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme in which to create a new permission grant.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:"}],"command":"curl --request POST \\\n  --url '/rest/api/3/permissionscheme/{schemeId}/permission' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"holder\": {\n    \"parameter\": \"jira-core-users\",\n    \"type\": \"group\"\n  },\n  \"permission\": \"ADMINISTER_PROJECTS\"\n}'","digest":"1198feb8aec8157155fc4895691a6e30df98aa328951177fc61f954879b72779"},"Get permission scheme grant":{"name":"Get permission scheme grant","http_method":"GET","path":"/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}","description":"Returns a permission grant.","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme.","default":"int64"},{"name":"permissionId","type":"integer","description":"The ID of the permission grant.","default":"int64"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"8e64db2e68889a15629b10eb6119f9d55957c55490de9f07041e584fb15152f8"},"Delete permission scheme grant":{"name":"Delete permission scheme grant","http_method":"DELETE","path":"/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}","description":"Deletes a permission grant from a permission scheme. See About permission schemes and grants for more details.","params":[{"name":"schemeId","type":"integer","description":"The ID of the permission scheme to delete the permission grant from.","default":"int64"},{"name":"permissionId","type":"integer","description":"The ID of the permission grant to delete.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/permissionscheme/{schemeId}/permission/{permissionId}' \\\n  --user 'email@example.com:<api_token>'","digest":"f27fa3b62bbd5430e152f0163ee1b84da27bc74a9745f862572ab4db9c1e414e"},"Get all projects":{"name":"Get all projects","http_method":"GET","path":"/rest/api/3/project","description":"GET /rest/api/3/project","params":[{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:"},{"name":"recent","type":"integer","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.","default":"int32"},{"name":"properties","type":"Array<string>","description":"A list of project properties to return for the project. This parameter accepts a comma-separated list."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"8b79912f0ed58447b0062f9e1796afacbd4048723db661e5c04fa866c93bb57d"},"Create project":{"name":"Create project","http_method":"POST","path":"/rest/api/3/project","description":"Creates a project based on a project type template, as shown in the following table:","params":[{"name":"key","type":"string","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."},{"name":"name","type":"string","description":"The name of the project. Required when creating a project. Optional when updating a project."},{"name":"projectTypeKey","type":"string","description":"The project type, which dictates the application-specific feature set. Required when creating a project. Not applicable for the Update project resource."},{"name":"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."},{"name":"description","type":"string","description":"A brief description of the project."},{"name":"lead","type":"string","description":"This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the 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."},{"name":"leadAccountId","type":"string","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."},{"name":"url","type":"string","description":"A link to information about this project, such as project documentation"},{"name":"assigneeType","type":"string","description":"The default assignee when creating issues for this project."},{"name":"avatarId","type":"integer","description":"An integer value for the project's avatar.","default":"int64"},{"name":"issueSecurityScheme","type":"integer","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 resource to get all issue security scheme IDs.","default":"int64"},{"name":"permissionScheme","type":"integer","description":"The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.","default":"int64"},{"name":"notificationScheme","type":"integer","description":"The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.","default":"int64"},{"name":"categoryId","type":"integer","description":"The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/project' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"notificationScheme\": \"{notificationScheme}\",\n  \"description\": \"{description}\",\n  \"lead\": \"{lead}\",\n  \"url\": \"{url}\",\n  \"projectTemplateKey\": \"{projectTemplateKey}\",\n  \"avatarId\": \"{avatarId}\",\n  \"issueSecurityScheme\": \"{issueSecurityScheme}\",\n  \"name\": \"{name}\",\n  \"permissionScheme\": \"{permissionScheme}\",\n  \"assigneeType\": \"{assigneeType}\",\n  \"projectTypeKey\": \"{projectTypeKey}\",\n  \"key\": \"{key}\",\n  \"categoryId\": \"{categoryId}\"\n}'","digest":"8217f1f8bcef46afa07ac84f964c708f9d6a610d31d68866d35af36408d786c4"},"Get projects paginated":{"name":"Get projects paginated","http_method":"GET","path":"/rest/api/3/project/search","description":"Returns projects visible to the user.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 50.","default":"50"},{"name":"orderBy","type":"string","description":"Order the results by a field. If the orderBy field is not set, then projects are listed in ascending order by project key:","default":"key"},{"name":"query","type":"string","description":"Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive)."},{"name":"typeKey","type":"string","description":"Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software."},{"name":"categoryId","type":"integer","description":"The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.","default":"int64"},{"name":"searchBy","type":"string","default":"key, name"},{"name":"action","type":"string","description":"Filter results by projects for which the user can:","default":"view"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"63cd4ca6bb1acf326c4c11343f550b119359f4c4c3c41c8a67d5e889f6fb5fa3"},"Get project":{"name":"Get project","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}","description":"Returns the project details for a project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:"},{"name":"properties","type":"Array<string>","description":"A list of project properties to return for the project. This parameter accepts a comma-separated list."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d7318c289822fc8073f97e8eb9b219fe3dae0d69f5e09ea83d8f14ec18874cb9"},"Update project":{"name":"Update project","http_method":"PUT","path":"/rest/api/3/project/{projectIdOrKey}","description":"Updates the project details of a project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/project/{projectIdOrKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"notificationScheme\": 10021,\n  \"description\": \"Example Project description\",\n  \"lead\": \"Charlie\",\n  \"url\": \"http://atlassian.com\",\n  \"projectTemplateKey\": \"com.atlassian.jira-core-project-templates:jira-core-simplified-process-control\",\n  \"avatarId\": 10200,\n  \"issueSecurityScheme\": 10001,\n  \"name\": \"Example\",\n  \"permissionScheme\": 10011,\n  \"assigneeType\": \"PROJECT_LEAD\",\n  \"projectTypeKey\": \"business\",\n  \"key\": \"EX\",\n  \"categoryId\": 10120\n}'","digest":"efbf7eac5d961a6f3a583117c9257a35df820192a06fb11083a1868dfff82825"},"Delete project":{"name":"Delete project","http_method":"DELETE","path":"/rest/api/3/project/{projectIdOrKey}","description":"Deletes a project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/project/{projectIdOrKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"059772399921ca753d327756fad1b91a78885c83ff406c0b5d2777afa4fe7ebf"},"Get all statuses for project":{"name":"Get all statuses for project","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/statuses","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.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/statuses' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"00e9265a1442315dc1dc2acab27f5d5efdfc592e4f36f9bea32d7a8ea179adb4"},"Update project type":{"name":"Update project type","http_method":"PUT","path":"/rest/api/3/project/{projectIdOrKey}/type/{newProjectTypeKey}","description":"PUT /rest/api/3/project/{projectIdOrKey}/type/{newProjectTypeKey}","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"newProjectTypeKey","type":"string","description":"The key of the new project type."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/project/{projectIdOrKey}/type/{newProjectTypeKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"80ef3c2ede79e7b02519190275774502d00627e2deae1cc3bcf8ff135f85fecc"},"Get project notification scheme":{"name":"Get project notification scheme","http_method":"GET","path":"/rest/api/3/project/{projectKeyOrId}/notificationscheme","description":"Gets a notification scheme associated with the project. See the Get notification scheme resource for more information about notification schemes.","params":[{"name":"projectKeyOrId","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectKeyOrId}/notificationscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"a0e5abbfe200e0b381fad97aa65d2b670c9ee910aba5cda64a548b50a6d7c8cb"},"Set project avatar":{"name":"Set project avatar","http_method":"PUT","path":"/rest/api/3/project/{projectIdOrKey}/avatar","description":"Sets the avatar displayed for a project.","params":[{"name":"projectIdOrKey","type":"string","description":"The ID or (case-sensitive) key of the project."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/project/{projectIdOrKey}/avatar' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"id\": \"10010\"\n}'","digest":"762c8a89d6ae827da7b9d40f043ee6d59f4ea02725069d4105fe09d03dab7ce8"},"Delete project avatar":{"name":"Delete project avatar","http_method":"DELETE","path":"/rest/api/3/project/{projectIdOrKey}/avatar/{id}","description":"Deletes a custom avatar from a project. Note that system avatars cannot be deleted.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or (case-sensitive) key."},{"name":"id","type":"integer","description":"The ID of the avatar.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/project/{projectIdOrKey}/avatar/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"df21c3f4207831703f54a0ac402094c3d91a8441d5da7a72dd0649872fe1d4c1"},"Load project avatar":{"name":"Load project avatar","http_method":"POST","path":"/rest/api/3/project/{projectIdOrKey}/avatar2","description":"Loads an avatar for a project.","params":[{"name":"projectIdOrKey","type":"string","description":"The ID or (case-sensitive) key of the project."},{"name":"x","type":"integer","description":"The X coordinate of the top-left corner of the crop region.","default":"0"},{"name":"y","type":"integer","description":"The Y coordinate of the top-left corner of the crop region.","default":"0"},{"name":"size","type":"integer","description":"The length of each side of the crop region.","default":"int32"}],"command":"curl --request POST \\\n  --url '/rest/api/3/project/{projectIdOrKey}/avatar2' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"24ba917c6713a3da24c4505728aae1301f93fa5a0d32d2f0fcb8a20b48d0c48a"},"Get all project avatars":{"name":"Get all project avatars","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/avatars","description":"Returns all project avatars, grouped by system and custom avatars.","params":[{"name":"projectIdOrKey","type":"string","description":"The ID or (case-sensitive) key of the project."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/avatars' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"3f799c9e16cfa39c4e4043c96cfdbfab2e68069a15d83477638121d5fcc753c4"},"Get all project categories":{"name":"Get all project categories","http_method":"GET","path":"/rest/api/3/projectCategory","description":"Returns all project categories.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/projectCategory' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d1d905f56b31f0236544c9fc96754704b784c3881b6caf018a0c71030129a53a"},"Create project category":{"name":"Create project category","http_method":"POST","path":"/rest/api/3/projectCategory","description":"Creates a project category.","params":[{"name":"name","type":"string","description":"The name of the project category. Required on create, optional on update."},{"name":"description","type":"string","description":"The description of the project category. Required on create, optional on update."}],"command":"curl --request POST \\\n  --url '/rest/api/3/projectCategory' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"{name}\",\n  \"description\": \"{description}\"\n}'","digest":"edf6559277002c6d388b8a8d431095ba230d5586647642360bc240fa12eb7bbe"},"Get project category by id":{"name":"Get project category by id","http_method":"GET","path":"/rest/api/3/projectCategory/{id}","description":"Returns a project category.","params":[{"name":"id","type":"integer","description":"The ID of the project category.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/projectCategory/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"565dde540acce73fc301d286d3564e9a6cb742c36aa69fd015e140d304842aa5"},"Update project category":{"name":"Update project category","http_method":"PUT","path":"/rest/api/3/projectCategory/{id}","description":"Updates a project category.","params":[{"name":"id","type":"integer","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/projectCategory/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"UPDATED\",\n  \"description\": \"Updated Project Category\"\n}'","digest":"e1415acf5733c09e2ec518c49a6c26bc841b01fd4f9119416a9079a14959c7fa"},"Delete project category":{"name":"Delete project category","http_method":"DELETE","path":"/rest/api/3/projectCategory/{id}","description":"Deletes a project category.","params":[{"name":"id","type":"integer","description":"ID of the project category to delete.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/projectCategory/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"75d84f253711b68d926dbf246fe94dcadf395d44a682a179de9a2375faa08a75"},"Create component":{"name":"Create component","http_method":"POST","path":"/rest/api/3/component","description":"Creates a component. Use components to provide containers for issues within a project.","params":[{"name":"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."},{"name":"description","type":"string","description":"The description for the component. Optional when creating or updating a component."},{"name":"leadUserName","type":"string","description":"This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"leadAccountId","type":"string","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."},{"name":"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. Can take the following values:"},{"name":"project","type":"string","description":"The key of the project the component is assigned to. Required when creating a component. Can't be updated."}],"command":"curl --request POST \\\n  --url '/rest/api/3/component' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"isAssigneeTypeValid\": false,\n  \"name\": \"{name}\",\n  \"description\": \"{description}\",\n  \"project\": \"{project}\",\n  \"assigneeType\": \"{assigneeType}\",\n  \"leadAccountId\": \"{leadAccountId}\"\n}'","digest":"73b70caed2f8899b30e9d9c6695b61e5bddc24ae3ea5eaed7ba53a07e8ca16c8"},"Get component":{"name":"Get component","http_method":"GET","path":"/rest/api/3/component/{id}","description":"Returns a component.","params":[{"name":"id","type":"string","description":"The ID of the component."}],"command":"curl --request GET \\\n  --url '/rest/api/3/component/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7d4f2466b819b0079a0145343e2258307ce0215f2caceb848a1d5f358749478e"},"Update component":{"name":"Update component","http_method":"PUT","path":"/rest/api/3/component/{id}","description":"Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string (\"\") the component lead is removed.","params":[{"name":"id","type":"string","description":"The ID of the component."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/component/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"isAssigneeTypeValid\": false,\n  \"name\": \"Component 1\",\n  \"description\": \"This is a Jira component\",\n  \"assigneeType\": \"PROJECT_LEAD\",\n  \"leadAccountId\": \"5b10a2844c20165700ede21g\"\n}'","digest":"295a6f4e6c7b2536a9629337a0217dc156d252cbc952bdfbd434366c569ba24f"},"Delete component":{"name":"Delete component","http_method":"DELETE","path":"/rest/api/3/component/{id}","description":"Deletes a component.","params":[{"name":"id","type":"string","description":"The ID of the component."},{"name":"moveIssuesTo","type":"string","description":"The ID of the component to replace the deleted component. If this value is null no replacement is made."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/component/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"0cb1a88be7c8d7c958bb3efe98c59f7ed2b9af726161b3f2e517006911b51408"},"Get component issues count":{"name":"Get component issues count","http_method":"GET","path":"/rest/api/3/component/{id}/relatedIssueCounts","description":"Returns the counts of issues assigned to the component.","params":[{"name":"id","type":"string","description":"The ID of the component."}],"command":"curl --request GET \\\n  --url '/rest/api/3/component/{id}/relatedIssueCounts' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"da99954981770073d2f4a40541a50eae779ec43f53eaddb1381db4c92e1a1919"},"Get project components paginated":{"name":"Get project components paginated","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/component","description":"Returns a paginated representation of all components in a project. See the Get project components resource if you want to get a full list of versions without pagination.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 50.","default":"50"},{"name":"orderBy","type":"string","description":"Order the results by a field:"},{"name":"query","type":"string","description":"Filter the results using a literal string. Components with a matching name or description are returned (case insensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/component' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9d7c8805cefa5e6ab9312577f66d8c4158581bb6ad20ad616854f1058fd4a808"},"Get project components":{"name":"Get project components","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/components","description":"Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/components' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"4a816745d71033b01d192e26cea268f444e957b3bb6aa6ea8fb4d9f625578347"},"Validate project key":{"name":"Validate project key","http_method":"GET","path":"/rest/api/3/projectvalidate/key","description":"Validates a project key by confirming the key is a valid string and not in use.","params":[{"name":"key","type":"string","description":"The project key."}],"command":"curl --request GET \\\n  --url '/rest/api/3/projectvalidate/key?key={key}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"363b766962f873dfa641b5a5e7d7ebdf76056b5833e29ddd65f2efe23bde9e3e"},"Get valid project key":{"name":"Get valid project key","http_method":"GET","path":"/rest/api/3/projectvalidate/validProjectKey","description":"Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.","params":[{"name":"key","type":"string","description":"The project key."}],"command":"curl --request GET \\\n  --url '/rest/api/3/projectvalidate/validProjectKey?key={key}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"bf475509b23a0e903da4b9f2d8558a4e8da8d6f925a1e2ce65c4e3f6869660d3"},"Get valid project name":{"name":"Get valid project name","http_method":"GET","path":"/rest/api/3/projectvalidate/validProjectName","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.","params":[{"name":"name","type":"string","description":"The project name."}],"command":"curl --request GET \\\n  --url '/rest/api/3/projectvalidate/validProjectName?name={name}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"924beb0d273552a8b5b8262595fffb930f966a9f07346aca2a4dddc0bc0c09ef"},"Get project issue security scheme":{"name":"Get project issue security scheme","http_method":"GET","path":"/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme","description":"Returns the issue security scheme associated with the project.","params":[{"name":"projectKeyOrId","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"289f7a36db52237a806a6af859a55fbd81bb68da57f5c54041bf58c2b1a8b3bd"},"Get assigned permission scheme":{"name":"Get assigned permission scheme","http_method":"GET","path":"/rest/api/3/project/{projectKeyOrId}/permissionscheme","description":"Gets the permission scheme associated with the project.","params":[{"name":"projectKeyOrId","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectKeyOrId}/permissionscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"0e1c89bb09053f7a8597665c9c6717454d2831d582e26ae66106c3a32bc98d49"},"Assign permission scheme":{"name":"Assign permission scheme","http_method":"PUT","path":"/rest/api/3/project/{projectKeyOrId}/permissionscheme","description":"Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.","params":[{"name":"projectKeyOrId","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/project/{projectKeyOrId}/permissionscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"id\": 10000\n}'","digest":"e1996d80582360dd9293e5708e03c4d25acfc74bb16e3a25828b5bb44f861db2"},"Get project issue security levels":{"name":"Get project issue security levels","http_method":"GET","path":"/rest/api/3/project/{projectKeyOrId}/securitylevel","description":"Returns all issue security levels for the project that the user has access to.","params":[{"name":"projectKeyOrId","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectKeyOrId}/securitylevel' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c8612ae432ee122570f7e0b525dd0e579e6f3271e0e56c1262b3c82d7fe69173"},"Get project property keys":{"name":"Get project property keys","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/properties","description":"Returns all project property keys for the project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/properties' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"fc7406b3d17137999e024d91257d658dafeaf7c3913b67a7af089844966857d9"},"Get project property":{"name":"Get project property","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}","description":"Returns the value of a project property.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"propertyKey","type":"string","description":"The project property key. Use Get project property keys to get a list of all project property keys."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"5369ebbd0f1df58fde75079967f00f3de68c631ec665084c4ee7dde791a53785"},"Set project property":{"name":"Set project property","http_method":"PUT","path":"/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}","description":"Sets the value of the project property. You can use project properties to store custom data against the project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"propertyKey","type":"string","description":"The key of the project property. The maximum length is 255 characters."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"number\": 5,\n  \"string\": \"string-value\"\n}'","digest":"4c147cc2b52990c4e77c6886087286ca8fa0d3c6942c7e39af5394add62e7395"},"Delete project property":{"name":"Delete project property","http_method":"DELETE","path":"/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}","description":"Deletes the property from a project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"propertyKey","type":"string","description":"The project property key. Use Get project property keys to get a list of all project property keys."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}' \\\n  --user 'email@example.com:<api_token>'","digest":"f292bfab71e9c73d1779d43c5f58d8f0f954601d2f4941a62fbf7f84251a8a28"},"Get project roles for project":{"name":"Get project roles for project","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/role","description":"Returns a list of project roles for the project returning the name and self URL for each role.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/role' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"f15dd44fa61fb34b5f0da29d0ba434403661676a8bc57cdcf094cdb4a057b5bb"},"Get project role for project":{"name":"Get project role for project","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/role/{id}","description":"Returns a project role's details and actors associated with the project. The list of actors is sorted by display name.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/role/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"0a6047077219b67faab2f4fad4cc30e0caec6d6b4e8a47ca0b71c793a3653bc8"},"Get project role details":{"name":"Get project role details","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/roledetails","description":"Returns all project roles and the details for each role. Note that the list of project roles is common to all projects.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"currentMember","type":"boolean","description":"Whether the roles should be filtered to include only those the user is assigned to.","default":"false"},{"name":"excludeConnectAddons","type":"boolean","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/roledetails' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"337a06264e73807a1df8e9559913797ee5b1d658af7659f80708c872009520cb"},"Get all project roles":{"name":"Get all project roles","http_method":"GET","path":"/rest/api/3/role","description":"Gets a list of all project roles, complete with project role details and default actors.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/role' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"3f383ffb568331c4405d26bbe383cdaf3cf316bb4ced90399edcffe7c4856025"},"Create project role":{"name":"Create project role","http_method":"POST","path":"/rest/api/3/role","description":"Creates a new project role with no default actors. You can use the Add default actors to project role operation to add default actors to the project role after creating it.","params":[{"name":"name","type":"string","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."},{"name":"description","type":"string","description":"A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role."}],"command":"curl --request POST \\\n  --url '/rest/api/3/role' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"{name}\",\n  \"description\": \"{description}\"\n}'","digest":"ff30d45326706b9667038854492bbeb63cce19a9a54042fb81b7aaab55489bd2"},"Get project role by ID":{"name":"Get project role by ID","http_method":"GET","path":"/rest/api/3/role/{id}","description":"Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.","params":[{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/role/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"65ec3ae25c55228b295ee37e000f2a1ee549bfb764de8b87746ac643ab9edc5d"},"Fully update project role":{"name":"Fully update project role","http_method":"PUT","path":"/rest/api/3/role/{id}","description":"Updates the project role's name and description. You must include both a name and a description in the request.","params":[{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/role/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"Developers\",\n  \"description\": \"A project role that represents developers in a project\"\n}'","digest":"5e69b13cd2dd51088640e58fb6fd432b237877c3ca73526a6a2b1de64fef3618"},"Partial update project role":{"name":"Partial update project role","http_method":"POST","path":"/rest/api/3/role/{id}","description":"Updates either the project role's name or its description.","params":[{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/role/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"Developers\",\n  \"description\": \"A project role that represents developers in a project\"\n}'","digest":"dc7c2e611bf245712d83f683fd39a35dec04952909e7f52b3957050b6cbcb2fd"},"Delete project role":{"name":"Delete project role","http_method":"DELETE","path":"/rest/api/3/role/{id}","description":"Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.","params":[{"name":"id","type":"integer","description":"The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.","default":"int64"},{"name":"swap","type":"integer","description":"The ID of the project role that will replace the one being deleted.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/role/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"e75756515853abb7e1f9aee4ca6910e30bd2e7d611f289ca0bbb102e3a0f3fd7"},"Set actors for project role":{"name":"Set actors for project role","http_method":"PUT","path":"/rest/api/3/project/{projectIdOrKey}/role/{id}","description":"Sets the actors for a project role for a project, replacing all existing actors.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/project/{projectIdOrKey}/role/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"categorisedActors\": {\n    \"atlassian-user-role-actor\": [\n      \"12345678-9abc-def1-2345-6789abcdef12\"\n    ],\n    \"atlassian-group-role-actor\": [\n      \"jira-developers\"\n    ]\n  }\n}'","digest":"d49f3d33d9ccccb5363330f48a0cf5615c2186e9b87bb16bb8efd5c08411c788"},"Add actors to project role":{"name":"Add actors to project role","http_method":"POST","path":"/rest/api/3/project/{projectIdOrKey}/role/{id}","description":"Adds actors to a project role for the project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/project/{projectIdOrKey}/role/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"group\": [\n    \"jira-developers\"\n  ]\n}'","digest":"96c729f376a7a330f35feb88be87901696223257103026c54439db3b3b2d37b5"},"Delete actors from project role":{"name":"Delete actors from project role","http_method":"DELETE","path":"/rest/api/3/project/{projectIdOrKey}/role/{id}","description":"Deletes actors from a project role for the project.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"},{"name":"user","type":"string","description":"The user account ID of the user to remove from the project role."},{"name":"group","type":"string","description":"The name of the group to remove from the project role."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/project/{projectIdOrKey}/role/{id}?user={user}' \\\n  --user 'email@example.com:<api_token>'","digest":"5270e6e092baa45faa0218b6731a6b26d5f59b356801a7ce1d9474b62ba26799"},"Get default actors for project role":{"name":"Get default actors for project role","http_method":"GET","path":"/rest/api/3/role/{id}/actors","description":"Returns the default actors for the project role.","params":[{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/role/{id}/actors' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"abdb88ffe00b0494fa6cc56eb4e02f6a8117c732b1fc57ce22586b9bb67d34a3"},"Add default actors to project role":{"name":"Add default actors to project role","http_method":"POST","path":"/rest/api/3/role/{id}/actors","description":"Adds default actors to a role. You may add groups or users, but you cannot add groups and users in the same request.","params":[{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/role/{id}/actors' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"user\": [\n    \"admin\"\n  ]\n}'","digest":"96488490cd110458fc00868c64b41be4f7e70a06c772c9b00ac9b728e0f079a5"},"Delete default actors from project role":{"name":"Delete default actors from project role","http_method":"DELETE","path":"/rest/api/3/role/{id}/actors","description":"Deletes the default actors from a project role. You may delete a group or user, but you cannot delete a group and a user in the same request.","params":[{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"},{"name":"user","type":"string","description":"The user account ID of the user to remove as a default actor."},{"name":"group","type":"string","description":"The group name of the group to be removed as a default actor."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/role/{id}/actors?user={user}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"137e0c249aefe16be45774c1d9f17ae6f8413de1391b057e9a5cc104a41129d2"},"Get all project types":{"name":"Get all project types","http_method":"GET","path":"/rest/api/3/project/type","description":"Returns all project types, whether or not the instance has a valid license for each type.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/project/type' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"cb574e7ce249baab8c2f33e9c2f9736887abc125f8a1d5282e3205a17c1f7ad8"},"Get project type by key":{"name":"Get project type by key","http_method":"GET","path":"/rest/api/3/project/type/{projectTypeKey}","description":"Returns a project type.","params":[{"name":"projectTypeKey","type":"string","description":"The key of the project type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/type/{projectTypeKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"eabfa9fac8c0447189c7cd0ae8b392c3c2a4a4860ce0268cdb5a1e050601ed3d"},"Get accessible project type by key":{"name":"Get accessible project type by key","http_method":"GET","path":"/rest/api/3/project/type/{projectTypeKey}/accessible","description":"Returns a project type if it is accessible to the user.","params":[{"name":"projectTypeKey","type":"string","description":"The key of the project type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/type/{projectTypeKey}/accessible' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"160c3f64866dc5f3192a45512d4192204edf3765ce8af436e004173449789267"},"Get project versions paginated":{"name":"Get project versions paginated","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/version","description":"Returns a paginated representation of all versions in a project. See the Get project versions resource if you want to get a full list of versions without pagination.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 50.","default":"50"},{"name":"orderBy","type":"string","description":"Order the results by a field:"},{"name":"query","type":"string","description":"Filter the results using a literal string. Versions with matching name or description are returned (case insensitive)."},{"name":"status","type":"string","description":"A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/version' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"28856a562742e38b08751df2ccf40465bdc156d29de9eeb77886ab85e17447d6"},"Get project versions":{"name":"Get project versions","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/versions","description":"Returns all versions in a project. The response is not paginated. Use Get project versions paginated if you want to get the versions in a project with pagination.","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts operations, which returns actions that can be performed on the version."}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/versions' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"444915ad51709b8482b34829d308d00314bd7774ffecf6d72338311b79f15bb4"},"Create version":{"name":"Create version","http_method":"POST","path":"/rest/api/3/version","description":"Creates a project version.","params":[{"name":"expand","type":"string","description":"Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:"},{"name":"description","type":"string","description":"The description of the version. Optional when creating or updating a version."},{"name":"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."},{"name":"archived","type":"boolean","description":"Indicates that the version is archived. Optional when creating or updating a version."},{"name":"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."},{"name":"startDate","type":"string","description":"The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.","default":"date"},{"name":"releaseDate","type":"string","description":"The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.","default":"date"},{"name":"project","type":"string","description":"Deprecated. Use projectId."},{"name":"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.","default":"int64"},{"name":"moveUnfixedIssuesTo","type":"string","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.","default":"uri"}],"command":"curl --request POST \\\n  --url '/rest/api/3/version' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"archived\": \"{archived}\",\n  \"releaseDate\": \"{releaseDate}\",\n  \"name\": \"{name}\",\n  \"description\": \"{description}\",\n  \"projectId\": \"{projectId}\",\n  \"released\": \"{released}\"\n}'","digest":"866fc2710ad082240234b1622de289ebcae6e3bac666e96c3dc9db48ba723172"},"Get version":{"name":"Get version","http_method":"GET","path":"/rest/api/3/version/{id}","description":"Returns a project version.","params":[{"name":"id","type":"string","description":"The ID of the version."},{"name":"expand","type":"string","description":"Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/version/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"1db14afd90284be57a7779e94a1ad6f62379af0f55606d0e5236054b1b5bbd76"},"Update version":{"name":"Update version","http_method":"PUT","path":"/rest/api/3/version/{id}","description":"Updates a project version.","params":[{"name":"id","type":"string","description":"The ID of the version."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/version/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"archived\": false,\n  \"overdue\": true,\n  \"releaseDate\": \"2010-07-06T00:00:00.000Z\",\n  \"name\": \"New Version 1\",\n  \"self\": \"http://your-domain.atlassian.net/rest/api/~ver~/version/10000\",\n  \"description\": \"An excellent version\",\n  \"userReleaseDate\": \"6/Jul/2010\",\n  \"id\": \"10000\",\n  \"projectId\": 10000,\n  \"released\": true\n}'","digest":"6ed366c03c6a184aaf5a2c634622a4e764e5e77d3bc869df41d9a0aa2d44b934"},"Delete version":{"name":"Delete version","http_method":"DELETE","path":"/rest/api/3/version/{id}","description":"DELETE /rest/api/3/version/{id}","params":[{"name":"id","type":"string","description":"The ID of the version."},{"name":"moveFixIssuesTo","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":"moveAffectedIssuesTo","type":"string","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."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/version/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"0503c8d6889d756dbf6d4608ef6f31d5907f95247d167ec25e3049af536e3151"},"Merge versions":{"name":"Merge versions","http_method":"PUT","path":"/rest/api/3/version/{id}/mergeto/{moveIssuesTo}","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.","params":[{"name":"id","type":"string","description":"The ID of the version to delete."},{"name":"moveIssuesTo","type":"string","description":"The ID of the version to merge into."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/version/{id}/mergeto/{moveIssuesTo}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d2ecd7d2992c54cc8766f35c236802987e73479abc10dea73ddb33c3176518b7"},"Move version":{"name":"Move version","http_method":"POST","path":"/rest/api/3/version/{id}/move","description":"Modifies the version's sequence within the project, which affects the display order of the versions in Jira.","params":[{"name":"id","type":"string","description":"The ID of the version to be moved."}],"command":"curl --request POST \\\n  --url '/rest/api/3/version/{id}/move' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"after\": \"http://your-domain.atlassian.net/rest/api/~ver~/version/10000\"\n}'","digest":"9228a8971529bf824fdd319cc71a5a76f4b2311dffe35c1260f82fa4b71adecd"},"Get version's related issues count":{"name":"Get version's related issues count","http_method":"GET","path":"/rest/api/3/version/{id}/relatedIssueCounts","description":"Returns the following counts for a version:","params":[{"name":"id","type":"string","description":"The ID of the version."}],"command":"curl --request GET \\\n  --url '/rest/api/3/version/{id}/relatedIssueCounts' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c62147b264f2371addab5cc6f979015c6a2219033289e7892aa268f63fc16ffc"},"Delete and replace version":{"name":"Delete and replace version","http_method":"POST","path":"/rest/api/3/version/{id}/removeAndSwap","description":"Deletes a project version.","params":[{"name":"id","type":"string","description":"The ID of the version."}],"command":"curl --request POST \\\n  --url '/rest/api/3/version/{id}/removeAndSwap' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"moveFixIssuesTo\": 92,\n  \"moveAffectedIssuesTo\": 97,\n  \"customFieldReplacementList\": [\n    {\n      \"customFieldId\": 66,\n      \"moveTo\": 67\n    }\n  ]\n}'","digest":"2490cba77ab98816a5f2b6b07cf5a9c182b403da23861ecb1537a9d0843b8ba3"},"Get version's unresolved issues count":{"name":"Get version's unresolved issues count","http_method":"GET","path":"/rest/api/3/version/{id}/unresolvedIssueCount","description":"Returns counts of the issues and unresolved issues for the project version.","params":[{"name":"id","type":"string","description":"The ID of the version."}],"command":"curl --request GET \\\n  --url '/rest/api/3/version/{id}/unresolvedIssueCount' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"39bbe26692e01f8527f281c486a0397fd504b9d20b56ed6fc8e96504b1c5e1ac"},"Get screens for a field":{"name":"Get screens for a field","http_method":"GET","path":"/rest/api/3/field/{fieldId}/screens","description":"Returns a paginated list of the screens a field is used in.","params":[{"name":"fieldId","type":"string","description":"The ID of the field to return screens for."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"100"}],"command":"curl --request GET \\\n  --url '/rest/api/3/field/{fieldId}/screens' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"155bfc9696ea43aaa581f76b68c334fb30c1dea77b52d9367d7fa19d26fe3389"},"Get all screens":{"name":"Get all screens","http_method":"GET","path":"/rest/api/3/screens","description":"Returns all screens.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 100.","default":"100"}],"command":"curl --request GET \\\n  --url '/rest/api/3/screens' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"63e24b753f6d27c7dddd645d91d415b97b1c1d6b41d9dda166ff7fd172c612f8"},"Add field to default screen":{"name":"Add field to default screen","http_method":"POST","path":"/rest/api/3/screens/addToDefault/{fieldId}","description":"Adds a field to the default tab of the default screen.","params":[{"name":"fieldId","type":"string","description":"The ID of the field."}],"command":"curl --request POST \\\n  --url '/rest/api/3/screens/addToDefault/{fieldId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"170207430625eb5610eb673883846e6029f9b7eab44d18349847d77bbcee0464"},"Get available screen fields":{"name":"Get available screen fields","http_method":"GET","path":"/rest/api/3/screens/{screenId}/availableFields","description":"Returns the fields that can be added to a tab on a screen.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/screens/{screenId}/availableFields' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9d7972cbfcead2282fd65c537a4e15d03d1611d57438570e12f644ba70d6ee6a"},"Get all screen tabs":{"name":"Get all screen tabs","http_method":"GET","path":"/rest/api/3/screens/{screenId}/tabs","description":"Returns the list of tabs for a screen.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"projectKey","type":"string","description":"The key of the project."}],"command":"curl --request GET \\\n  --url '/rest/api/3/screens/{screenId}/tabs' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"04357076f1cc050b4266e6f46b9af21c28d76cef00e2ed630493bd091ec89b4e"},"Create screen tab":{"name":"Create screen tab","http_method":"POST","path":"/rest/api/3/screens/{screenId}/tabs","description":"Creates a tab for a screen.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/screens/{screenId}/tabs' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"Fields Tab\"\n}'","digest":"75a4bd51b8100c0b8b36f236ec5c06505742c1aa6240203721c51836ef39dd31"},"Update screen tab":{"name":"Update screen tab","http_method":"PUT","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}","description":"Updates the name of a screen tab.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"name\": \"<string>\"\n}'","digest":"b2f28e8ce32361322fc8f9f8e08a025cfaef2fea7ef78d70f6ea5534fb2f2ea4"},"Delete screen tab":{"name":"Delete screen tab","http_method":"DELETE","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}","description":"Deletes a screen tab.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}' \\\n  --user 'email@example.com:<api_token>'","digest":"e0f5bc387e88fc8131b8c7a3e85da28c5b83ef22904a7dfbe5a7ff69af9f2940"},"Get all screen tab fields":{"name":"Get all screen tab fields","http_method":"GET","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields","description":"Returns all fields for a screen tab.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"},{"name":"projectKey","type":"string","description":"The key of the project."}],"command":"curl --request GET \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}/fields' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"ca3080133ee9433888d819ddb86ef57106b8ad55327a3458a2be1ecc869d2ecd"},"Add screen tab field":{"name":"Add screen tab field","http_method":"POST","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields","description":"Adds a field to a screen tab.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}/fields' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"fieldId\": \"summary\"\n}'","digest":"517f530dd547bab330bf83e6232bc05daa4e805948933737001e5b54f44d04ca"},"Remove screen tab field":{"name":"Remove screen tab field","http_method":"DELETE","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}","description":"Removes a field from a screen tab.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"},{"name":"id","type":"string","description":"The ID of the field."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"2e8f6fd8fbaa8bf3a40a5c2cbf636a25829068dcb7d1c1203b5fcbea3bf9d749"},"Move screen tab field":{"name":"Move screen tab field","http_method":"POST","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move","description":"Moves a screen tab field.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"},{"name":"id","type":"string","description":"The ID of the field."}],"command":"curl --request POST \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"after\": \"<string>\",\n  \"position\": \"Earlier\"\n}'","digest":"8bcca2b4c3a091dd91fb772d4ce1db4d1ac6c6b637500e6d4ba079a8d1b4ce4e"},"Move screen tab":{"name":"Move screen tab","http_method":"POST","path":"/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}","description":"Moves a screen tab.","params":[{"name":"screenId","type":"integer","description":"The ID of the screen.","default":"int64"},{"name":"tabId","type":"integer","description":"The ID of the screen tab.","default":"int64"},{"name":"pos","type":"integer","description":"The position of tab. The base index is 0.","default":"int32"}],"command":"curl --request POST \\\n  --url '/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e1433b282e88badc2fa80933217c9dba741514ea6e0d8bb56c60a4936df72772"},"Get Jira instance info":{"name":"Get Jira instance info","http_method":"GET","path":"/rest/api/3/serverInfo","description":"Returns information about the Jira instance.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/serverInfo' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c3605992fc8d6f4e5cc348f87b72ec2e4fac6dfb6737a75702530fb2a85b0353"},"Get task":{"name":"Get task","http_method":"GET","path":"/rest/api/3/task/{taskId}","description":"Returns the status of a long-running asynchronous task.","params":[{"name":"taskId","type":"string","description":"The ID of the task."}],"command":"curl --request GET \\\n  --url '/rest/api/3/task/{taskId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"726bc50419a8889a86144a4203647bbfee4261193b5b2bf602474176a132f065"},"Cancel task":{"name":"Cancel task","http_method":"POST","path":"/rest/api/3/task/{taskId}/cancel","description":"POST /rest/api/3/task/{taskId}/cancel","params":[{"name":"taskId","type":"string","description":"The ID of the task."}],"command":"curl --request POST \\\n  --url '/rest/api/3/task/{taskId}/cancel' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d60a8c9c4eaf517700cc9d0311cd58718a15208a511eb4edaf72850b038b9a7f"},"Get selected time tracking provider":{"name":"Get selected time tracking provider","http_method":"GET","path":"/rest/api/3/configuration/timetracking","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.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/configuration/timetracking' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"51cc2cf4367ce7a6e06da3a55d4121b2bac9b9010664b28ee98c9295cdb6da3d"},"Select time tracking provider":{"name":"Select time tracking provider","http_method":"PUT","path":"/rest/api/3/configuration/timetracking","description":"Selects a time tracking provider.","params":[{"name":"key","type":"string","description":"The key for the time tracking provider. For example, JIRA."},{"name":"name","type":"string","description":"The name of the time tracking provider. For example, JIRA provided time tracking."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/configuration/timetracking' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"key\": \"{key}\"\n}'","digest":"619411dfbd301c75cc4c08f5f8fb1c3c050a2400dbe683855e8476c6a6e5d8ba"},"Disable time tracking":{"name":"Disable time tracking","http_method":"DELETE","path":"/rest/api/3/configuration/timetracking","description":"DELETE /rest/api/3/configuration/timetracking","params":[],"command":"curl --request DELETE \\\n  --url '/rest/api/3/configuration/timetracking' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"282cce663651e8c55d6f6a6669c0bd4153cb2201fc4846173b81364fc1fb232d"},"Get all time tracking providers":{"name":"Get all time tracking providers","http_method":"GET","path":"/rest/api/3/configuration/timetracking/list","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 module.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/configuration/timetracking/list' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c1a2ceead07e358b0002fe437fda4363bbec090500d5b05f73abb7c3d91e6c03"},"Get time tracking settings":{"name":"Get time tracking settings","http_method":"GET","path":"/rest/api/3/configuration/timetracking/options","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.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/configuration/timetracking/options' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"018411d597763b083a3eecb7e4191e2ae013fc238d922b8c123c1ff34000e31a"},"Set time tracking settings":{"name":"Set time tracking settings","http_method":"PUT","path":"/rest/api/3/configuration/timetracking/options","description":"Sets the time tracking settings.","params":[{"name":"workingHoursPerDay","type":"number","description":"The number of hours in a working day.","default":"double"},{"name":"workingDaysPerWeek","type":"number","description":"The number of days in a working week.","default":"double"},{"name":"timeFormat","type":"string","description":"The format that will appear on an issue's Time Spent field."},{"name":"defaultUnit","type":"string","description":"The default unit of time applied to logged time."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/configuration/timetracking/options' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"defaultUnit\": \"{defaultUnit}\",\n  \"workingHoursPerDay\": \"{workingHoursPerDay}\",\n  \"workingDaysPerWeek\": \"{workingDaysPerWeek}\",\n  \"timeFormat\": \"{timeFormat}\"\n}'","digest":"ed3d3952c7cf8f54212ed2c7d0f7266d587bf8efd1d82424850e10f5d9fa2723"},"Get user":{"name":"Get user","http_method":"GET","path":"/rest/api/3/user","description":"Returns a user.","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"key","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"expand","type":"string","description":"Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"f6a9ae4319f4d21e8ec81f3330cf25022e2b3a25d614a0509e64fc2f7265fa1e"},"Create user":{"name":"Create user","http_method":"POST","path":"/rest/api/3/user","description":"POST /rest/api/3/user","params":[{"name":"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 for details."},{"name":"name","type":"string","description":"The username for the user. This property is deprecated because of privacy changes. See the migration guide for details."},{"name":"password","type":"string","description":"A password for the user. If a password is not set, a random password is generated."},{"name":"emailAddress","type":"string","description":"The email address for the user. Required."},{"name":"displayName","type":"string","description":"The display name for the user. Required."},{"name":"notification","type":"string","description":"Sends the user an email confirmation that they have been added to Jira. Default is false."},{"name":"applicationKeys","type":"Array<string>","description":"Deprecated, do not use."},{"name":"Additional Properties","type":"anything","description":"Extra properties of any type may be provided to this object."}],"command":"curl --request POST \\\n  --url '/rest/api/3/user' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"password\": \"{password}\",\n  \"emailAddress\": \"{emailAddress}\",\n  \"displayName\": \"{displayName}\",\n  \"name\": \"{name}\"\n}'","digest":"54862f2bb6bcf872094e4b263c5a999d957dac044e42fea790251c46e3325d2d"},"Delete user":{"name":"Delete user","http_method":"DELETE","path":"/rest/api/3/user","description":"DELETE /rest/api/3/user","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"key","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/user?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>'","digest":"e51ad53b319d341acff4bc09fef68a8018da394d001fae056d8c2d139c4c1378"},"Bulk get users":{"name":"Bulk get users","http_method":"GET","path":"/rest/api/3/user/bulk","description":"GET /rest/api/3/user/bulk","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 200.","default":"10"},{"name":"username","type":"Array<string>","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"key","type":"Array<string>","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","type":"Array<string>","description":"Account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5. Required."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/bulk?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d564ef64f5538f7fe782d0a6b284da85066a5c468a9e517b57e886270c9c0b81"},"Get account IDs for users":{"name":"Get account IDs for users","http_method":"GET","path":"/rest/api/3/user/bulk/migration","description":"GET /rest/api/3/user/bulk/migration","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"10"},{"name":"username","type":"Array<string>","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."},{"name":"key","type":"Array<string>","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."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/bulk/migration' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"5582b1448f7075af3bdd3bd01cf6b883d747573622fef051c27fad81f358f6fa"},"Get user default columns":{"name":"Get user default columns","http_method":"GET","path":"/rest/api/3/user/columns","description":"Returns the default issue table columns for the user. If an accountId is not passed in the request, the calling user's details are returned.","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/columns?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b2b524d99dca84a1ebaac94d78fb67db1b007afc4b797ff087cd7234ee4a4af4"},"Set user default columns":{"name":"Set user default columns","http_method":"PUT","path":"/rest/api/3/user/columns","description":"Sets the default  issue table columns 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.","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d891bdff2e7b9d5bcd067d9eafbf44f1f870b57e749b716e0f0d205eb879b6ce"},"Reset user default columns":{"name":"Reset user default columns","http_method":"DELETE","path":"/rest/api/3/user/columns","description":"Resets the default  issue table columns for the user to the system default. If an accountId is not passed, the calling user's default columns are reset.","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/user/columns?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>'","digest":"1f64abbc92940aac5fc874122beb6ce14c5d7fa9b11e1e14af79927b07f20ff6"},"Get user email":{"name":"Get user email","http_method":"GET","path":"/rest/api/3/user/email","description":"GET /rest/api/3/user/email","params":[{"name":"accountId","type":"string","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."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/email?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c476096841e1b5d4c1d639c9b83640dedf3d56d2f091108b82a25496506d0fe7"},"Get user email bulk":{"name":"Get user email bulk","http_method":"GET","path":"/rest/api/3/user/email/bulk","description":"GET /rest/api/3/user/email/bulk","params":[{"name":"accountId","type":"Array<string>","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)."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/email/bulk?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c9afccce399dd7b3b2d387f83c461f7a6f85f3d7692ae7807f98b7d65ad7f5a3"},"Get user groups":{"name":"Get user groups","http_method":"GET","path":"/rest/api/3/user/groups","description":"Returns the groups to which a user belongs.","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"key","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/groups?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"a11b7621405284654cac8472d46b0ce14cc8982426c8d662cecff161fa45a449"},"Get all users":{"name":"Get all users","http_method":"GET","path":"/rest/api/3/users/search","description":"Returns a list of all (active and inactive) users.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return.","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return.","default":"50"}],"command":"curl --request GET \\\n  --url '/rest/api/3/users/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"3686691696dc01f2da056f51c3a4747d53c73315ac26ec7fdd1d58e67552f328"},"Get user property keys":{"name":"Get user property keys","http_method":"GET","path":"/rest/api/3/user/properties","description":"Returns the keys of all properties for a user.","params":[{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"userKey","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/properties?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"0690e89d96dd9d1361e50846dc1600267bac1f0b062e967327b30e8b0ab24423"},"Get user property":{"name":"Get user property","http_method":"GET","path":"/rest/api/3/user/properties/{propertyKey}","description":"Returns the value of a user's property. If no property key is provided Get user property keys is called.","params":[{"name":"propertyKey","type":"string","description":"The key of the user's property."},{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"userKey","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/properties/{propertyKey}?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"3adee2114c019406704b2b0f7cac90091953f82a645b5b8e7cf7ae72fb8f65bc"},"Set user property":{"name":"Set user property","http_method":"PUT","path":"/rest/api/3/user/properties/{propertyKey}","description":"Sets the value of a user's property. Use this resource to store custom data against a user.","params":[{"name":"propertyKey","type":"string","description":"The key of the user's property. The maximum length is 255 characters."},{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"userKey","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/user/properties/{propertyKey}?accountId=5b10ac8d82e05b22cc7d4ef5' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{}'","digest":"6dd949538306eba1966e4bdcf4ae5c5748bc52138b72016e537414f487f9cc35"},"Delete user property":{"name":"Delete user property","http_method":"DELETE","path":"/rest/api/3/user/properties/{propertyKey}","description":"Deletes a property from a user.","params":[{"name":"propertyKey","type":"string","description":"The key of the user's property."},{"name":"accountId","type":"string","description":"The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required."},{"name":"userKey","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/user/properties/{propertyKey}?accountId={accountId}' \\\n  --user 'email@example.com:<api_token>'","digest":"1e0b5f13781ee7ea0b3e226a49e80895e714e932494207a2072eee3c4ea89a14"},"Find users assignable to projects":{"name":"Find users assignable to projects","http_method":"GET","path":"/rest/api/3/user/assignable/multiProjectSearch","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.","params":[{"name":"query","type":"string","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":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","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":"projectKeys","type":"string","description":"A list of project keys (case sensitive). This parameter accepts a comma-separated list."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"50"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/assignable/multiProjectSearch?query={query}&projectKeys={projectKeys}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"92ab4770e89b36e92f24fcb0a7863cfa592247fe77f6e6b1478e92ea7a4ec7a6"},"Find users assignable to issues":{"name":"Find users assignable to issues","http_method":"GET","path":"/rest/api/3/user/assignable/search","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:","params":[{"name":"query","type":"string","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":"sessionId","type":"string","description":"The sessionId of this request. SessionId is the same until the assignee is set."},{"name":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","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":"project","type":"string","description":"The project ID or project key (case sensitive). Required, unless issueKey is specified."},{"name":"issueKey","type":"string","description":"The key of the issue. Required, unless project is specified."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.","default":"50"},{"name":"actionDescriptorId","type":"integer","description":"The ID of the transition.","default":"int32"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/assignable/search?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"0719fda8c5be29dba748284548a194a277fcae68638cd310ab40be0c6701c77f"},"Find users with permissions":{"name":"Find users with permissions","http_method":"GET","path":"/rest/api/3/user/permission/search","description":"Returns a list of users who fulfill these criteria:","params":[{"name":"query","type":"string","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":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","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":"permissions","type":"string","description":"A list of permissions. This parameter accepts a comma-separated list. The valid permissions are:"},{"name":"issueKey","type":"string","description":"The issue key for the issue."},{"name":"projectKey","type":"string","description":"The project key for the project (case sensitive)."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"50"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/permission/search?query={query}&permissions={permissions}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"8ef5019ebf46fae03fa48d91077ba429f7eb994a82cc33ad18938a04181ce6e3"},"Find users for picker":{"name":"Find users for picker","http_method":"GET","path":"/rest/api/3/user/picker","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.","params":[{"name":"query","type":"string","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."},{"name":"maxResults","type":"integer","description":"The maximum number of items to return. The maximum is 1000. The total number of matched users is returned in total.","default":"50"},{"name":"showAvatar","type":"boolean","description":"Include the URI to the user's avatar.","default":"false"},{"name":"exclude","type":"Array<string>","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"excludeAccountIds","type":"Array<string>","description":"A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude."},{"name":"avatarSize","type":"string"},{"name":"excludeConnectUsers","type":"boolean","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/picker?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"526336c0327f309741dd2c955a4d3bf78b696c390123e94ae282212f928859f4"},"Find users":{"name":"Find users","http_method":"GET","path":"/rest/api/3/user/search","description":"Returns a list of users that match the search string and property.","params":[{"name":"query","type":"string","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":"username","type":"string"},{"name":"accountId","type":"string","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."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"50"},{"name":"property","type":"string","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."}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/search?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"d684cdda9b72fca57058b899a0357ffd1e0b26f84e42f0b7590c2f3f8c4f7ec1"},"Find users by query":{"name":"Find users by query","http_method":"GET","path":"/rest/api/3/user/search/query","description":"Finds users with a structured query and returns user details.","params":[{"name":"query","type":"string","description":"The search query."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"100"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/search/query?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"066a78b71ebf188837b53854a94697d8f5aa13a91656ef5497f5194e8800732e"},"Find user keys by query":{"name":"Find user keys by query","http_method":"GET","path":"/rest/api/3/user/search/query/key","description":"Finds users with a structured query and returns a list of user keys.","params":[{"name":"query","type":"string","description":"The search query."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"100"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/search/query/key?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"20cba8f53821a19935a0f71923d84aef911432165d525951862a9dadbdf8797e"},"Find users with browse permission":{"name":"Find users with browse permission","http_method":"GET","path":"/rest/api/3/user/viewissue/search","description":"Returns a list of users who fulfill these criteria:","params":[{"name":"query","type":"string","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":"username","type":"string","description":"This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details."},{"name":"accountId","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":"issueKey","type":"string","description":"The issue key for the issue. Required, unless projectKey is specified."},{"name":"projectKey","type":"string","description":"The project key for the project (case sensitive). Required, unless issueKey is specified."},{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page. The maximum is 1000.","default":"50"}],"command":"curl --request GET \\\n  --url '/rest/api/3/user/viewissue/search?query={query}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c79e933505af4776db8c5232a5eb32be2b3a93d548d9d918aaec883b766e3184"},"Get dynamic webhooks for app":{"name":"Get dynamic webhooks for app","http_method":"GET","path":"/rest/api/3/webhook","description":"Returns the webhooks registered by the calling app.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"100"}],"command":"curl --request GET \\\n  --url '/rest/api/3/webhook' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b83e803e59bd76708941b2ffefb0a013ff12b3ad04a8d901b8b2e739df712898"},"Register dynamic webhooks":{"name":"Register dynamic webhooks","http_method":"POST","path":"/rest/api/3/webhook","description":"Registers webhooks.","params":[{"name":"webhooks","type":"Array<WebhookDetails>","description":"A list of webhooks."},{"name":"url","type":"string","description":"The URL that specifies where to send the webhooks."}],"command":"curl --request POST \\\n  --url '/rest/api/3/webhook' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"webhooks\": \"{webhooks}\",\n  \"url\": \"{url}\"\n}'","digest":"08cfadca2f58d33d6160d4d5ee14a9f2ad4aeecc132bb124c874efa6915faa8e"},"Delete webhooks by ID":{"name":"Delete webhooks by ID","http_method":"DELETE","path":"/rest/api/3/webhook","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.","params":[{"name":"webhookIds","type":"Array<integer>","description":"A list of webhook IDs."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/webhook' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"webhookIds\": [\n    10000,\n    10001,\n    10042\n  ]\n}'","digest":"d6d6a04c8287aad1cf292fe92aed8e7d8f52bcd08280e0b26d316103c40ca5cf"},"Extend webhook life":{"name":"Extend webhook life","http_method":"PUT","path":"/rest/api/3/webhook/refresh","description":"Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive.","params":[{"name":"webhookIds","type":"Array<integer>","description":"A list of webhook IDs."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/webhook/refresh' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"webhookIds\": \"{webhookIds}\"\n}'","digest":"0e6c4fe7feafde6edbb86f9dfe19c9cf13fc56888f4f020ea7125dc1a3fdf7b7"},"Get all workflows":{"name":"Get all workflows","http_method":"GET","path":"/rest/api/3/workflow","description":"GET /rest/api/3/workflow","params":[{"name":"workflowName","type":"string","description":"The name of the workflow to be returned. Only one workflow can be specified."}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflow' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9a81c92833b2fda3a840da17f3c10fcff92f2a90f17b4f6fcff06f61fcd7a166"},"Get workflows paginated":{"name":"Get workflows paginated","http_method":"GET","path":"/rest/api/3/workflow/search","description":"Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"50"},{"name":"workflowName","type":"Array<string>","description":"The name of a workflow to return.","default":"true"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflow/search' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"decf12332137bfbaaf33e3c96b38b651141719f25eed83f5706eea57d076c7f5"},"Get workflow transition rule configurations":{"name":"Get workflow transition rule configurations","http_method":"GET","path":"/rest/api/3/workflow/rule/config","description":"Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:","params":[{"name":"startAt","type":"integer","description":"The index of the first item to return in a page of results (page offset).","default":"0"},{"name":"maxResults","type":"integer","description":"The maximum number of items to return per page.","default":"10"},{"name":"types","type":"Array<string>","description":"The types of the transition rules to return.","default":"true"},{"name":"keys","type":"Array<string>","description":"The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.","default":"true"},{"name":"expand","type":"string","description":"Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to."}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflow/rule/config?types={types}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"1652cbdb6d279fe7a1c02f7763292a9c40533ef68be2bde809d759104ca7dc5c"},"Update workflow transition rule configurations":{"name":"Update workflow transition rule configurations","http_method":"PUT","path":"/rest/api/3/workflow/rule/config","description":"Updates configuration of workflow transition rules. The following rule types are supported:","params":[{"name":"workflows","type":"Array<WorkflowTransitionRules>","description":"The list of workflows with transition rules to update."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflow/rule/config' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"workflows\": \"{workflows}\"\n}'","digest":"ebc98c310efb567e4c7e6a14e3b8375aa85e0794cedf7038500ce8d3f9e3cbb9"},"Create workflow scheme":{"name":"Create workflow scheme","http_method":"POST","path":"/rest/api/3/workflowscheme","description":"Creates a workflow scheme.","params":[{"name":"name","type":"string","description":"The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme."},{"name":"description","type":"string","description":"The description of the workflow scheme."},{"name":"defaultWorkflow","type":"string","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)."},{"name":"issueTypeMappings","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."},{"name":"updateDraftIfNeeded","type":"boolean","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:"}],"command":"curl --request POST \\\n  --url '/rest/api/3/workflowscheme' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"defaultWorkflow\": \"{defaultWorkflow}\",\n  \"name\": \"{name}\",\n  \"description\": \"{description}\",\n  \"issueTypeMappings\": \"{issueTypeMappings}\"\n}'","digest":"fa50775554f1f974443e8686d065d7f11d2ef6d51fd6da1f56705cf5a9386730"},"Get workflow scheme":{"name":"Get workflow scheme","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}","description":"Returns a workflow scheme.","params":[{"name":"id","type":"integer","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.","default":"int64"},{"name":"returnDraftIfExists","type":"boolean","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.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"3bf125760e6958bd9503fab5d3ee19084cd2a43f4a673a4244176d15c74e6a7f"},"Update workflow scheme":{"name":"Update workflow scheme","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}","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.","params":[{"name":"id","type":"integer","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.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"defaultWorkflow\": \"jira\",\n  \"updateDraftIfNeeded\": false,\n  \"name\": \"Example workflow scheme\",\n  \"description\": \"The description of the example workflow scheme.\",\n  \"issueTypeMappings\": {\n    \"10000\": \"scrum workflow\"\n  }\n}'","digest":"734204d7e7f63ccd9d0fe8c834b84d9b96534b984f3a54740d1006c50088979f"},"Delete workflow scheme":{"name":"Delete workflow scheme","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}","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).","params":[{"name":"id","type":"integer","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.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}' \\\n  --user 'email@example.com:<api_token>'","digest":"f5350261c3dc5f81924bcbc9238c06f415531229707faf81a9793388524e98fa"},"Get default workflow":{"name":"Get default workflow","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/default","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.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"returnDraftIfExists","type":"boolean","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.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/default' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"cbdea259e38932cb1ba9d330d2af73c4872740e3bf709fc1b3a52226bdfc396c"},"Update default workflow":{"name":"Update default workflow","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}/default","description":"Sets the default workflow for a workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}/default' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"workflow\": \"jira\",\n  \"updateDraftIfNeeded\": false\n}'","digest":"1389eb8c0483c42728a33fbe38842c96d54893d4a91ce90777615837ee7968b6"},"Delete default workflow":{"name":"Delete default workflow","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/default","description":"Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"updateDraftIfNeeded","type":"boolean","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."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/default' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"e94b4bc861e76affa88d2de7685c626906708c6ba20a0c2b887eb1617e29c1e0"},"Get workflow for issue type in workflow scheme":{"name":"Get workflow for issue type in workflow scheme","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/issuetype/{issueType}","description":"Returns the issue type-workflow mapping for an issue type in a workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"issueType","type":"string","description":"The ID of the issue type."},{"name":"returnDraftIfExists","type":"boolean","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.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/issuetype/{issueType}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"9a8f5385b396d8bed3cbb3c04846ec9407a78ffd06e657137057c49c456771e2"},"Set workflow for issue type in workflow scheme":{"name":"Set workflow for issue type in workflow scheme","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}/issuetype/{issueType}","description":"Sets the workflow for an issue type in a workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"issueType","type":"string","description":"The ID of the issue type."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}/issuetype/{issueType}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"issueType\": \"10000\",\n  \"workflow\": \"jira\",\n  \"updateDraftIfNeeded\": false\n}'","digest":"7e12f5ac31d8203f0f5cb89dc6028f6a6bcef08bb13565a298c67a1d2da4d5b3"},"Delete workflow for issue type in workflow scheme":{"name":"Delete workflow for issue type in workflow scheme","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/issuetype/{issueType}","description":"Deletes the issue type-workflow mapping for an issue type in a workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"issueType","type":"string","description":"The ID of the issue type."},{"name":"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."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/issuetype/{issueType}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"55db9d2988916c47bc4181c7a17d887673704d57df8d3c2e661bf7ead93d5c7a"},"Get issue types for workflows in workflow scheme":{"name":"Get issue types for workflows in workflow scheme","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/workflow","description":"Returns the workflow-issue type mappings for a workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"workflowName","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":"returnDraftIfExists","type":"boolean","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.","default":"false"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/workflow' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"787358bbb36b3de4ed37c3fefbea08f55ccc654e23d6d4dd16d6b9a6af8f4de4"},"Set issue types for workflow in workflow scheme":{"name":"Set issue types for workflow in workflow scheme","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}/draft/workflow","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.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"},{"name":"workflowName","type":"string","description":"The name of the workflow."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/workflow?workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"workflow\": \"jira\",\n  \"updateDraftIfNeeded\": true,\n  \"issueTypes\": [\n    \"10000\"\n  ]\n}'","digest":"e9b12c01129b96ea67d68a988518b915c5c5daa487b2feb0a403220bf28139e0"},"Delete issue types for workflow in workflow scheme":{"name":"Delete issue types for workflow in workflow scheme","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/workflow","description":"Deletes the workflow-issue type mapping for a workflow in a workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme.","default":"int64"},{"name":"workflowName","type":"string","description":"The name of the workflow."},{"name":"updateDraftIfNeeded","type":"boolean","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."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/workflow?workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>'","digest":"1cc862a819635d83129c14fca2779a82521961e421aca122b5349f35f6b78a8d"},"Get workflow scheme project associations":{"name":"Get workflow scheme project associations","http_method":"GET","path":"/rest/api/3/workflowscheme/project","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.","params":[{"name":"projectId","type":"Array<integer>","description":"The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, projectId=10000&projectId=10001.","default":"1"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/project?projectId={projectId}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"95eec8b834335e189ffc688e747e63ccf9e5427b663f693b0be53744af6b4271"},"Create draft workflow scheme":{"name":"Create draft workflow scheme","http_method":"POST","path":"/rest/api/3/workflowscheme/{id}/createdraft","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.","params":[{"name":"id","type":"integer","description":"The ID of the active workflow scheme that the draft is created from.","default":"int64"}],"command":"curl --request POST \\\n  --url '/rest/api/3/workflowscheme/{id}/createdraft' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"29b13f0223026f8dd919f948fb8c66594dbe8b87aeef889e23613c9ec1daaf07"},"Get draft workflow scheme":{"name":"Get draft workflow scheme","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/draft","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 for more information.Note that:","params":[{"name":"id","type":"integer","description":"The ID of the active workflow scheme that the draft was created from.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/draft' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c85da3db9be1bd98bead4c8996427b719a2be64da3ecb0e8c5f6ade8fb2247e7"},"Update draft workflow scheme":{"name":"Update draft workflow scheme","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}/draft","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.","params":[{"name":"id","type":"integer","description":"The ID of the active workflow scheme that the draft was created from.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}/draft' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"defaultWorkflow\": \"jira\",\n  \"updateDraftIfNeeded\": false,\n  \"name\": \"Example workflow scheme\",\n  \"description\": \"The description of the example workflow scheme.\",\n  \"issueTypeMappings\": {\n    \"10000\": \"scrum workflow\"\n  }\n}'","digest":"beaf35c643d2d23670a4e1df779f883d2dde11eb42c74c13218f3ef768b627d1"},"Delete draft workflow scheme":{"name":"Delete draft workflow scheme","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/draft","description":"Deletes a draft workflow scheme.","params":[{"name":"id","type":"integer","description":"The ID of the active workflow scheme that the draft was created from.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/draft' \\\n  --user 'email@example.com:<api_token>'","digest":"d676cc2049c06074b941f9de76942dae53ec8e5f59980cbd414d8caab87d3748"},"Get draft default workflow":{"name":"Get draft default workflow","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/draft/default","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.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/default' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"a8a1716202a4ddbaffe2651f6b64317f99c9203e1a38fb361bf9bca5747b1f87"},"Update draft default workflow":{"name":"Update draft default workflow","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}/draft/default","description":"Sets the default workflow for a workflow scheme's draft.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/default' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"workflow\": \"jira\",\n  \"updateDraftIfNeeded\": false\n}'","digest":"6d237b7a14fbb19d6e016e453c60f094b84245a04fee35fe9a1392569f09ef3f"},"Delete draft default workflow":{"name":"Delete draft default workflow","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/draft/default","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).","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/default' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"667fa111fcafd3da59742ab8a08952deb6ca4cf24d0397b7ca3525cc4e03902e"},"Get workflow for issue type in draft workflow scheme":{"name":"Get workflow for issue type in draft workflow scheme","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}","description":"Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"},{"name":"issueType","type":"string","description":"The ID of the issue type."}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"7946ae1c855a5e552e7eee92282434a06bb6a4e6a73c2da3705b4dc9fa5643d3"},"Set workflow for issue type in draft workflow scheme":{"name":"Set workflow for issue type in draft workflow scheme","http_method":"PUT","path":"/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}","description":"Sets the workflow for an issue type in a workflow scheme's draft.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"},{"name":"issueType","type":"string","description":"The ID of the issue type."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"issueType\": \"10000\",\n  \"workflow\": \"jira\",\n  \"updateDraftIfNeeded\": false\n}'","digest":"ed6d55b6b04da95a2f292024a087b9f4b2d6f9f93fe188f370dc4461edb5dfd5"},"Delete workflow for issue type in draft workflow scheme":{"name":"Delete workflow for issue type in draft workflow scheme","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}","description":"Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"},{"name":"issueType","type":"string","description":"The ID of the issue type."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b2c52616bed4d8922eb4c7afe65a0eebb90b84b61fa8ae3244bbec2b7d7b6c61"},"Get issue types for workflows in draft workflow scheme":{"name":"Get issue types for workflows in draft workflow scheme","http_method":"GET","path":"/rest/api/3/workflowscheme/{id}/draft/workflow","description":"Returns the workflow-issue type mappings for a workflow scheme's draft.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"},{"name":"workflowName","type":"string","description":"The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow."}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/workflow' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"79b7df6b269cef811b87f0d307865517fc4ba10528da973ec73ace655c11c457"},"Delete issue types for workflow in draft workflow scheme":{"name":"Delete issue types for workflow in draft workflow scheme","http_method":"DELETE","path":"/rest/api/3/workflowscheme/{id}/draft/workflow","description":"Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.","params":[{"name":"id","type":"integer","description":"The ID of the workflow scheme that the draft belongs to.","default":"int64"},{"name":"workflowName","type":"string","description":"The name of the workflow."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflowscheme/{id}/draft/workflow?workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>'","digest":"4dd50df008993d7ed98988326444d2f4ba95c71e3d8b828893945344bed89826"},"Get all statuses":{"name":"Get all statuses","http_method":"GET","path":"/rest/api/3/status","description":"Returns a list of all statuses associated with workflows.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/status' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"83e9c8a592aad26171aa0aee5a0efd208dff408f543145502432711b26425292"},"Get status":{"name":"Get status","http_method":"GET","path":"/rest/api/3/status/{idOrName}","description":"Returns a status. The status must be associated with a workflow to be returned.","params":[{"name":"idOrName","type":"string","description":"The ID or name of the status."}],"command":"curl --request GET \\\n  --url '/rest/api/3/status/{idOrName}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"2dc36c71cd0381617d4cfc3721d9c88d7d6ff0e2c2fc78686553bc7ab78aeeb5"},"Get all status categories":{"name":"Get all status categories","http_method":"GET","path":"/rest/api/3/statuscategory","description":"Returns a list of all status categories.","params":[],"command":"curl --request GET \\\n  --url '/rest/api/3/statuscategory' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"c15c261c7d3db8305902f5492eb8bc7493777c4fd047f6a98df72a14c0f8939f"},"Get status category":{"name":"Get status category","http_method":"GET","path":"/rest/api/3/statuscategory/{idOrKey}","description":"Returns a status category. Status categories provided a mechanism for categorizing statuses.","params":[{"name":"idOrKey","type":"string","description":"The ID or key of the status category."}],"command":"curl --request GET \\\n  --url '/rest/api/3/statuscategory/{idOrKey}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"b0ae4e6a4be65dae17f1e8f8cb451a2ed0a0a3373bb1090113930062ef41a5a3"},"Get workflow transition properties":{"name":"Get workflow transition properties","http_method":"GET","path":"/rest/api/3/workflow/transitions/{transitionId}/properties","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 and Workflow properties.","params":[{"name":"transitionId","type":"integer","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.","default":"int64"},{"name":"includeReservedKeys","type":"boolean","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.","default":"false"},{"name":"key","type":"string","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":"workflowName","type":"string","description":"The name of the workflow that the transition belongs to."},{"name":"workflowMode","type":"string","description":"The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.","default":"live"}],"command":"curl --request GET \\\n  --url '/rest/api/3/workflow/transitions/{transitionId}/properties?workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"6acc98338c5b58314b8b4e2d0c5c81c78d388bbb35e17221f724b6ecf516a164"},"Update workflow transition property":{"name":"Update workflow transition property","http_method":"PUT","path":"/rest/api/3/workflow/transitions/{transitionId}/properties","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 and Workflow properties.","params":[{"name":"transitionId","type":"integer","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.","default":"int64"},{"name":"key","type":"string","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."},{"name":"workflowName","type":"string","description":"The name of the workflow that the transition belongs to."},{"name":"workflowMode","type":"string","description":"The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited."}],"command":"curl --request PUT \\\n  --url '/rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"value\": \"createissue\"\n}'","digest":"a28516e9f957f1388ad05f2578c945f4f84d445528586027d4438d4a845d79ee"},"Create workflow transition property":{"name":"Create workflow transition property","http_method":"POST","path":"/rest/api/3/workflow/transitions/{transitionId}/properties","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 and Workflow properties.","params":[{"name":"transitionId","type":"integer","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.","default":"int64"},{"name":"key","type":"string","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":"workflowName","type":"string","description":"The name of the workflow that the transition belongs to."},{"name":"workflowMode","type":"string","description":"The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.","default":"live"}],"command":"curl --request POST \\\n  --url '/rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json' \\\n  --header 'Content-Type: application/json' \\\n  --data '{\n  \"value\": \"createissue\"\n}'","digest":"95d6c748ab5fcba58d2441a6394469007fe7395d56f2ba1f5ef80c0c8aff9105"},"Delete workflow transition property":{"name":"Delete workflow transition property","http_method":"DELETE","path":"/rest/api/3/workflow/transitions/{transitionId}/properties","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 and Workflow properties.","params":[{"name":"transitionId","type":"integer","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.","default":"int64"},{"name":"key","type":"string","description":"The name of the transition property to delete, also known as the name of the property."},{"name":"workflowName","type":"string","description":"The name of the workflow that the transition belongs to."},{"name":"workflowMode","type":"string","description":"The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited."}],"command":"curl --request DELETE \\\n  --url '/rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}' \\\n  --user 'email@example.com:<api_token>'","digest":"df4f2f970040e60249335576e3b2f1f102773a67d975fea8152ae994a5616832"},"Retrieve the number of actors (users and groups) assigned to a particular role in a project":{"name":"Retrieve the number of actors (users and groups) assigned to a particular role in a project","http_method":"GET","path":"/rest/api/3/project/{projectIdOrKey}/role/{id}/actorCount","description":"App scope required: READ","params":[{"name":"projectIdOrKey","type":"string","description":"The project ID or project key (case sensitive)."},{"name":"id","type":"integer","description":"The ID of the project role. Use Get all project roles to get a list of project role IDs.","default":"int64"}],"command":"curl --request GET \\\n  --url '/rest/api/3/project/{projectIdOrKey}/role/{id}/actorCount' \\\n  --user 'email@example.com:<api_token>' \\\n  --header 'Accept: application/json'","digest":"df25bde568746d3d6dff996fe92cf6385c312982f722131a021d94ce788156a8"}}