{ "info": { "name": "Jira Cloud API Get field auto complete for query string", "_postman_id": "7d2df832-e880-4cf2-9153-f7176d60f9e0", "description": "Returns auto complete suggestions for JQL search.", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/" }, "item": [ { "name": "Application", "item": [ { "id": "cbf566e8-6ab2-47b9-a5bc-7655b00e434d", "name": "com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource.getApplicationProperty_get", "request": { "url": "{{default}}/api/2/application-properties?key=%7B%7D&keyFilter=%7B%7D&permissionLevel=%7B%7D", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns an application property." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "ef2e9c2d-0fa7-495e-8b64-3f6a49468120" } ] }, { "id": "186b1127-1812-4025-918d-5311865ba06c", "name": "com.atlassian.jira.rest.v2.admin.applicationrole.ApplicationRoleResource.getAllApplicationRoles_get", "request": { "url": "{{default}}/api/2/applicationrole", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the collection of ApplicationRoles." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "fbe73207-cbfe-463f-9af0-f8bb3a3440b7" } ] }, { "id": "b8bbd44b-a6cd-4978-95b2-1d24f3f4c5c0", "name": "com.atlassian.jira.rest.v2.admin.applicationrole.ApplicationRoleResource.getApplicationRole_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/applicationrole/:key" ], "variable": [ { "id": "key", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the ApplicationRole with passed key if it exists." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "90474a40-7ce7-4bab-9542-eaa3ead8b7bf" } ] } ] }, { "name": "Advanced", "item": [ { "id": "39eb56ea-7e8c-4a4a-b0fb-3d5bcc3ddc91", "name": "com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource.getAdvancedSettings_get", "request": { "url": "{{default}}/api/2/application-properties/advanced-settings", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the properties that are displayed on the General Configuration Advanced Settings page." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "441dc077-9ca4-488f-aa73-ec1177761bfb" } ] } ] }, { "name": "Set", "item": [ { "id": "b6031a80-8a46-472b-a252-81ba7b4027e3", "name": "com.atlassian.jira.rest.v2.admin.ApplicationPropertiesResource.setApplicationProperty_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/application-properties/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Modify an application property via PUT. The \"value\" field present in the PUT will override the existing value." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "0bf2a31a-d6ff-40d4-b1de-d70bc19b0008" } ] }, { "id": "8a9563e6-1246-4f8f-8666-ae3bfff76fc9", "name": "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.setCommentProperty_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/comment/:commentId/properties/:propertyKey" ], "variable": [ { "id": "commentId", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the value of the specified comment's property.\n\nYou can use this resource to store a custom data against the comment identified by the key or by the id. The user who stores the data is required to have permissions to administer the comment." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "4be3f52a-cd5a-4cb1-9215-52c91a96cce8" } ] }, { "id": "e44496ea-5e4b-45eb-8e92-50d005be26c4", "name": "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.setSharedTimeTrackingConfiguratio", "request": { "url": "{{default}}/api/2/configuration/timetracking/options", "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the time tracking settings. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "897d788c-70f3-4a9f-8770-c21ebfbe6505" } ] }, { "id": "d5596020-7e20-4f97-a6f1-a4d6f8c6165b", "name": "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.setDashboardItemProperty_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKey" ], "variable": [ { "id": "dashboardId", "value": "{}", "type": "string" }, { "id": "itemId", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. \n \nA dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see [Adding and customizing gadgets](https://confluence.atlassian.com/x/7AeiLQ). \n \nWhen an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see [Building a dashboard item for a JIRA Connect add-on](https://developer.atlassian.com/server/jira/platform/guide-building-a-dashboard-item-for-a-jira-connect-add-on-33746254/) and the [Dashboard Item](https://developer.atlassian.com/cloud/jira/platform/modules/dashboard-item/) documentation. \n \nThere is no resource to set or get dashboard items. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. However, to set a dashboard item property the user must be the owner of the dashboard. Note, users with the _Administer Jira_ [global permission](href=) are considered owners of the System dashboard. \n \nThe value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 bytes." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "125a41c3-4dd1-4fc2-b1a3-e9f0ded69f55" } ] }, { "id": "56602b18-4405-4082-868c-c187a23be34c", "name": "com.atlassian.jira.rest.v2.search.FilterResource.setDefaultShareScope_put", "request": { "url": "{{default}}/api/2/filter/defaultShareScope", "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the default sharing for new filters and dashboards for a user. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "bf1f8d48-2704-49bb-87ac-d852b8db72e3" } ] }, { "id": "07bcf6df-dbd8-46fc-bf0c-f750a50a170f", "name": "com.atlassian.jira.rest.v2.search.FilterResource.setColumns_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/filter/:id/columns" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](https://developer.atlassian.com/cloud/jira/platform/rest#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL)) and permission to view the filter." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "959e8f3e-fc44-4e08-82dd-9ddb18fdfb6c" } ] }, { "id": "4a9fc3b0-1620-4ad7-baf9-5b235e189218", "name": "com.atlassian.jira.rest.v2.issue.IssuePropertyResource.setIssueProperty_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/properties/:propertyKey" ], "variable": [ { "id": "issueIdOrKey", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the value of the specified issue's property.\n\nYou can use this resource to store a custom data against the issue identified by the key or by the id. The user who stores the data is required to have permissions to edit the issue." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "415f3c8a-b884-44fc-9f69-3926ff195165" } ] }, { "id": "ec780eb8-d6f3-41f0-804b-286441469c4e", "name": "com.atlassian.jira.rest.v2.issue.WorklogPropertyResource.setWorklogProperty_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/worklog/:worklogId/properties/:propertyKey" ], "variable": [ { "id": "issueIdOrKey", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" }, { "id": "worklogId", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Sets the value of the specified worklog's property.\n\nYou can use this resource to store a custom data against the worklog identified by the key or by the id. The user who stores the data is required to have permissions to administer the worklog." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "068f2fae-dbf8-4dd3-8788-6b7ce7de453d" } ] }, { "id": "0f98e280-a561-4053-8688-1ab3c762fee2", "name": "com.atlassian.jira.rest.v2.issue.IssueTypePropertyResource.setIssueTypeProperty_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issuetype/:issueTypeId/properties/:propertyKey" ], "variable": [ { "id": "issueTypeId", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Creates or updates the value of the [issue type property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). Use this resource to store and update data against an issue type. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length of the property value is 32768 bytes. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ [global permission](href=)." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "13a38d73-8b98-45aa-bb08-5b18502cba52" } ] } ] }, { "name": "Global", "item": [ { "id": "db28462c-c050-412a-8c0a-28e46a2b4442", "name": "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.getAttachmentMeta_get", "request": { "url": "{{default}}/api/2/attachment/meta", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the global attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. \n \nNote that there are also [project permissions](https://confluence.atlassian.com/x/yodKLg) that restrict whether users can create and delete attachments or not. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "64b20811-e0c2-4bc9-9d21-63b3ea16392a" } ] }, { "id": "a0955d2c-0b41-430d-970e-77fe2335fc95", "name": "com.atlassian.jira.rest.v2.admin.ConfigurationResource.getConfiguration_get", "request": { "url": "{{default}}/api/2/configuration", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether optional features (for example, sub-tasks, time tracking, and others) are enabled. If time tracking is enabled, this method also returns the time tracking configuration. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Permission to log in to Jira (i.e., member of the _users_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "f37d47b6-c6eb-4423-afb8-bc5b650f3112" } ] } ] }, { "name": "Attachment", "item": [ { "id": "37c31b69-c11d-43f0-8c97-e99f704c7d3e", "name": "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.getAttachment_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/attachment/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the metadata for an attachment. Note that the attachment itself is not returned. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however the calling user must have permission to view the issue that the attachment belongs to." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "8c47308d-523f-460a-8480-391f7634fdbf" } ] }, { "id": "1d0f119c-c732-429c-a236-b3152f048871", "name": "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.removeAttachment_delete", "request": { "url": { "host": "{{default}}", "path": [ "api/2/attachment/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Deletes an attachment from an issue. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Any of the following permissions in the project that the issue is in:\n\n* _Delete own attachments_ [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by the calling user.\n* _Delete all attachments_ [project permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment created by any user." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "d0c10c24-c29e-45be-a127-3e6a8ce1d109" } ] }, { "id": "ae27fa24-0991-4416-b28d-6a322bfad291", "name": "com.atlassian.jira.rest.v2.issue.IssueAttachmentsResource.addAttachment_post", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/attachments" ], "variable": [ { "id": "issueIdOrKey", "value": "{}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Add one or more attachments to an issue.\n\nThis resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html) that makes it simple to submit a multipart POST.\n\nIn order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be blocked.\n\nThe name of the multipart/form-data parameter that contains attachments must be \"file\"\n\nA simple example to upload a file called \"myfile.txt\" to issue REST-123:\n\ncurl -D- -u admin:admin -X POST -H \"X-Atlassian-Token: no-check\" -F \"file=@myfile.txt\" http://myhost/rest/api/2/issue/TEST-123/attachments" }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "84f25382-6671-4548-ade3-6bfc79201703" } ] } ] }, { "name": "Metadataan", "item": [ { "id": "2ec74812-40b6-4f7f-8bdd-b58ee92b5b38", "name": "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.expandAttachmentForHumans_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/attachment/:id/expand/human" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive. Currently, only the ZIP archive format is supported. \n \nUse this method to retrieve data that is presented in the UI, as this method returns the metadata for the attachment itself, such as the attachment's ID and name. Otherwise, use [Get contents metadata for an expanded attachment](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-attachment-id-expand-raw-get), which only returns the metadata for the attachment's contents. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however the calling user must have permission to view the issue that the attachment belongs to." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "55917d09-db36-443e-8699-48ad81484a38" } ] } ] }, { "name": "Contents", "item": [ { "id": "69057862-0487-406a-970e-fc392e5bd65d", "name": "com.atlassian.jira.rest.v2.issue.attachment.AttachmentResource.expandAttachmentForMachines_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/attachment/:id/expand/raw" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported. \n \nUse this method if you are processing the data without presenting it in the UI, as this method only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present in the UI, use [Get all metadata for an expanded attachment](https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-attachment-id-expand-human-get) which also returns the metadata for the attachment itself, such as the attachment's ID and name. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** None, however the calling user must have permission to view the issue that the attachment belongs to." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "a0516a92-cfe0-4bec-a0b4-bf28ddb1e7c0" } ] } ] }, { "name": "Audit", "item": [ { "id": "0968b29a-432f-48d1-ab41-0381e6142076", "name": "com.atlassian.jira.rest.v2.admin.auditing.AuditingResource.getAuditRecords_get", "request": { "url": "{{default}}/api/2/auditing/record?filter=%7B%7D&from=%7B%7D&limit=%7B%7D&offset=%7B%7D&to=%7B%7D", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns auditing records filtered using provided parameters" }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "47a88961-bd38-4740-a1a5-c1399b558c84" } ] } ] }, { "name": "System", "item": [ { "id": "559519e1-f459-4dda-9d18-eca1b965f0e8", "name": "com.atlassian.jira.rest.v2.issue.AvatarResource.getAllSystemAvatars_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/avatar/:type/system" ], "variable": [ { "id": "type", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns all system avatars of the given type." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "4730c83c-95a1-4080-a81e-d87c147e3487" } ] } ] }, { "name": "Comments", "item": [ { "id": "8e6c204d-39ef-447f-b82e-893a16a29715", "name": "com.atlassian.jira.rest.v2.issue.IssueCommentListResource.getCommentsByIds_post", "request": { "url": "{{default}}/api/2/comment/list?expand=%7B%7D", "method": "POST", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns comments for given comments ids. Only comments to which the user has permissions, will be included in the result. The returned set of comments is limited to 1000 elements." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "74811db9-d71e-43df-852e-664cabec1186" } ] }, { "id": "77e38a38-8973-401c-84e4-cb17fc28b410", "name": "com.atlassian.jira.rest.v2.issue.IssueCommentResource.getComments_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/comment" ], "query": [ { "key": "expand", "value": "%7B%7D", "disabled": false }, { "key": "maxResults", "value": "%7B%7D", "disabled": false }, { "key": "orderBy", "value": "%7B%7D", "disabled": false }, { "key": "startAt", "value": "%7B%7D", "disabled": false } ], "variable": [ { "id": "issueIdOrKey", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns all comments for an issue.\n\nResults can be ordered by the \"created\" field which means the date a comment was added." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "b78601f7-e876-4325-a12d-11f42e3e7315" } ] } ] }, { "name": "Comment", "item": [ { "id": "f74aee84-b148-4e28-a7cf-4465189f7da1", "name": "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.getCommentPropertyKeys_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/comment/:commentId/properties" ], "variable": [ { "id": "commentId", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the keys of all properties for the comment identified by the key or by the id." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "ed31ccf0-44bb-43ef-874e-097f702848eb" } ] }, { "id": "3e52ec4b-3023-4118-b462-3d4033230bae", "name": "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.getCommentProperty_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/comment/:commentId/properties/:propertyKey" ], "variable": [ { "id": "commentId", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to have permissions to read the comment." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "7b64807e-020e-4c67-add9-28eef20c1655" } ] }, { "id": "aff2be61-fe91-4d41-8399-5348d4c3ba00", "name": "com.atlassian.jira.rest.v2.issue.CommentPropertyResource.deleteCommentProperty_delete", "request": { "url": { "host": "{{default}}", "path": [ "api/2/comment/:commentId/properties/:propertyKey" ], "variable": [ { "id": "commentId", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Removes the property from the comment identified by the key or by the id. Ths user removing the property is required to have permissions to administer the comment." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "e9ef5deb-3e1f-4faa-acb2-4e40102a76b5" } ] }, { "id": "af0ef730-d484-4912-bfd0-d12012819794", "name": "com.atlassian.jira.rest.v2.issue.IssueCommentResource.addComment_post", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/comment" ], "query": [ { "key": "expand", "value": "%7B%7D", "disabled": false } ], "variable": [ { "id": "issueIdOrKey", "value": "{}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Adds a new comment to an issue." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "c346fa50-6f32-4bff-8bc8-45b3d4b53723" } ] }, { "id": "d9a50136-cdef-48b2-9f4c-37f3c8f6c297", "name": "com.atlassian.jira.rest.v2.issue.IssueCommentResource.getComment_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/comment/:id" ], "query": [ { "key": "expand", "value": "%7B%7D", "disabled": false } ], "variable": [ { "id": "id", "value": "{}", "type": "string" }, { "id": "issueIdOrKey", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns a single comment." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "16bf812a-2ab1-4332-929d-d63daabc115b" } ] }, { "id": "3514783a-637c-4305-8b76-9b338f198eca", "name": "com.atlassian.jira.rest.v2.issue.IssueCommentResource.updateComment_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/comment/:id" ], "query": [ { "key": "expand", "value": "%7B%7D", "disabled": false } ], "variable": [ { "id": "id", "value": "{}", "type": "string" }, { "id": "issueIdOrKey", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Updates an existing comment using its JSON representation." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "4e762e5d-bed2-417c-846c-d5781dc9fb9f" } ] }, { "id": "58d28bf8-4024-4d97-95bb-cb1e6ae41b63", "name": "com.atlassian.jira.rest.v2.issue.IssueCommentResource.deleteComment_delete", "request": { "url": { "host": "{{default}}", "path": [ "api/2/issue/:issueIdOrKey/comment/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" }, { "id": "issueIdOrKey", "value": "{}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Deletes an existing comment ." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "43f7386f-5fa1-4f1c-9969-6d01359dba52" } ] } ] }, { "name": "Component", "item": [ { "id": "bfca08a0-3932-471e-b18b-accf412c7708", "name": "com.atlassian.jira.rest.v2.issue.ComponentResource.createComponent_post", "request": { "url": "{{default}}/api/2/component", "method": "POST", "header": [ { "key": "force-account-id", "value": "{}", "description": "", "disabled": false }, { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Creates a component. Use components to provide containers for issues within a project. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: Any of the following:\n\n* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).\n* _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg)." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "d45c0277-c924-4ef6-bb55-2f2218f42631" } ] }, { "id": "03484be4-1a6d-49a6-aa3f-0a8bd0bd0f7c", "name": "com.atlassian.jira.rest.v2.issue.ComponentResource.getComponent_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/component/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns a component. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg)." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "1d896893-214a-4db7-bdd3-3c2c21d50a7a" } ] }, { "id": "5cfd6b55-72b2-4063-9fc6-ec913cdb4ad2", "name": "com.atlassian.jira.rest.v2.issue.ComponentResource.updateComponent_put", "request": { "url": { "host": "{{default}}", "path": [ "api/2/component/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "force-account-id", "value": "{}", "description": "", "disabled": false }, { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Modifies a component. Any fields included in the request are overwritten. If `leadUserName` is an empty string (\"\") the component lead is removed. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: Any of the following:\n\n* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).\n* _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg)." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "f23e6ef3-2cb3-4e73-855b-39a80bc9f4b8" } ] }, { "id": "9ba160ea-7f4c-4cee-8dda-c582a6dc59f5", "name": "com.atlassian.jira.rest.v2.issue.ComponentResource.deleteComponent_delete", "request": { "url": { "host": "{{default}}", "path": [ "api/2/component/:id" ], "query": [ { "key": "moveIssuesTo", "value": "%7B%7D", "disabled": false } ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Deletes a component. [Permissions](https://confluence.atlassian.com/x/FQiiLQ) required: Any of the following:\n\n* _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).\n* _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg)." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "40891aa6-2d9b-4060-8a3f-6b1bf05552f8" } ] }, { "id": "e5491e4f-65fc-450e-ad4a-5c71c4ac27b2", "name": "com.atlassian.jira.rest.v2.issue.ComponentResource.getComponentRelatedIssues_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/component/:id/relatedIssueCounts" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the counts of issues assigned to the component. **[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "7b8bb667-e4d0-41d6-b9c5-c46307456c67" } ] } ] }, { "name": "Selected", "item": [ { "id": "b752a582-d9bd-4108-b3bf-a41560bd4fb1", "name": "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.getSelectedTimeTrackingImplementa", "request": { "url": "{{default}}/api/2/configuration/timetracking", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "31528109-ab8e-4f81-a4d9-a26b1ea2e87b" } ] } ] }, { "name": "Select", "item": [ { "id": "f4989947-8395-4426-9cf4-dd1411b3a395", "name": "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.selectTimeTrackingImplementation_", "request": { "url": "{{default}}/api/2/configuration/timetracking", "method": "PUT", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Selects a time tracking provider. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "febc86e8-e408-4dcc-9c06-820a0153c97c" } ] } ] }, { "name": "Disable", "item": [ { "id": "ebffae1b-5da4-4c16-8305-7f8ede7b3962", "name": "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.disableTimeTracking_delete", "request": { "url": "{{default}}/api/2/configuration/timetracking", "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Disables time tracking. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "514ecccc-f929-4d76-945e-c0159db5bc84" } ] } ] }, { "name": "Time", "item": [ { "id": "dea23bb5-df00-49c2-afe9-8215a34815e1", "name": "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.getAvailableTimeTrackingImplement", "request": { "url": "{{default}}/api/2/configuration/timetracking/list", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns all time tracking providers. By default, Jira only has one time tracking provider: _JIRA provided time tracking_. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the [Time Tracking Provider](https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/) module. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "1da537cf-cfab-45c4-9311-549a9eab0dcd" } ] }, { "id": "0d8aabe8-af2c-43ce-8241-31a27cdfbc41", "name": "com.atlassian.jira.rest.v2.admin.timetracking.TimeTrackingResource.getSharedTimeTrackingConfiguratio", "request": { "url": "{{default}}/api/2/configuration/timetracking/options", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see [Configuring time tracking](https://confluence.atlassian.com/x/qoXKM). \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** Jira administration (that is, member of the _administrators_ [group](https://confluence.atlassian.com/x/24xjL))." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "d1c9f0f6-7809-44e1-a383-cfc8984ff849" } ] } ] }, { "name": "Custom", "item": [ { "id": "95a853ae-b291-471f-985a-ec5e64a30741", "name": "com.atlassian.jira.rest.v2.issue.customfield.CustomFieldOptionResource.getCustomFieldOption_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/customFieldOption/:id" ], "variable": [ { "id": "id", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns a custom field option. For example, an option in a cascading select list. \n \n**[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/#permissions) required:** None." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "a760fc46-61f6-46b1-ad59-f89a7f3f904d" } ] }, { "id": "53c974a7-0c3b-4a35-b9d7-2794aaffb7c4", "name": "com.atlassian.jira.rest.v2.issue.FieldResource.createCustomField_post", "request": { "url": "{{default}}/api/2/field", "method": "POST", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Creates a custom field.\n\n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** _Administer Jira_ global permission." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "ec6b60fe-406c-4677-86e1-b2a662e59922" } ] } ] }, { "name": "Dashboards", "item": [ { "id": "b96cc051-2f71-4448-88bc-3ed03a389db9", "name": "com.atlassian.jira.rest.v2.dashboard.DashboardResource.getAllDashboards_get", "request": { "url": "{{default}}/api/2/dashboard?filter=%7B%7D&maxResults=%7B%7D&startAt=%7B%7D", "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "b4e3b452-2c7c-4207-9694-1adfe6dc9168" } ] } ] }, { "name": "Dashboard", "item": [ { "id": "23fae619-b828-412a-83a4-7077cadafff9", "name": "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.getDashboardItemPropertyKeys_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/dashboard/:dashboardId/items/:itemId/properties" ], "variable": [ { "id": "dashboardId", "value": "{}", "type": "string" }, { "id": "itemId", "value": "{}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "disabled": false } ], "body": { "mode": "raw" }, "description": "Returns the keys of all properties for a dashboard item. \n \n**[Permissions](https://confluence.atlassian.com/x/FQiiLQ) required:** Permission to access Jira. However, to get the property keys the user must be the owner of the dashboard or be shared the dashboard. Note, users with the _Administer Jira_ [global permission](href=) are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users." }, "response": [ { "status": "OK", "code": 200, "name": "Response_200", "id": "80760fd8-0281-445c-81d5-4c3d9171abbd" } ] }, { "id": "c7fda2e7-11bd-46f7-b373-5446be86f1ab", "name": "com.atlassian.jira.rest.v2.dashboard.DashboardItemPropertyResource.getDashboardItemProperty_get", "request": { "url": { "host": "{{default}}", "path": [ "api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKey" ], "variable": [ { "id": "dashboardId", "value": "{}", "type": "string" }, { "id": "itemId", "value": "{}", "type": "string" }, { "id": "propertyKey", "value": "{}",