{ "uuid": "ccf09d22-c5ee-4942-9d02-7013a7628d8a", "lastMigration": 24, "name": "JIRA 7.6.1", "endpointPrefix": "jira/rest/", "latency": 0, "port": 8080, "hostname": "0.0.0.0", "routes": [ { "uuid": "6e3796ad-aa49-46b5-be5a-c39c0cd2898f", "documentation": "Returns an application property.", "method": "get", "endpoint": "api/2/application-properties", "responses": [ { "uuid": "8425336b-26c0-4ccf-8145-7c98a39720bf", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ed4b6e31-f4a3-40b7-9a6a-04d7e9d660e9", "documentation": "Returns the properties that are displayed on the \"General Configuration > Advanced Settings\" page.", "method": "get", "endpoint": "api/2/application-properties/advanced-settings", "responses": [ { "uuid": "f7774503-fd2f-4650-9809-01fcbe300e8e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b9241c30-703f-40d0-8ac3-4ee67c57e095", "documentation": "Modify an application property via PUT. The \"value\" field present in the PUT will override the existing value.", "method": "put", "endpoint": "api/2/application-properties/:id", "responses": [ { "uuid": "fa28d546-70af-417f-917a-0ff55586fc47", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "dda0ec59-f24d-4db5-9881-28a573441d5a", "documentation": "Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the\n collection of ApplicationRoles.", "method": "get", "endpoint": "api/2/applicationrole", "responses": [ { "uuid": "0793949d-f731-47ed-80be-1bfa04fa14ae", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "15018c94-626b-488b-a4e4-5b2933d9192e", "documentation": "Updates the ApplicationRoles with the passed data if the version hash is the same as the server.\n Only the groups and default groups setting of the role may be updated. Requests to change the key\n or the name of the role will be silently ignored. It is acceptable to pass only the roles that are updated\n as roles that are present in the server but not in data to update with, will not be deleted.", "method": "put", "endpoint": "api/2/applicationrole", "responses": [ { "uuid": "99abedfa-f3f0-420e-a5c8-8e13ade6ba6a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "834b1541-10fe-499f-a2da-1e8e80f6c2af", "documentation": "Returns the ApplicationRole with passed key if it exists.", "method": "get", "endpoint": "api/2/applicationrole/:key", "responses": [ { "uuid": "4cfee54a-cfed-4b12-b1f4-c364a77b5a00", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "67fa747c-1b4f-4fe6-95fd-2781fe180a73", "documentation": "Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the\n role may be updated. Requests to change the key or the name of the role will be silently ignored.\n

\n Optional: If versionHash is passed through the If-Match header the request will be rejected if not the\n same as server", "method": "put", "endpoint": "api/2/applicationrole/:key", "responses": [ { "uuid": "c0b56d52-8ef4-4863-b0c5-4a68830ba59e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fe736a54-3084-4cc5-9115-ae0de73b0d01", "documentation": "Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size\n allowed.", "method": "get", "endpoint": "api/2/attachment/meta", "responses": [ { "uuid": "882aba80-8a31-4f6d-98f0-5e65bfeda03b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1f6260b9-31b5-4d22-be42-c551a846f3ef", "documentation": "Remove an attachment from an issue.", "method": "delete", "endpoint": "api/2/attachment/:id", "responses": [ { "uuid": "2272e16d-411f-4fd1-a3db-7ba37d29f0ab", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cabecc85-a683-4dcf-ad98-860f76588599", "documentation": "Returns the meta-data for an attachment, including the URI of the actual attached file.", "method": "get", "endpoint": "api/2/attachment/:id", "responses": [ { "uuid": "ef07175f-7508-4933-bca3-3ccc9f980edd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "53d31790-25b7-4442-9637-b8bc3f00fd9d", "documentation": "Tries to expand an attachment. Output is human-readable and subject to change.", "method": "get", "endpoint": "api/2/attachment/:id/expand/human", "responses": [ { "uuid": "4e6d388f-9081-41b5-91ce-2febfede113b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a140a4fa-4b70-4528-a894-367f353d5fa7", "documentation": "Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.", "method": "get", "endpoint": "api/2/attachment/:id/expand/raw", "responses": [ { "uuid": "16223e52-2661-4fc6-bfb4-ef98aba7bdba", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6c5a7a86-0fa8-424e-a6c8-ec037ce66ce6", "documentation": "Returns auditing records filtered using provided parameters", "method": "get", "endpoint": "api/2/auditing/record", "responses": [ { "uuid": "ff9ce351-c1f2-43a5-89e9-89ba130bc4d6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "547ba778-4898-4286-8cd5-69174e50f150", "documentation": "Store a record in Audit Log", "method": "post", "endpoint": "api/2/auditing/record", "responses": [ { "uuid": "d3c6ab28-3ee6-4f27-a27a-d7cf8c1f1138", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "981d91d5-52fe-453a-8695-1e807fd84756", "documentation": "Returns all system avatars of the given type.", "method": "get", "endpoint": "api/2/avatar/:type/system", "responses": [ { "uuid": "fc4b26a6-0293-4744-a8d6-9ba554745dcf", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "931533df-cb1b-4618-b902-5bcf00e7ad05", "documentation": "Creates temporary avatar", "method": "post", "endpoint": "api/2/avatar/:type/temporary", "responses": [ { "uuid": "c7d7d2eb-c422-47cb-b494-0e5407d11f8c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "12cfaa61-8fc4-44cd-910a-8d558c4d2bc9", "documentation": "Updates the cropping instructions of the temporary avatar.", "method": "post", "endpoint": "api/2/avatar/:type/temporaryCrop", "responses": [ { "uuid": "7ae284f2-09bc-4e04-b060-df370e4c44c0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "88568613-9921-4b0b-840d-54cd003ab8b6", "documentation": "", "method": "post", "endpoint": "api/2/cluster/zdu/approve", "responses": [ { "uuid": "360cb763-21f7-47bd-9d7a-99437b3e416e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "27c7126d-c72d-4b76-a11d-3728a0bf6b43", "documentation": "", "method": "post", "endpoint": "api/2/cluster/zdu/cancel", "responses": [ { "uuid": "f14a26f0-40b2-41fd-86c6-3b01256b9c84", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6eb43354-9cda-44b5-b791-623a9c6f74d8", "documentation": "", "method": "post", "endpoint": "api/2/cluster/zdu/retryUpgrade", "responses": [ { "uuid": "f441b560-2541-44e3-83c0-d352eb410a59", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4c2ce687-8b9e-4080-b4b3-cc2b7f7194c5", "documentation": "", "method": "post", "endpoint": "api/2/cluster/zdu/start", "responses": [ { "uuid": "de230d65-01ba-4f5f-be20-8ace917ef96e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "108c7bce-1a59-4e3b-9383-f6980c5a9cea", "documentation": "", "method": "get", "endpoint": "api/2/cluster/zdu/state", "responses": [ { "uuid": "74184270-ab5a-42a1-a2ae-30de890aeb19", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b133435c-0992-4b61-b487-574af0ab0938", "documentation": "Returns the keys of all properties for the comment identified by the key or by the id.", "method": "get", "endpoint": "api/2/comment/:commentId/properties", "responses": [ { "uuid": "e7265b74-1975-4445-bd15-b613815fdfe5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "aa70105f-6568-4130-b8cc-3d7ec9f407a8", "documentation": "Removes the property from the comment identified by the key or by the id. Ths user removing the property is required\n to have permissions to administer the comment.", "method": "delete", "endpoint": "api/2/comment/:commentId/properties/:propertyKey", "responses": [ { "uuid": "e9f5edf9-270e-419e-a8e5-483ef68e6fc7", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "38a6429b-e80f-43f7-8b56-7439c3f01fb3", "documentation": "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\n the property is required to have permissions to read the comment.", "method": "get", "endpoint": "api/2/comment/:commentId/properties/:propertyKey", "responses": [ { "uuid": "e670d617-5fe2-483b-82a7-777d2ba5c4c6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "20caded4-7f85-4630-a991-0e661f806b08", "documentation": "Sets the value of the specified comment's property.\n

\n You can use this resource to store a custom data against the comment identified by the key or by the id. The user\n who stores the data is required to have permissions to administer the comment.\n

", "method": "put", "endpoint": "api/2/comment/:commentId/properties/:propertyKey", "responses": [ { "uuid": "eecf9c74-40bf-4dc1-a4eb-90f12faa4120", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1b9d5381-fc1b-463b-98da-22e7bd1e29f5", "documentation": "Create a component via POST.", "method": "post", "endpoint": "api/2/component", "responses": [ { "uuid": "31aed7db-f470-48d0-aec6-1526b2730b63", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "982965c9-f2f3-4822-b7bc-1bff515840db", "documentation": "Delete a project component.", "method": "delete", "endpoint": "api/2/component/:id", "responses": [ { "uuid": "2f34c85d-30a0-4c54-b6ce-cbace50abf27", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b8e389c4-63f1-4fca-b85f-11e274894e22", "documentation": "Returns a project component.", "method": "get", "endpoint": "api/2/component/:id", "responses": [ { "uuid": "bb385f7a-62f5-4787-a1d1-24eccd899238", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "23d551e7-b228-4552-86a2-2240b6665ff8", "documentation": "Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field\n is not present, it is silently ignored.\n

\n If leadUserName is an empty string (\"\") the component lead will be removed.", "method": "put", "endpoint": "api/2/component/:id", "responses": [ { "uuid": "50b8c529-270f-464c-9a12-39436785bd5f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b78afb85-5752-4a2e-affd-796eff75f5e1", "documentation": "Returns counts of issues related to this component.", "method": "get", "endpoint": "api/2/component/:id/relatedIssueCounts", "responses": [ { "uuid": "a9804cca-4073-44b9-84c1-a7e62cdc692b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c235c5cc-fd0f-423e-8b7f-8e1253948df4", "documentation": "Returns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled,\n it also returns the detailed information about time tracking configuration.", "method": "get", "endpoint": "api/2/configuration", "responses": [ { "uuid": "5976c60d-bfd1-40e6-acef-f1ca8cea45e8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9040c14d-fc12-4dcb-9c31-82f29baef952", "documentation": "Returns a full representation of the Custom Field Option that has the given id.", "method": "get", "endpoint": "api/2/customFieldOption/:id", "responses": [ { "uuid": "262b6dee-8314-4887-9869-72ef8a4a1ed8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "70f7319c-59a6-46e8-899d-a1802b618a51", "documentation": "Returns a list of all dashboards, optionally filtering them.", "method": "get", "endpoint": "api/2/dashboard", "responses": [ { "uuid": "80320b27-3f35-4483-9036-129928b34305", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c48f7bd1-3b71-4b02-951f-1c32510282ee", "documentation": "Returns the keys of all properties for the dashboard item identified by the id.", "method": "get", "endpoint": "api/2/dashboard/:dashboardId/items/:itemId/properties", "responses": [ { "uuid": "c7ca0bea-1dbb-462a-ba6c-ba5b74248bbe", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "eb138787-49ee-4b9d-88c9-0eeab91d76df", "documentation": "Removes the property from the dashboard item identified by the key or by the id. Ths user removing the property is required\n to have permissions to administer the dashboard item.", "method": "delete", "endpoint": "api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKey", "responses": [ { "uuid": "fedc29b0-f593-46ab-9d42-90eb84efac61", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e601f017-55c9-41d3-94c9-6dc2f6108add", "documentation": "Returns the value of the property with a given key from the dashboard item identified by the id.\n The user who retrieves the property is required to have permissions to read the dashboard item.", "method": "get", "endpoint": "api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKey", "responses": [ { "uuid": "eb978f6e-8dd0-4a56-b112-2e9927919c0a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "53871261-fe42-4307-a3ef-24a8a0937424", "documentation": "Sets the value of the specified dashboard item's property.\n

\n You can use this resource to store a custom data against the dashboard item identified by the id.\n The user who stores the data is required to have permissions to administer the dashboard item.\n

", "method": "put", "endpoint": "api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKey", "responses": [ { "uuid": "0210ae73-08e2-42f9-8cea-c6402db734d6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a48312ad-cfce-4771-935a-7c73a6b45453", "documentation": "Returns a single dashboard.", "method": "get", "endpoint": "api/2/dashboard/:id", "responses": [ { "uuid": "a4ce00df-67cb-42fd-8c91-dfe5e9611c99", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f04df11d-649c-488e-aac0-5b19f1dc6c39", "documentation": "Returns a list of all fields, both System and Custom", "method": "get", "endpoint": "api/2/field", "responses": [ { "uuid": "cead82f4-8867-4337-8ec8-1cc3f84c0823", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cf816536-96f5-4802-8fbf-c4084ca2172c", "documentation": "Creates a custom field using a definition (object encapsulating custom field data)", "method": "post", "endpoint": "api/2/field", "responses": [ { "uuid": "69785048-51e0-4acb-bd29-b042be147e5e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "65b07915-5332-46c7-8589-48f1f2bf63b9", "documentation": "Creates a new filter, and returns newly created filter.\n Currently sets permissions just using the users default sharing permissions", "method": "post", "endpoint": "api/2/filter", "responses": [ { "uuid": "5da49d13-c409-4dc5-b282-c95bc2844a77", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0832757c-c5ed-4b4d-951f-b51533d58e9c", "documentation": "Returns the default share scope of the logged-in user.", "method": "get", "endpoint": "api/2/filter/defaultShareScope", "responses": [ { "uuid": "12853dee-2e65-475e-80db-c36abbc5eb68", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bf1babe8-4650-459a-9a62-679c5b3706f4", "documentation": "Sets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.", "method": "put", "endpoint": "api/2/filter/defaultShareScope", "responses": [ { "uuid": "ca56dd50-73d5-41f1-8991-ce7ec06fb275", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "624a8466-b656-4807-8a14-d21a70c21995", "documentation": "Returns the favourite filters of the logged-in user.", "method": "get", "endpoint": "api/2/filter/favourite", "responses": [ { "uuid": "797ab076-19e6-48ae-9e86-1b6ffde08df5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "baa8e467-712c-4173-acf9-c30f79ca3901", "documentation": "Delete a filter.", "method": "delete", "endpoint": "api/2/filter/:id", "responses": [ { "uuid": "8fd7f739-056d-4b4f-8d37-6ce2ac9c17af", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4ac50f58-73a9-4255-acca-1e3d7d5fc414", "documentation": "Returns a filter given an id", "method": "get", "endpoint": "api/2/filter/:id", "responses": [ { "uuid": "f0785753-ccf3-44fb-8aa2-ca7d8e414efd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "56467806-e3f0-4016-993b-ac1831d78050", "documentation": "Updates an existing filter, and returns its new value.", "method": "put", "endpoint": "api/2/filter/:id", "responses": [ { "uuid": "bb220d37-2a94-439e-8a13-71533a798025", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3cdd666a-1fd7-4135-abe6-911bb4a7ae88", "documentation": "Resets the columns for the given filter such that the filter no longer has its own column config.", "method": "delete", "endpoint": "api/2/filter/:id/columns", "responses": [ { "uuid": "3e96e3f6-3014-4486-b967-c5195924b155", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "15bb3e69-d5e7-4c77-91b6-ba4099c0826e", "documentation": "Returns the default columns for the given filter. Currently logged in user will be used as\n the user making such request.", "method": "get", "endpoint": "api/2/filter/:id/columns", "responses": [ { "uuid": "289d06e6-2a6b-4d79-ae45-1322143697cf", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "382f97ef-c7bc-41fb-a00e-9852511b0b7f", "documentation": "Sets the default columns for the given filter.", "method": "put", "endpoint": "api/2/filter/:id/columns", "responses": [ { "uuid": "bd028815-6370-4e0d-b1e3-247c554ac5ef", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a926cc9f-3a3d-4b15-94f7-ac6b3731d88b", "documentation": "Returns all share permissions of the given filter.", "method": "get", "endpoint": "api/2/filter/:id/permission", "responses": [ { "uuid": "a678e793-5f36-4d10-8261-2431a112b987", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "980fa06b-7319-46ac-b42d-e6ddef7dd247", "documentation": "Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter.", "method": "post", "endpoint": "api/2/filter/:id/permission", "responses": [ { "uuid": "c8d1cfb3-3196-48e1-aec2-688d61896954", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b86963c3-d25f-4d5e-9c25-3cb004b591b0", "documentation": "Removes a share permissions from the given filter.", "method": "delete", "endpoint": "api/2/filter/:id/permission/{permission-id}", "responses": [ { "uuid": "3743c748-aa67-4e7e-9081-9f7c413e8f0a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a78726de-fbe8-4a91-8242-d6bb60b6e219", "documentation": "Returns a single share permission of the given filter.", "method": "get", "endpoint": "api/2/filter/:id/permission/:permissionId", "responses": [ { "uuid": "2fd71290-d287-4d76-90b5-5636c807dd7b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4580a30f-5754-4d03-87c6-d13bb8e21f87", "documentation": "Deletes a group by given group parameter.\n

\n Returns no content", "method": "delete", "endpoint": "api/2/group", "responses": [ { "uuid": "89d1846d-ed46-4847-a54d-653424d51eeb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "dc65ef09-f2e1-49af-b6d7-468c88636f71", "documentation": "Returns REST representation for the requested group. Allows to get list of active users belonging to the\n specified group and its subgroups if \"users\" expand option is provided. You can page through users list by using\n indexes in expand param. For example to get users from index 10 to index 15 use \"users[10:15]\" expand value. This\n will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.\n

\n This resource is deprecated, please use group/member API instead.", "method": "get", "endpoint": "api/2/group", "responses": [ { "uuid": "ee291c9a-7305-4c8d-8c31-65747c71a37e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6b5ba4f9-008e-4588-bac2-4ce66db60846", "documentation": "Creates a group by given group parameter\n

\n Returns REST representation for the requested group.", "method": "post", "endpoint": "api/2/group", "responses": [ { "uuid": "8e0b6819-443d-4abb-9c1e-22d9afb6b268", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "717afdcf-42bf-4762-bc13-1bb4d26caffb", "documentation": "This resource returns a paginated list of users who are members of the specified group and its subgroups.\n Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.", "method": "get", "endpoint": "api/2/group/member", "responses": [ { "uuid": "c28d6758-7095-4965-92db-3dab63491f47", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "27741a1f-4809-4764-b0de-668c6abdde7d", "documentation": "Removes given user from a group.\n

\n Returns no content", "method": "delete", "endpoint": "api/2/group/user", "responses": [ { "uuid": "75f35017-15fe-4fe9-bd92-ce0e40f4b9b6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8eb0ccd0-98d1-4cca-be23-81ea5a1858b0", "documentation": "Adds given user to a group.\n

\n Returns the current state of the group.", "method": "post", "endpoint": "api/2/group/user", "responses": [ { "uuid": "ee11609b-fc4d-438e-bd0d-416332f6ce16", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2ab189ca-e888-469d-88d1-5da66712e5ec", "documentation": "Returns groups with substrings matching a given query. This is mainly for use with\n the group picker, so the returned groups contain html to be used as picker suggestions.\n The groups are also wrapped in a single response object that also contains a header for\n use in the picker, specifically Showing X of Y matching groups.\n

\n The number of groups returned is limited by the system property \"jira.ajax.autocomplete.limit\"\n

\n The groups will be unique and sorted.", "method": "get", "endpoint": "api/2/groups/picker", "responses": [ { "uuid": "f2ad1683-1b4c-43fc-b8f3-aacda956b160", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d6bee77e-5f11-4cc4-ac04-3b5c4183ffa9", "documentation": "Returns a list of users and groups matching query with highlighting. This resource cannot be accessed\n anonymously.", "method": "get", "endpoint": "api/2/groupuserpicker", "responses": [ { "uuid": "22f3251d-c365-4260-828e-2ee43ccc9f28", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d8aef5e3-c191-492d-b95d-df54ecab0530", "documentation": "Summarizes index condition of current node.\n

\n Returned data consists of:\n

\n

\n issueIndex can contain:\n

\n

\n replicationQueues's map values can contain:\n

", "method": "get", "endpoint": "api/2/index/summary", "responses": [ { "uuid": "e7b68f31-3f38-4794-909d-aec663e296f7", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6a9020b0-f587-4336-8ea6-a7ad1dbff7da", "documentation": "Creates an issue or a sub-task from a JSON representation.\n

\n The fields that can be set on create, in either the fields parameter or the update parameter can be determined\n using the /rest/api/2/issue/createmeta resource.\n If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field\n validation error will occur if it is submitted.\n

\n Creating a sub-task is similar to creating a regular issue, with two important differences:\n

", "method": "post", "endpoint": "api/2/issue", "responses": [ { "uuid": "d9a3673e-a6f8-4ec9-85bf-4dcd2f3a7fde", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5c121ef2-897f-453e-b599-f5161008c9fa", "documentation": "Creates issues or sub-tasks from a JSON representation.\n

\n Creates many issues in one bulk operation.\n

\n Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section:\n {@link IssueResource#createIssue(IssueUpdateBean)}}", "method": "post", "endpoint": "api/2/issue/bulk", "responses": [ { "uuid": "346ca7e5-19a4-45f8-9440-5b2e9c1745ed", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "17c091dd-91e4-446a-b286-c920ac11cd12", "documentation": "Returns the meta data for creating issues. This includes the available projects, issue types and fields,\n including field types and whether or not those fields are required.\n Projects will not be returned if the user does not have permission to create issues in that project.\n

\n The fields in the createmeta correspond to the fields in the create screen for the project/issuetype.\n Fields not in the screen will not be in the createmeta.\n

\n Fields will only be returned if expand=projects.issuetypes.fields.\n

\n The results can be filtered by project and/or issue type, given by the query params.", "method": "get", "endpoint": "api/2/issue/createmeta", "responses": [ { "uuid": "7cb63d7d-9f7b-405e-a38a-aadadae168fc", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "296f4dc9-413c-4a74-8f02-399cd92dc146", "documentation": "Returns suggested issues which match the auto-completion query for the user which executes this request. This REST\n method will check the user's history and the user's browsing context and select this issues, which match the query.", "method": "get", "endpoint": "api/2/issue/picker", "responses": [ { "uuid": "41f94ed5-ce06-47ed-8472-f1bb7c61a9fd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9600e228-230d-4170-b071-e5c379e86d44", "documentation": "Delete an issue.\n

\n If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue.\n You cannot delete an issue without its subtasks also being deleted.", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey", "responses": [ { "uuid": "8120ab35-2744-484e-a102-a9dbdffa8f70", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1e5483c2-49ba-430a-a455-ad20cc7b3d8e", "documentation": "Returns a full representation of the issue for the given issue key.\n

\n An issue JSON consists of the issue key, a collection of fields,\n a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it\n (e.g. if wiki syntax is enabled for the description or comments).\n

\n The fields param (which can be specified multiple times) gives a comma-separated list of fields\n to include in the response. This can be used to retrieve a subset of fields.\n A particular field can be excluded by prefixing it with a minus.\n

\n By default, all (*all) fields are returned in this get-issue resource. Note: the default is different\n when doing a jql search -- the default there is just navigable fields (*navigable).\n

\n

\n The {@code properties} param is similar to {@code fields} and specifies a comma-separated list of issue\n properties to include. Unlike {@code fields}, properties are not included by default. To include them all\n send {@code ?properties=*all}. You can also include only specified properties or exclude some properties\n with a minus (-) sign.\n

\n

\n

\n

\n JIRA will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id,\n or an issue key. If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or\n by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect\n will not be returned). The issue key contained in the response will indicate the current value of issue's key.\n

\n The expand param is used to include, hidden by default, parts of response. This can be used to include:\n

", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey", "responses": [ { "uuid": "2f9c1076-9efd-4730-9582-12a85919a47e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4307f64d-09b7-4e7d-80df-808d98e08d85", "documentation": "Edits an issue from a JSON representation.\n

\n The issue can either be updated by setting explicit the field value(s)\n or by using an operation to change the field value.\n

\n The fields that can be updated, in either the fields parameter or the update parameter, can be determined\n using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource.
\n If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field\n validation error will occur if it is submitted.\n

\n Specifying a \"field_id\": field_value in the \"fields\" is a shorthand for a \"set\" operation in the \"update\" section.
\n Field should appear either in \"fields\" or \"update\", not in both.", "method": "put", "endpoint": "api/2/issue/:issueIdOrKey", "responses": [ { "uuid": "f18b2d09-141a-41e4-8fac-a662d27492e1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3ce74f72-caf5-497a-baf0-266a252882d2", "documentation": "Assigns an issue to a user.\n You can use this resource to assign issues when the user submitting the request has the assign permission but not the\n edit issue permission.\n If the name is \"-1\" automatic assignee is used. A null name will remove the assignee.", "method": "put", "endpoint": "api/2/issue/:issueIdOrKey/assignee", "responses": [ { "uuid": "02e03877-5a59-4d71-87fb-47bfca228d4e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "34dae271-fc0d-4859-a201-a119da407f2a", "documentation": "Add one or more attachments to an issue.\n

\n This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client\n libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components\n library provides a\n MultiPartEntity\n that makes it simple to submit a multipart POST.\n

\n In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection\n on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be\n blocked.\n

\n The name of the multipart/form-data parameter that contains attachments must be \"file\"\n

\n A simple example to upload a file called \"myfile.txt\" to issue REST-123:\n 

curl -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
", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/attachments", "responses": [ { "uuid": "a6b63785-ba45-4665-b42d-ca94db421cb1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d196a09f-985d-43a7-938b-55240f06ecd3", "documentation": "Returns all comments for an issue.\n

\n Results can be ordered by the \"created\" field which means the date a comment was added.\n

", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/comment", "responses": [ { "uuid": "ba81d082-c553-4e48-aa60-a25534558859", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8af370ab-dc00-4414-bbec-e7348a458b49", "documentation": "Adds a new comment to an issue.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/comment", "responses": [ { "uuid": "abe0f5be-50ae-45b3-97db-3bc082173439", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f8e41a1a-2c5d-4b0d-9cf4-ba06ec8bc3fb", "documentation": "Deletes an existing comment .", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/comment/:id", "responses": [ { "uuid": "7c259ac8-c8b9-4850-863f-a20abfe7d189", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5387fc5f-5a61-42e9-a5a4-2fcd31d0ee87", "documentation": "Returns a single comment.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/comment/:id", "responses": [ { "uuid": "2a9395f0-5b17-4235-814b-d44799e789ff", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1d25e4fa-988d-43df-860f-851b16c414e8", "documentation": "Updates an existing comment using its JSON representation.", "method": "put", "endpoint": "api/2/issue/:issueIdOrKey/comment/:id", "responses": [ { "uuid": "471ecb71-164a-4dbc-a661-a31b3af37381", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a4aac08c-7901-4416-a548-ff61b668f6d3", "documentation": "Returns the meta data for editing an issue.\n

\n The fields in the editmeta correspond to the fields in the edit screen for the issue.\n Fields not in the screen will not be in the editmeta.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/editmeta", "responses": [ { "uuid": "0627c3c3-0648-4cee-90d3-026d83b2d464", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e70c6d18-f50c-4778-aca5-8518b541e7db", "documentation": "Sends a notification (email) to the list or recipients defined in the request.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/notify", "responses": [ { "uuid": "5083b4fd-6145-4b9f-8d83-2bac85920381", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fc768ef4-db50-427b-b98e-acccf8590e5d", "documentation": "Returns the keys of all properties for the issue identified by the key or by the id.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/properties", "responses": [ { "uuid": "ce45c2c3-266c-4944-8e52-5994ce1df609", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "212ead43-ad72-450a-9c96-b4029c738891", "documentation": "Removes the property from the issue identified by the key or by the id. Ths user removing the property is required\n to have permissions to edit the issue.", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/properties/:propertyKey", "responses": [ { "uuid": "82ab6f5b-5dfc-439f-ba05-76db294e442c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bd18122d-cd8e-4976-81f4-4ebd0b6afbd7", "documentation": "Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves\n the property is required to have permissions to read the issue.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/properties/:propertyKey", "responses": [ { "uuid": "e6b8ed10-6c2c-4b69-9d61-c4382c3e181f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "23f79a51-c52f-44d1-a04f-61db94cafaa3", "documentation": "Sets the value of the specified issue's property.\n

\n You can use this resource to store a custom data against the issue identified by the key or by the id. The user\n who stores the data is required to have permissions to edit the issue.\n

", "method": "put", "endpoint": "api/2/issue/:issueIdOrKey/properties/:propertyKey", "responses": [ { "uuid": "ed2c6b51-7986-4ee9-a827-e996ae4c3923", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "184625d7-3033-4dee-a089-c9979673de7a", "documentation": "Delete the remote issue link with the given global id on the issue.", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/remotelink", "responses": [ { "uuid": "bf709c23-9b23-42fd-839d-eb3b03762ba6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "22a2da89-3b4f-4a2e-8471-314e21fbbcbd", "documentation": "A REST sub-resource representing the remote issue links on the issue.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/remotelink", "responses": [ { "uuid": "3c9c9dc3-bd2a-4fe2-ac21-1020ba2035f3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ebee0dfc-0db3-4e8a-9ee0-3058655eb2d1", "documentation": "Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link\n exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/remotelink", "responses": [ { "uuid": "d8449cb9-6bf3-4396-9af3-e21c81c01a6d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "21d37a96-d9b5-44c6-8e1e-aea49f8b1954", "documentation": "Delete the remote issue link with the given id on the issue.", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/remotelink/:linkId", "responses": [ { "uuid": "98d84d87-85cb-4adf-b370-1e7c775b53f5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7f91e317-dfc5-4a29-8357-854c24c0a8b9", "documentation": "Get the remote issue link with the given id on the issue.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/remotelink/:linkId", "responses": [ { "uuid": "591d7505-4969-4c3b-84e4-deccde698f78", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6036c6a1-b6e7-48da-8d6f-1021f8c6375c", "documentation": "Updates a remote issue link from a JSON representation. Any fields not provided are set to null.", "method": "put", "endpoint": "api/2/issue/:issueIdOrKey/remotelink/:linkId", "responses": [ { "uuid": "30b1a0a3-767b-4149-ac62-ce45a018cec5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b07d7ebc-984b-4fe7-9d20-b6dd137382b1", "documentation": "Returns an issue's subtask list", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/subtask", "responses": [ { "uuid": "d2b34b68-15bb-44f5-8e76-01e87d311775", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "36d48be5-c1ce-4222-8881-61a97b245dc1", "documentation": "", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/subtask/move", "responses": [ { "uuid": "96c3b48d-d843-4ce8-a552-6786e8a33128", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bb6460d2-10df-404e-9f24-5acaaa3ba1b7", "documentation": "Reorders an issue's subtasks by moving the subtask at index \"from\"\n to index \"to\".", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/subtask/move", "responses": [ { "uuid": "a5e64f54-9232-49ee-be73-1236f63f2d3c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7c64b4f5-a58f-408d-a6bd-9c6a502a6b7a", "documentation": "Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.\n

\n Fields will only be returned if expand=transitions.fields.\n

\n The fields in the metadata correspond to the fields in the transition screen for that transition.\n Fields not in the screen will not be in the metadata.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/transitions", "responses": [ { "uuid": "20c4f642-ef29-475c-999a-008cadc63d18", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "92f92e9f-7827-48a4-8c98-2ae761ed9d14", "documentation": "Perform a transition on an issue.\n When performing the transition you can update or set other issue fields.\n

\n The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined\n using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource.\n If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field\n validation error will occur if it is submitted.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/transitions", "responses": [ { "uuid": "1dd90e98-bdf8-47ad-97ed-28a0a64460fa", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "441590d9-32ad-4f54-82cd-c4b2fbd04311", "documentation": "Remove your vote from an issue. (i.e. \"unvote\")", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/votes", "responses": [ { "uuid": "5ae677f1-ce34-4881-a561-c54224bb0153", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e66c381c-4577-4e4a-820a-98d7d354db27", "documentation": "A REST sub-resource representing the voters on the issue.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/votes", "responses": [ { "uuid": "bf034cde-72a7-4dfd-ab03-9d393f673c02", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ccd03f46-ba79-45c7-8368-4f28cfb718fe", "documentation": "Cast your vote in favour of an issue.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/votes", "responses": [ { "uuid": "8a664baf-aa32-4afa-b57f-b032b23d1fd4", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "20e72e12-408d-40c8-904d-d49ae8b7dad9", "documentation": "Removes a user from an issue's watcher list.", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/watchers", "responses": [ { "uuid": "e9d8b66c-2255-41d2-bd0c-18d273f5bb58", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4d27d1fb-09a5-4fcc-9394-6c080bc10b51", "documentation": "Returns the list of watchers for the issue with the given key.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/watchers", "responses": [ { "uuid": "d671d4ac-10f0-4119-9925-ac4b010df9e1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "233b4691-2b5d-413e-b0b6-1e3cbb871ea8", "documentation": "Adds a user to an issue's watcher list.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/watchers", "responses": [ { "uuid": "7cbe71cd-8a87-41b1-bca5-ef33c52ffde8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0a6803c9-4cfd-4e9b-b2fd-8ece450b99f2", "documentation": "Returns all work logs for an issue.
\n Note: Work logs won't be returned if the Log work field is hidden for the project.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/worklog", "responses": [ { "uuid": "3e26d267-65e1-4a8f-b01c-e2686bd2960e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4f29f239-de01-4b55-bc0c-a076cb3c38fa", "documentation": "Adds a new worklog entry to an issue.", "method": "post", "endpoint": "api/2/issue/:issueIdOrKey/worklog", "responses": [ { "uuid": "b9784ade-ee3c-4300-8682-5d4e3b3edbf6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7e51c1b9-8f6d-45cb-9225-7cdde3f84682", "documentation": "Deletes an existing worklog entry.", "method": "delete", "endpoint": "api/2/issue/:issueIdOrKey/worklog/:id", "responses": [ { "uuid": "409fd26b-5cb4-4ed0-a69c-eed869266f3f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0ae1a230-0b12-44d9-804d-6b094d74a8ee", "documentation": "Returns a specific worklog.
\n Note: The work log won't be returned if the Log work field is hidden for the project.", "method": "get", "endpoint": "api/2/issue/:issueIdOrKey/worklog/:id", "responses": [ { "uuid": "7dfb998f-e0e6-4c30-94a6-06c04b946196", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8a6c3061-b607-4df5-b36d-2a2b62769672", "documentation": "Updates an existing worklog entry.\n

Note that:

\n ", "method": "put", "endpoint": "api/2/issue/:issueIdOrKey/worklog/:id", "responses": [ { "uuid": "375fead4-3643-4550-ad0e-72583ba51201", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7cfef197-3f78-4246-983c-98a0a9da3842", "documentation": "Creates an issue link between two issues.\n The user requires the link issue permission for the issue which will be linked to another issue.\n The specified link type in the request is used to create the link and will create a link from the first issue\n to the second issue using the outward description. It also create a link from the second issue to the first issue using the\n inward description of the issue link type.\n It will add the supplied comment to the first issue. The comment can have a restriction who can view it.\n If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment.\n The user who creates the issue link needs to belong to the specified group or have the specified role.", "method": "post", "endpoint": "api/2/issueLink", "responses": [ { "uuid": "f1010b83-6493-4b90-a70d-f633c1eff012", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6eea7929-1ad4-4b08-83da-aec6d8025d99", "documentation": "Deletes an issue link with the specified id.\n To be able to delete an issue link you must be able to view both issues and must have the link issue permission\n for at least one of the issues.", "method": "delete", "endpoint": "api/2/issueLink/:linkId", "responses": [ { "uuid": "15414913-77c9-4849-934a-6a7f12f15853", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d41a69e9-1249-47cd-8952-d39c3f9bc12c", "documentation": "Returns an issue link with the specified id.", "method": "get", "endpoint": "api/2/issueLink/:linkId", "responses": [ { "uuid": "7fa38702-2d62-4523-b96d-97e4adebd157", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4a4605bf-3efb-4344-8250-e19d71e6c889", "documentation": "Returns a list of available issue link types, if issue linking is enabled.\n Each issue link type has an id, a name and a label for the outward and inward link relationship.", "method": "get", "endpoint": "api/2/issueLinkType", "responses": [ { "uuid": "c724dee2-dd00-4e03-a52c-b71471e05d09", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "40ba1a4d-dd43-4de9-b97e-ed7fbf1d37fc", "documentation": "Create a new issue link type.", "method": "post", "endpoint": "api/2/issueLinkType", "responses": [ { "uuid": "e8d6b794-58aa-45d1-aa29-7042cf58f90a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7c322092-92a4-4455-afcc-777f912394f9", "documentation": "Delete the specified issue link type.", "method": "delete", "endpoint": "api/2/issueLinkType/:issueLinkTypeId", "responses": [ { "uuid": "2f6b1dc4-2504-498c-9b02-a99d2d51ef68", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4dd4224a-8a84-4663-97ff-e53ed1da2d56", "documentation": "Returns for a given issue link type id all information about this issue link type.", "method": "get", "endpoint": "api/2/issueLinkType/:issueLinkTypeId", "responses": [ { "uuid": "530c4585-04a6-4b84-8a8d-68044ffdc6a9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cfd82646-274b-4390-bbb5-0d3df755bfc1", "documentation": "Update the specified issue link type.", "method": "put", "endpoint": "api/2/issueLinkType/:issueLinkTypeId", "responses": [ { "uuid": "94993ca3-f23f-4575-9f22-58281456e5e0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "53ae6daf-3eb7-4a62-897c-f0e57ee18637", "documentation": "Returns all issue security schemes that are defined.", "method": "get", "endpoint": "api/2/issuesecurityschemes", "responses": [ { "uuid": "3257901f-c3b5-4d06-a30f-ded17cde2896", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "21ec821e-9e39-4285-9ae3-2b305d08b6c0", "documentation": "Returns the issue security scheme along with that are defined.", "method": "get", "endpoint": "api/2/issuesecurityschemes/:id", "responses": [ { "uuid": "2ec5fa85-9bf7-4499-a658-de1f225b583c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f1f7d590-d76d-4485-9950-0430107b8f02", "documentation": "Returns a list of all issue types visible to the user", "method": "get", "endpoint": "api/2/issuetype", "responses": [ { "uuid": "6a3ecf92-bf92-4e2a-b022-7c948ec294d3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "17e10b43-79f0-4b34-b676-1d6783caf741", "documentation": "Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue\n type scheme.", "method": "post", "endpoint": "api/2/issuetype", "responses": [ { "uuid": "ff969631-b955-4f6e-a7ab-b8720e0e3784", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a3b43155-9dbe-4713-b66a-9141492c0a56", "documentation": "Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to\n the alternative issue type specified in the parameter. You can determine the alternative issue types by calling\n the /rest/api/2/issuetype/{id}/alternatives resource.", "method": "delete", "endpoint": "api/2/issuetype/:id", "responses": [ { "uuid": "1aab7e62-af81-45a3-9265-4513afb0c163", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "73ca4445-01a2-4373-8c5f-229c4fb4dd4c", "documentation": "Returns a full representation of the issue type that has the given id.", "method": "get", "endpoint": "api/2/issuetype/:id", "responses": [ { "uuid": "cbd289b6-a385-4dce-bed1-265d6806500a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "df2f4c71-fdee-428f-ad8e-238d5311e928", "documentation": "Updates the specified issue type from a JSON representation.", "method": "put", "endpoint": "api/2/issuetype/:id", "responses": [ { "uuid": "4cf71108-9d2c-42ab-aeb4-2f92d7d98b76", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "99fab873-8960-4819-b150-e43e8fd01add", "documentation": "Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which\n issues assigned to the given issue type can be migrated. The suitable alternatives are issue types which are assigned\n to the same workflow, the same field configuration and the same screen scheme.", "method": "get", "endpoint": "api/2/issuetype/:id/alternatives", "responses": [ { "uuid": "9616662c-b47d-4c6a-9d31-b56506c67f0b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1f8e56ab-4706-4679-bab5-2d1cdab4a5f0", "documentation": "Converts temporary avatar into a real avatar", "method": "post", "endpoint": "api/2/issuetype/:id/avatar", "responses": [ { "uuid": "6de81de3-7e99-46b5-8cf1-fe65aa21150c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ba3907bc-45b3-4f80-b56d-6be3e25de1fc", "documentation": "Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because\n the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from\n which the client parses the JSON from.\n

\n Creating a temporary avatar is part of a 3-step process in uploading a new\n avatar for an issue type: upload, crop, confirm. This endpoint allows you to use a multipart upload\n instead of sending the image directly as the request body.\n

\n

\n You *must* use \"avatar\" as the name of the upload parameter:

\n

\n 

\n curl -c cookiejar.txt -X POST -u admin:admin -H \"X-Atlassian-Token: no-check\" \\\n   -F \"avatar=@mynewavatar.png;type=image/png\" \\\n   'http://localhost:8090/jira/rest/api/2/issuetype/1/avatar/temporary'\n
", "method": "post", "endpoint": "api/2/issuetype/:id/avatar/temporary", "responses": [ { "uuid": "c32d38ae-a3cf-475a-a155-bd8c9d7943c9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "144c9eab-9c1b-438a-b82b-e7a2cc87db6e", "documentation": "Returns the keys of all properties for the issue type identified by the id.", "method": "get", "endpoint": "api/2/issuetype/:issueTypeId/properties", "responses": [ { "uuid": "391c2e7a-f287-4b23-85ee-53027d4ab936", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "901c7053-c1fc-49e9-9bcc-2c21887c96c3", "documentation": "Removes the property from the issue type identified by the id. Ths user removing the property is required\n to have permissions to edit the issue type.", "method": "delete", "endpoint": "api/2/issuetype/:issueTypeId/properties/:propertyKey", "responses": [ { "uuid": "4648b800-04e5-474c-ac39-1bb15df39fcd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5c48c644-40dd-42ce-b3d5-a6e74c1af5cd", "documentation": "Returns the value of the property with a given key from the issue type identified by the id. The user who retrieves\n the property is required to have permissions to view the issue type.", "method": "get", "endpoint": "api/2/issuetype/:issueTypeId/properties/:propertyKey", "responses": [ { "uuid": "1d8f556b-b89e-49f4-b2df-22fb790389f0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "208177ce-29ff-420a-8bb6-3b18783acb93", "documentation": "Sets the value of the specified issue type's property.\n

\n You can use this resource to store a custom data against an issue type identified by the id. The user\n who stores the data is required to have permissions to edit an issue type.\n

", "method": "put", "endpoint": "api/2/issuetype/:issueTypeId/properties/:propertyKey", "responses": [ { "uuid": "f3f73cea-180e-4ee9-8b23-c0d1cfef1366", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5ec7a003-82cf-4062-b16c-c020bdcd2cfa", "documentation": "Returns the auto complete data required for JQL searches.", "method": "get", "endpoint": "api/2/jql/autocompletedata", "responses": [ { "uuid": "6f63a7d2-3f55-4dfa-9514-073a0994a86b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1e20f7eb-6b18-485e-9b15-5aaf0445d891", "documentation": "Returns auto complete suggestions for JQL search.", "method": "get", "endpoint": "api/2/jql/autocompletedata/suggestions", "responses": [ { "uuid": "556c8cf8-8ebe-45fa-975e-a05d68921522", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "725100ba-c193-499b-af25-aea46e6b8297", "documentation": "", "method": "post", "endpoint": "api/2/licenseValidator", "responses": [ { "uuid": "c5642a40-5c2f-45ee-a53d-587e302ffd7f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4cfbf290-4e2c-47af-86f1-2569b6f32a75", "documentation": "", "method": "get", "endpoint": "api/2/monitoring/jmx/areMetricsExposed", "responses": [ { "uuid": "1659f449-e2ee-48ae-9a39-73d9d80e7696", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d6f830d0-7a7a-4968-8646-abb007b79fe4", "documentation": "", "method": "get", "endpoint": "api/2/monitoring/jmx/getAvailableMetrics", "responses": [ { "uuid": "8a470e05-888a-4e60-8519-c8a58ba32d0c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0921e517-2899-4914-948b-009342b22b15", "documentation": "", "method": "get", "endpoint": "api/2/monitoring/jmx/startExposing", "responses": [ { "uuid": "d2fa17aa-18b5-4c7e-bac3-04711a690e6b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ea010efb-0592-490f-a469-f8fb427b9758", "documentation": "", "method": "get", "endpoint": "api/2/monitoring/jmx/stopExposing", "responses": [ { "uuid": "a23fb405-7b90-4767-851e-345f0d9e685a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5401268e-8855-4c81-aa1f-88d07c76c138", "documentation": "Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for\n (projectKey OR projectId OR issueKey OR issueId)\n \n

\n NB: The above means that for issue-level permissions (EDIT_ISSUE for example), hasPermission may be true when no context is provided, or when a project context is provided,\n but may be false for any given (or all) issues. This would occur (for example) if Reporters were given the EDIT_ISSUE permission. This is because\n any user could be a reporter, except in the context of a concrete issue, where the reporter is known.\n

\n

\n Global permissions will still be returned for all scopes.\n

\n

\n Prior to version 6.4 this service returned project permissions with keys corresponding to com.atlassian.jira.security.Permissions.Permission constants.\n Since 6.4 those keys are considered deprecated and this service returns system project permission keys corresponding to constants defined in com.atlassian.jira.permission.ProjectPermissions.\n Permissions with legacy keys are still also returned for backwards compatibility, they are marked with an attribute deprecatedKey=true.\n The attribute is missing for project permissions with the current keys.\n

", "method": "get", "endpoint": "api/2/mypermissions", "responses": [ { "uuid": "64efe98f-b822-4895-b6bc-6826362e9e3b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7e9d9bdf-e44a-4a52-b267-56c15aade430", "documentation": "Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If\n key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.", "method": "delete", "endpoint": "api/2/mypreferences", "responses": [ { "uuid": "852e3828-76da-4402-8725-532574328f87", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d53c53bf-1c3d-46ad-9d3c-625c6467a897", "documentation": "Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The\n value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. If value is\n found - status code 200.", "method": "get", "endpoint": "api/2/mypreferences", "responses": [ { "uuid": "7d51953f-4c29-4245-a755-5b8b261046c0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b0bbd282-6131-431a-adcc-b702226f7d6a", "documentation": "Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value\n must be provided as post body. If key or value parameter is not provided - status code 404. If preference is set\n - status code 204.", "method": "put", "endpoint": "api/2/mypreferences", "responses": [ { "uuid": "15d960bd-61b7-447e-bac8-b9976ffc53b1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e8c469a4-7f8e-494a-8940-a99d087d0482", "documentation": "Returns currently logged user. This resource cannot be accessed anonymously.", "method": "get", "endpoint": "api/2/myself", "responses": [ { "uuid": "34d834f7-a0ba-4d5d-a351-320062aaf43a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "93e6d4a5-123c-4196-a194-82f021f42504", "documentation": "Modify currently logged user. The \"value\" fields present will override the existing value.\n Fields skipped in request will not be changed. Only email and display name can be change that way.\n Requires user password.", "method": "put", "endpoint": "api/2/myself", "responses": [ { "uuid": "c8c21fde-d90e-4c00-9305-1442f7502e95", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c804682f-f277-415a-b66b-cff1173541c0", "documentation": "Modify caller password.", "method": "put", "endpoint": "api/2/myself/password", "responses": [ { "uuid": "cd619948-30b9-4565-86d7-55779aa619ef", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5e46607b-769d-4917-bdd6-7874f910ae10", "documentation": "Returns a paginated list of notification schemes. In order to access notification scheme, the calling user is\n required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains\n a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response.\n The list is ordered by the scheme's name.\n Follow the documentation of /notificationscheme/{id} resource for all details about returned value.", "method": "get", "endpoint": "api/2/notificationscheme", "responses": [ { "uuid": "23b366b1-a56a-449a-9710-0997f93855c5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9c5d1370-f599-454a-97de-8a91760019f7", "documentation": "Returns a full representation of the notification scheme for the given id. This resource will return a\n notification scheme containing a list of events and recipient configured to receive notifications for these events. Consumer\n should allow events without recipients to appear in response. User accessing\n the data is required to have permissions to administer at least one project associated with the requested notification scheme.\n

\n Notification recipients can be:\n

\n Please see the example for reference.\n

\n The events can be JIRA system events or events configured by administrator. In case of the system events, data about theirs\n ids, names and descriptions is provided. In case of custom events, the template event is included as well.", "method": "get", "endpoint": "api/2/notificationscheme/:id", "responses": [ { "uuid": "b1d5354e-9859-4d15-8ad2-d83196ef6aa9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a8b45780-24d2-4ff9-9826-e11558dafef6", "documentation": "Returns the list of requirements for the current password policy. For example, \"The password must have at least 10 characters.\",\n \"The password must not be similar to the user's name or email address.\", etc.", "method": "get", "endpoint": "api/2/password/policy", "responses": [ { "uuid": "7743a243-dec6-4d62-a328-5e715a5fd281", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "625aa7eb-864f-446e-91fb-324b4dbaac77", "documentation": "Returns a list of statements explaining why the password policy would disallow a proposed password for a new user.\n

\n You can use this method to test the password policy validation. This could be done prior to an action \n where a new user and related password are created, using methods like the ones in \n UserService. \n For example, you could use this to validate a password in a create user form in the user interface, as the user enters it.
\n The username and new password must be not empty to perform the validation.
\n Note, this method will help you validate against the policy only. It won't check any other validations that might be performed \n when creating a new user, e.g. checking whether a user with the same name already exists.\n

", "method": "post", "endpoint": "api/2/password/policy/createUser", "responses": [ { "uuid": "5855501f-0c16-4c71-964c-7d2db736703f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ae5e7732-4789-4f9e-817c-969cee753cd7", "documentation": "Returns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password.\n

\n You can use this method to test the password policy validation. This could be done prior to an action where the password \n is actually updated, using methods like ChangePassword \n or ResetPassword. \n For example, you could use this to validate a password in a change password form in the user interface, as the user enters it.
\n The user must exist and the username and new password must be not empty, to perform the validation.
\n Note, this method will help you validate against the policy only. It won't check any other validations that might be performed \n when submitting a password change/reset request, e.g. verifying whether the old password is valid.\n

", "method": "post", "endpoint": "api/2/password/policy/updateUser", "responses": [ { "uuid": "e8822717-83e6-4479-9fb7-699c727d67fd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3cd29ace-4489-4d67-a73c-3e9690977768", "documentation": "Returns all permissions that are present in the JIRA instance - Global, Project and the global ones added by plugins", "method": "get", "endpoint": "api/2/permissions", "responses": [ { "uuid": "2f6d791b-3b76-4437-8ea5-00d88b84d5ab", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5dbbf2f7-6e82-42ad-aecd-61bd912c33e0", "documentation": "Returns a list of all permission schemes.\n

\n By default only shortened beans are returned. If you want to include permissions of all the schemes,\n then specify the permissions expand parameter. Permissions will be included also if you specify\n any other expand parameter.\n

", "method": "get", "endpoint": "api/2/permissionscheme", "responses": [ { "uuid": "c006d198-cef6-4f47-94ee-f4eb548f45b8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fe9dd8af-46e6-4298-a27a-b81448a132e5", "documentation": "Create a new permission scheme.\n This method can create schemes with a defined permission set, or without.", "method": "post", "endpoint": "api/2/permissionscheme", "responses": [ { "uuid": "5554037a-5b8c-4932-88ac-1c83d06ee820", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9cdeefa5-8ab2-4c6d-b7c6-367d2703bbe1", "documentation": "", "method": "get", "endpoint": "api/2/permissionscheme/:permissionSchemeId/attribute/:attributeKey", "responses": [ { "uuid": "13982308-b4e7-416e-b290-78ee3a227800", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "112273d7-24e3-4dea-ae5e-31bcad864cbc", "documentation": "Updates or inserts the attribute for a permission scheme specified by permission scheme id.\n The attribute consists of the key and the value. The value will be converted to Boolean using Boolean#valueOf.", "method": "put", "endpoint": "api/2/permissionscheme/:permissionSchemeId/attribute/:key", "responses": [ { "uuid": "0c75bf55-8e45-42fc-8187-f38116093459", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "833ac641-d3b2-4174-9f4b-83dc6df39f85", "documentation": "Deletes a permission scheme identified by the given id.", "method": "delete", "endpoint": "api/2/permissionscheme/:schemeId", "responses": [ { "uuid": "f5b7b2cb-c7da-4017-bd94-ac000f003d83", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "55ac1d53-8008-4abd-9c42-b0be2f03c43d", "documentation": "Returns a permission scheme identified by the given id.", "method": "get", "endpoint": "api/2/permissionscheme/:schemeId", "responses": [ { "uuid": "9912f9aa-afcb-4e4c-bd33-747f9952df96", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2c4a4de3-4c51-4eec-9470-8aced265bda1", "documentation": "Updates a permission scheme.\n

\n If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that\n existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme.\n

\n

\n To update just the name and description, do not send permissions list at all.\n

\n

\n To add or remove a single permission grant instead of updating the whole list at once use the {schemeId}/permission/ resource.\n

", "method": "put", "endpoint": "api/2/permissionscheme/:schemeId", "responses": [ { "uuid": "622ef418-1ae2-4d30-8bb5-320c1a032cb5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5d5df6f5-df52-4407-8b5a-37309c0b5069", "documentation": "Returns all permission grants of the given permission scheme.", "method": "get", "endpoint": "api/2/permissionscheme/:schemeId/permission", "responses": [ { "uuid": "10471d86-0701-49f0-96eb-ac2609467cb7", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6290cc15-6606-43ef-bea5-af6d2aafb185", "documentation": "Creates a permission grant in a permission scheme.", "method": "post", "endpoint": "api/2/permissionscheme/:schemeId/permission", "responses": [ { "uuid": "f8e38d0d-6b56-4375-bdcd-b001121984f2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fc1bed1d-e060-49e0-81b8-2d3008cc1b15", "documentation": "Deletes a permission grant from a permission scheme.", "method": "delete", "endpoint": "api/2/permissionscheme/:schemeId/permission/:permissionId", "responses": [ { "uuid": "c56ccc40-6e27-4309-87f6-74b8410a245b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ca10ce3c-7f02-4ad9-a6b4-ce33baf6ab75", "documentation": "Returns a permission grant identified by the given id.", "method": "get", "endpoint": "api/2/permissionscheme/:schemeId/permission/:permissionId", "responses": [ { "uuid": "46e1256b-45da-4087-9fce-d1ef6db58d5d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "57857517-b663-4dac-900b-78f234870e33", "documentation": "Returns a list of all issue priorities.", "method": "get", "endpoint": "api/2/priority", "responses": [ { "uuid": "cf50f669-fd7e-42db-8dd0-9b43a273eba9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8d0bf701-01a3-46ff-b8f1-c7060c0e8316", "documentation": "Returns an issue priority.", "method": "get", "endpoint": "api/2/priority/:id", "responses": [ { "uuid": "e68652e3-cf17-49e1-8e89-5d18fce14a96", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "036b64e9-ed4e-45a9-8d36-394749007489", "documentation": "Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the\n list of projects that are visible when using anonymous access.", "method": "get", "endpoint": "api/2/project", "responses": [ { "uuid": "d27a70ce-227d-4cf7-88c9-249d3649d224", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9515faf9-bd21-40f4-8bc7-af6bb267c6e7", "documentation": "Creates a new project.", "method": "post", "endpoint": "api/2/project", "responses": [ { "uuid": "003e18ea-bda2-4af4-bdd8-e6461ea1ad79", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "417f333c-b98e-4160-94b1-14b9964fd60d", "documentation": "Returns all the project types defined on the JIRA instance, not taking into account whether\n the license to use those project types is valid or not.", "method": "get", "endpoint": "api/2/project/type", "responses": [ { "uuid": "22a571e8-599e-469d-974e-a1f347efacaf", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f83cb1ae-6e50-4a71-8caa-59096d4c1873", "documentation": "Returns the project type with the given key.", "method": "get", "endpoint": "api/2/project/type/:projectTypeKey", "responses": [ { "uuid": "ce8462e6-c83f-4bf4-b244-fcaed0b06aa0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6a1be5e0-d823-4fbc-ac8d-95fa54c79dec", "documentation": "Returns the project type with the given key, if it is accessible to the logged in user.\n This takes into account whether the user is licensed on the Application that defines the project type.", "method": "get", "endpoint": "api/2/project/type/:projectTypeKey/accessible", "responses": [ { "uuid": "9263849f-b436-4c87-9123-975e3702fe1d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b154217b-7e8f-4d53-a5c9-02a6105f01be", "documentation": "Deletes a project.", "method": "delete", "endpoint": "api/2/project/:projectIdOrKey", "responses": [ { "uuid": "b127208a-46f0-4499-8363-ad7fe70de913", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "60ffa0c0-b1ec-45d0-8304-21fb47b45921", "documentation": "Contains a full representation of a project in JSON format.\n

\n All project keys associated with the project will only be returned if expand=projectKeys.\n

", "method": "get", "endpoint": "api/2/project/:projectIdOrKey", "responses": [ { "uuid": "457aa8ee-fdd4-473c-be9b-5ef03afae979", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "473ad1c5-e7f3-4cb2-bd8e-7dd1046e65ba", "documentation": "Updates a project.\n

\n Only non null values sent in JSON will be updated in the project.

\n

\n Values available for the assigneeType field are: \"PROJECT_LEAD\" and \"UNASSIGNED\".

", "method": "put", "endpoint": "api/2/project/:projectIdOrKey", "responses": [ { "uuid": "8e9c74d8-e160-4da7-8aa3-5fe8bc884bed", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9670ccad-96c6-4774-83c0-a19985a2cac8", "documentation": "Converts temporary avatar into a real avatar", "method": "post", "endpoint": "api/2/project/:projectIdOrKey/avatar", "responses": [ { "uuid": "b2cc6229-f1ef-45bc-b44e-d8846f855a77", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c6e6451c-e6ab-4338-969f-bc0dc1349bab", "documentation": "", "method": "put", "endpoint": "api/2/project/:projectIdOrKey/avatar", "responses": [ { "uuid": "ce5ec681-a683-44df-8712-a997dfeab2f5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b6594759-3cbd-486e-b251-54a2f2383fec", "documentation": "Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because\n the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from\n which the client parses the JSON.", "method": "post", "endpoint": "api/2/project/:projectIdOrKey/avatar/temporary", "responses": [ { "uuid": "6ea3559d-869e-4c31-bad6-5c53fafd1838", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "80de69e1-14cb-4046-b9e7-633aa02db98e", "documentation": "Deletes avatar", "method": "delete", "endpoint": "api/2/project/:projectIdOrKey/avatar/:id", "responses": [ { "uuid": "5a92977e-8f00-4945-9842-a11839c6161d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cbe0d64d-5006-41db-9d7d-917bb7b1b34f", "documentation": "Returns all avatars which are visible for the currently logged in user. The avatars are grouped into\n system and custom.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/avatars", "responses": [ { "uuid": "6d1a7fe6-9a9a-4aab-88ca-8bdc8cc4c3ef", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d4359a57-81b7-444c-b982-90e63cd50521", "documentation": "Contains a full representation of a the specified project's components.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/components", "responses": [ { "uuid": "51e8c3a0-f5aa-4fdc-9621-e43fbe3d5914", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "77f7b262-f9e9-4636-9254-1e186e8b0499", "documentation": "Returns the keys of all properties for the project identified by the key or by the id.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/properties", "responses": [ { "uuid": "7c24513d-b835-47a3-acb5-f54c0947e974", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d808b8eb-c4f5-4aa3-aa9e-d6585babf6be", "documentation": "Removes the property from the project identified by the key or by the id. Ths user removing the property is required\n to have permissions to administer the project.", "method": "delete", "endpoint": "api/2/project/:projectIdOrKey/properties/:propertyKey", "responses": [ { "uuid": "6a9a07ff-2a32-4908-b8b7-ab31967e2deb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7abd2189-9169-468f-aee4-a35af2ddb332", "documentation": "Returns the value of the property with a given key from the project identified by the key or by the id. The user who retrieves\n the property is required to have permissions to read the project.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/properties/:propertyKey", "responses": [ { "uuid": "d48df91a-f962-4e37-8b4c-0bafa8c022e5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "36a9d137-c238-4962-a4d4-0cc69ef46ee8", "documentation": "Sets the value of the specified project's property.\n

\n You can use this resource to store a custom data against the project identified by the key or by the id. The user\n who stores the data is required to have permissions to administer the project.\n

", "method": "put", "endpoint": "api/2/project/:projectIdOrKey/properties/:propertyKey", "responses": [ { "uuid": "4379e028-1a3f-4311-ac4a-0778ca82c29c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8ba548bd-d61f-4409-8238-94705eda884d", "documentation": "Returns all roles in the given project Id or key, with links to full details on each role.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/role", "responses": [ { "uuid": "20f74a7d-4de8-4dd9-956c-2f29ba8fbd24", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ddef373c-41da-4808-9d45-4fbdad90f666", "documentation": "Deletes actors (users or groups) from a project role.\n

\n

", "method": "delete", "endpoint": "api/2/project/:projectIdOrKey/role/:id", "responses": [ { "uuid": "7a575718-ec4c-4c4e-8326-fe2a525f1d22", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8a9b9391-2cab-4b3d-b575-236469ec1b74", "documentation": "Returns the details for a given project role in a project.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/role/:id", "responses": [ { "uuid": "7acaec79-9dcb-4449-86a7-a0935d409f61", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "81e28d8d-f092-44ea-8fb2-bd9f3254f143", "documentation": "Adds an actor (user or group) to a project role.", "method": "post", "endpoint": "api/2/project/:projectIdOrKey/role/:id", "responses": [ { "uuid": "951ae951-b7f5-4e11-88ab-ae517aae2893", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "31f9444c-2807-4f9a-9513-102d15f7f397", "documentation": "Updates a project role to include the specified actors (users or groups).", "method": "put", "endpoint": "api/2/project/:projectIdOrKey/role/:id", "responses": [ { "uuid": "c9c7955e-f276-4f02-afd4-ea2695e7e15c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "37be3152-5be8-4a34-9ce5-517438ca2b49", "documentation": "Get all issue types with valid status values for a project", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/statuses", "responses": [ { "uuid": "c36e5725-0cff-45b8-bd54-311a8e1438f3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4d1ef7ac-3951-4e21-bd59-6f66d01e64d0", "documentation": "Updates the type of a project.", "method": "put", "endpoint": "api/2/project/:projectIdOrKey/type/:newProjectTypeKey", "responses": [ { "uuid": "59f25ab7-98f3-49c1-9580-a3d62c62a2f4", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "66433c10-d83e-4451-befb-ff4845851644", "documentation": "Returns all versions for the specified project. Results are paginated.\n

\n Results can be ordered by the following fields:\n

\n

", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/version", "responses": [ { "uuid": "184d4818-a0c3-40cf-a5e1-073fe45e8f8b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0139f484-77d3-4711-9589-76b99edcbcb5", "documentation": "Contains a full representation of a the specified project's versions.", "method": "get", "endpoint": "api/2/project/:projectIdOrKey/versions", "responses": [ { "uuid": "fe8c9064-e3f8-4d40-bb0d-06a6a591b564", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fe878015-a4c3-4bdd-ba04-52317fa16d3a", "documentation": "Returns the issue security scheme for project.", "method": "get", "endpoint": "api/2/project/:projectKeyOrId/issuesecuritylevelscheme", "responses": [ { "uuid": "5aa5a3d7-2238-4e1b-95bf-494a3fd5cd07", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "59a8a14c-b299-47d4-b7e3-af8508c93ab0", "documentation": "Gets a notification scheme associated with the project.\n Follow the documentation of /notificationscheme/{id} resource for all details about returned value.", "method": "get", "endpoint": "api/2/project/:projectKeyOrId/notificationscheme", "responses": [ { "uuid": "cbdaeb7b-b92a-462f-8453-6bd11845c53c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f6dec138-2f3a-45e9-b0b0-e5aadb268d6d", "documentation": "Gets a permission scheme assigned with a project.", "method": "get", "endpoint": "api/2/project/:projectKeyOrId/permissionscheme", "responses": [ { "uuid": "c8a43555-8552-4ac8-b5e2-3de361cc9dca", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e64cfd89-16a2-4afd-993c-67b65da0ac15", "documentation": "Assigns a permission scheme with a project.", "method": "put", "endpoint": "api/2/project/:projectKeyOrId/permissionscheme", "responses": [ { "uuid": "9bd70050-eb06-458e-81ea-1215060fce6f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "feffd55c-7561-46b7-aced-722ffeb8d66e", "documentation": "Returns all security levels for the project that the current logged in user has access to.\n If the user does not have the Set Issue Security permission, the list will be empty.", "method": "get", "endpoint": "api/2/project/:projectKeyOrId/securitylevel", "responses": [ { "uuid": "3a1cb2aa-0fd1-4528-a78b-f32f795c54a5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "34f2e8a3-ac45-43ae-b7b9-1fa7f36b0e51", "documentation": "Returns all project categories", "method": "get", "endpoint": "api/2/projectCategory", "responses": [ { "uuid": "a3173ee1-d510-4a75-9ab6-58c95a51b8f6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2b90c59e-c78b-4130-b6df-3ace249523b1", "documentation": "Create a project category via POST.", "method": "post", "endpoint": "api/2/projectCategory", "responses": [ { "uuid": "65871a61-c2bb-4c2a-90f0-64d06f15b429", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "804e93fa-1838-4651-8da9-e10a8218ea5d", "documentation": "Delete a project category.", "method": "delete", "endpoint": "api/2/projectCategory/:id", "responses": [ { "uuid": "1576a664-8610-46f0-bdab-285c7f132f2a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6fbd15ed-9066-4434-be76-4074e7a88c5f", "documentation": "Contains a representation of a project category in JSON format.", "method": "get", "endpoint": "api/2/projectCategory/:id", "responses": [ { "uuid": "84133b64-9616-4eef-a486-e7ee2de3dd21", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "db877a90-4890-4a68-939b-47da4506c5eb", "documentation": "Modify a project category via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field\n is not present, it is silently ignored.", "method": "put", "endpoint": "api/2/projectCategory/:id", "responses": [ { "uuid": "4b7a9b45-7f41-4057-99c9-c5f069684cd7", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "66f49aeb-6c7a-4cb7-8ab1-b078021d2181", "documentation": "Validates a project key.", "method": "get", "endpoint": "api/2/projectvalidate/key", "responses": [ { "uuid": "8ddfb4b3-0884-46c5-8b22-be0db330098b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f5fcfe1b-605b-4487-aaa4-4be95997f27c", "documentation": "Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.\n If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404\n indicating that no reindex has taken place.", "method": "get", "endpoint": "api/2/reindex", "responses": [ { "uuid": "5ab70fe5-c1ce-480f-8f75-e293f20dfe8a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ebdac081-7360-4fa9-861d-8f16f6460a7b", "documentation": "Kicks off a reindex. Need Admin permissions to perform this reindex.", "method": "post", "endpoint": "api/2/reindex", "responses": [ { "uuid": "3412d0b5-7a88-44e1-a59a-d9e2ab07b511", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ff862273-f1ac-4474-9a56-a872b5a38c22", "documentation": "Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of\n the issues has completed or a failure occurs.\n

\n Use either explicitly specified issue IDs or a JQL query to select issues to reindex.", "method": "post", "endpoint": "api/2/reindex/issue", "responses": [ { "uuid": "7beec81c-4a31-4332-ba97-8e186b0e8dc8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c7af40aa-4b99-4eda-9204-96d512fadbf1", "documentation": "Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.\n If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404\n indicating that no reindex has taken place.", "method": "get", "endpoint": "api/2/reindex/progress", "responses": [ { "uuid": "c04af2cd-2786-4bd6-abed-59986e7cdbff", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0a2ce3e9-7671-4cdc-bef8-e8aba95d43d7", "documentation": "Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests\n that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through\n other REST calls.", "method": "post", "endpoint": "api/2/reindex/request", "responses": [ { "uuid": "023cec4e-e4f6-4ba4-91f7-5815484443ec", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "88e3955c-1557-4c5d-8554-1ba9ab7e46e3", "documentation": "Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned\n in the results.", "method": "get", "endpoint": "api/2/reindex/request/bulk", "responses": [ { "uuid": "556b39ed-b074-436f-81cf-04500aa6298a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "11581516-257b-4a3e-9910-b7e7411f6628", "documentation": "Retrieves the progress of a single reindex request.", "method": "get", "endpoint": "api/2/reindex/request/:requestId", "responses": [ { "uuid": "1486db23-dc38-42ee-8f80-2bd1273f1d13", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9683b745-facd-4e3b-ae0d-46a697afe743", "documentation": "Returns a list of all resolutions.", "method": "get", "endpoint": "api/2/resolution", "responses": [ { "uuid": "9b25aa7f-4790-451d-9c86-4908737cccae", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2cf12d82-6365-4564-93b0-29c6fe34e953", "documentation": "Returns a resolution.", "method": "get", "endpoint": "api/2/resolution/:id", "responses": [ { "uuid": "d6c3c230-e5f5-4dcf-b951-94062f5e40fd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6e9b3915-7565-4784-a92c-ac06186de7d4", "documentation": "Get all the ProjectRoles available in JIRA. Currently this list is global.", "method": "get", "endpoint": "api/2/role", "responses": [ { "uuid": "89a12a3b-f61c-4507-8375-8279a217bedc", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8b80b7e7-90c1-4ad0-a899-76d4f240233d", "documentation": "Creates a new ProjectRole to be available in JIRA.\n The created role does not have any default actors assigned.", "method": "post", "endpoint": "api/2/role", "responses": [ { "uuid": "cd82fb1b-2f81-4b3e-860f-9e59c55b08c8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1bcf71b9-52b4-474d-86b6-6ccbd29f7384", "documentation": "Deletes a role. May return 403 in the future", "method": "delete", "endpoint": "api/2/role/:id", "responses": [ { "uuid": "ab5de0ab-8169-4104-a076-0f83543fea90", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "be4819dd-9c48-44a8-b477-e54b56382e0a", "documentation": "Get a specific ProjectRole available in JIRA.", "method": "get", "endpoint": "api/2/role/:id", "responses": [ { "uuid": "c78d4654-87ab-49ce-9821-a8fd8a15bf08", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a616cfd0-e286-4c97-bf01-1805182f4cdd", "documentation": "Partially updates a roles name or description.", "method": "post", "endpoint": "api/2/role/:id", "responses": [ { "uuid": "65c7e232-3f14-4256-91c1-39ce86570fad", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "550d28b4-bc10-4cbb-a053-9e8352c4922c", "documentation": "Fully updates a roles. Both name and description must be given.", "method": "put", "endpoint": "api/2/role/:id", "responses": [ { "uuid": "9a05e3bc-1dee-40bb-85df-5c45cd6af39a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "143c9e1f-99a9-4ee8-8729-d580075cce88", "documentation": "Removes default actor from the given role.", "method": "delete", "endpoint": "api/2/role/:id/actors", "responses": [ { "uuid": "0ff5643b-3551-4993-ac6a-1342b18b8d80", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "64a63ea7-2682-4e54-8abd-8e572188e0a6", "documentation": "Gets default actors for the given role.", "method": "get", "endpoint": "api/2/role/:id/actors", "responses": [ { "uuid": "c288137e-dce4-4143-8eef-0abff7b941c1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "85c3e10e-7f5b-45f3-a189-f47c2dbbaf0a", "documentation": "Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.", "method": "post", "endpoint": "api/2/role/:id/actors", "responses": [ { "uuid": "aed31f2e-9938-4c1b-9a8a-e4a2198ccdc9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "48208e11-fb03-45f7-b39f-4222437bf5a6", "documentation": "Adds field or custom field to the default tab", "method": "post", "endpoint": "api/2/screens/addToDefault/:fieldId", "responses": [ { "uuid": "97015ca0-9f34-4f1a-8a3b-0b3f2c5cd3b3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8de6aa38-c591-4b3c-b306-434c30327130", "documentation": "Gets available fields for screen. i.e ones that haven't already been added.", "method": "get", "endpoint": "api/2/screens/:screenId/availableFields", "responses": [ { "uuid": "367eb32e-edeb-4632-9250-7b6ca33ca1d0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "eab70b85-b3b0-4353-a20b-ad9227c2e781", "documentation": "Returns a list of all tabs for the given screen", "method": "get", "endpoint": "api/2/screens/:screenId/tabs", "responses": [ { "uuid": "1a4c0ca5-8997-47e1-b1fc-bde89b371162", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4e392af7-a8f0-4b77-8364-49ac667b5900", "documentation": "Creates tab for given screen", "method": "post", "endpoint": "api/2/screens/:screenId/tabs", "responses": [ { "uuid": "f18497be-4f75-49e1-baa3-21af8ca5c57a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a2a179a5-a508-46b0-b02d-c96e01982406", "documentation": "Deletes tab to give screen", "method": "delete", "endpoint": "api/2/screens/:screenId/tabs/:tabId", "responses": [ { "uuid": "32ac8db8-e76c-4ee2-ae0f-cdf62ad6f4d8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f71dbb0a-13b5-46e1-bc52-3e9f31a0a074", "documentation": "Renames tab on given screen", "method": "put", "endpoint": "api/2/screens/:screenId/tabs/:tabId", "responses": [ { "uuid": "5e62a49a-9280-4144-81d7-513d2c2d4a4e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0aa90a59-0d9c-4cc0-96c9-4100a94743ae", "documentation": "Gets all fields for a given tab", "method": "get", "endpoint": "api/2/screens/:screenId/tabs/:tabId/fields", "responses": [ { "uuid": "1b2c61c9-3105-4ca2-a7a1-659a99e0329b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e3b53cd5-d566-499d-8141-cff89e34eb54", "documentation": "Adds field to the given tab.", "method": "post", "endpoint": "api/2/screens/:screenId/tabs/:tabId/fields", "responses": [ { "uuid": "ff3cdaee-5ed1-48db-9e75-8608ea5eb02f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2fd35513-2313-4de5-8b78-9d6c77e8884b", "documentation": "Removes field from given tab", "method": "delete", "endpoint": "api/2/screens/:screenId/tabs/:tabId/fields/:id", "responses": [ { "uuid": "e0cd9377-a2ef-42f3-8e71-46c8bd66dba0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "26dea620-41df-4553-ab44-ce9ac9ed8ea6", "documentation": "Moves field on the given tab", "method": "post", "endpoint": "api/2/screens/:screenId/tabs/:tabId/fields/:id/move", "responses": [ { "uuid": "c1781fff-f1e7-4803-892b-180aa79bf78f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e8922cb7-243f-40d2-9a78-f00268f667b1", "documentation": "Moves tab position", "method": "post", "endpoint": "api/2/screens/:screenId/tabs/:tabId/move/:pos", "responses": [ { "uuid": "0f3bc734-91a9-4238-8031-77244dbb06e4", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0c9d615c-7250-48fb-ac01-d64b2bf56bbc", "documentation": "Searches for issues using JQL.\n

\n Sorting\n the jql parameter is a full JQL\n expression, and includes an ORDER BY clause.\n

\n

\n The fields param (which can be specified multiple times) gives a comma-separated list of fields\n to include in the response. This can be used to retrieve a subset of fields.\n A particular field can be excluded by prefixing it with a minus.\n

\n By default, only navigable (*navigable) fields are returned in this search resource. Note: the default is different\n in the get-issue resource -- the default there all fields (*all).\n

\n

\n

\n

GET vs POST:\n If the JQL query is too large to be encoded as a query param you should instead\n POST to this resource.\n

\n

\n Expanding Issues in the Search Result:\n It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed\n in to this resources.\n

\n

\n For instance, to expand the "changelog" for all the issues on the search result, it is neccesary to\n specify "changelog" as one of the values to expand.\n

", "method": "get", "endpoint": "api/2/search", "responses": [ { "uuid": "8b1f38be-5aac-4893-b0cb-759252dfc5f3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d0b9c464-1331-4af9-8826-024a007dd867", "documentation": "Performs a search using JQL.", "method": "post", "endpoint": "api/2/search", "responses": [ { "uuid": "26352974-7189-47eb-9e64-c4e886f8f19e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bb6d551e-088c-4848-bb96-5765774b2ba0", "documentation": "Returns a full representation of the security level that has the given id.", "method": "get", "endpoint": "api/2/securitylevel/:id", "responses": [ { "uuid": "ed7771b9-03d7-46ed-8e18-e77aa4e7e9e9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ba6a2042-6503-43a2-96f6-946075fcb020", "documentation": "Returns general information about the current JIRA server.", "method": "get", "endpoint": "api/2/serverInfo", "responses": [ { "uuid": "70e3b06c-46c3-4258-8b8f-4ff102611580", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "38e01649-2ea0-4d8b-8394-bc77d0cc979f", "documentation": "Sets the base URL that is configured for this JIRA instance.", "method": "put", "endpoint": "api/2/settings/baseUrl", "responses": [ { "uuid": "840a3e89-5ea3-43a5-9aed-1ef23990e6f3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c4617b49-0c33-471b-95e4-374df4dae26f", "documentation": "Returns the default system columns for issue navigator. Admin permission will be required.", "method": "get", "endpoint": "api/2/settings/columns", "responses": [ { "uuid": "3e1e6d55-a9b0-495e-891c-f31495fe3746", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "66f80c03-9a8d-4fdc-9c66-70a3d129f76d", "documentation": "Sets the default system columns for issue navigator. Admin permission will be required.", "method": "put", "endpoint": "api/2/settings/columns", "responses": [ { "uuid": "47ece13f-6231-44cf-b1c1-9bfeff07b88c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5858aef7-64e7-4d42-9a68-a15c3df989a9", "documentation": "Returns a list of all statuses", "method": "get", "endpoint": "api/2/status", "responses": [ { "uuid": "2568f53b-8890-4661-a18c-de60f36268c4", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d1a352d6-c637-4c14-9161-c52820240c2d", "documentation": "Returns a full representation of the Status having the given id or name.", "method": "get", "endpoint": "api/2/status/:idOrName", "responses": [ { "uuid": "67ca467d-2669-44da-8029-5ab53aab23d7", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6353e076-7712-4ee9-abca-3e258fbb24ac", "documentation": "Returns a list of all status categories", "method": "get", "endpoint": "api/2/statuscategory", "responses": [ { "uuid": "381345da-82d8-45ee-846a-72423146c7ed", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a670562d-f4d7-460f-9d6e-6b7666e2016a", "documentation": "Returns a full representation of the StatusCategory having the given id or key", "method": "get", "endpoint": "api/2/statuscategory/:idOrKey", "responses": [ { "uuid": "de34204f-3937-426f-b396-4c59ff994f39", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4e04d208-1d4a-48f2-9f2a-6a3dcbd96ef3", "documentation": "", "method": "get", "endpoint": "api/2/universal_avatar/type/:type/owner/:owningObjectId", "responses": [ { "uuid": "edfa87ee-c48c-459e-9942-1026a66ec0a3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1b1aba49-6ca4-46ae-8970-85e1d5ff510f", "documentation": "", "method": "post", "endpoint": "api/2/universal_avatar/type/:type/owner/:owningObjectId/avatar", "responses": [ { "uuid": "3b461355-388c-4811-8167-a244e28d266c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "355ae144-8004-43e6-a402-088d831614b2", "documentation": "Deletes avatar", "method": "delete", "endpoint": "api/2/universal_avatar/type/:type/owner/:owningObjectId/avatar/:id", "responses": [ { "uuid": "bdae1759-f55f-41d5-97d5-b53853934b53", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a6cba7ce-9194-4d5e-8438-1031f34c4c19", "documentation": "", "method": "post", "endpoint": "api/2/universal_avatar/type/:type/owner/:owningObjectId/temp", "responses": [ { "uuid": "ce305b40-3eec-436d-8ca1-6e01d61cb01a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "74a5f1c9-e726-4654-b410-06c7f550a9ae", "documentation": "Returns the result of the last upgrade task.\n\n Returns {@link javax.ws.rs.core.Response#seeOther(java.net.URI)} if still running.", "method": "get", "endpoint": "api/2/upgrade", "responses": [ { "uuid": "41fb7337-f03b-425e-a55d-f6b3c59cb820", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "08ee8565-8113-4e9d-adad-71a1c30d0364", "documentation": "Runs any pending delayed upgrade tasks. Need Admin permissions to do this.", "method": "post", "endpoint": "api/2/upgrade", "responses": [ { "uuid": "38d54ad0-87fc-45f5-ad16-0fff8bc35fa1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ad9cd0b4-9afd-435d-89a5-aa07833fd36b", "documentation": "Removes user.", "method": "delete", "endpoint": "api/2/user", "responses": [ { "uuid": "24da4a49-54e2-49e2-ab74-a345115a8801", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9834a64c-2825-431f-8c6f-85dd1b50ffd6", "documentation": "Returns a user. This resource cannot be accessed anonymously.", "method": "get", "endpoint": "api/2/user", "responses": [ { "uuid": "ee6e7729-d946-48a2-910d-e643a8aa06bb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e14296b5-7144-4fdd-9664-794bc4dc5724", "documentation": "Create user. By default created user will not be notified with email.\n If password field is not set then password will be randomly generated.", "method": "post", "endpoint": "api/2/user", "responses": [ { "uuid": "19e0dd16-2882-433e-9452-3ddad3d0cc87", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f4be1a4f-b2f4-4ed8-b65c-9a58d419256f", "documentation": "Modify user. The \"value\" fields present will override the existing value.\n Fields skipped in request will not be changed.", "method": "put", "endpoint": "api/2/user", "responses": [ { "uuid": "44c01445-1081-47f0-a44c-e6ff8865a82c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b1d04c59-9975-42c2-bf2f-75fd24c19dec", "documentation": "Remove user from given application. Admin permission will be required to perform this operation.", "method": "delete", "endpoint": "api/2/user/application", "responses": [ { "uuid": "ece7f343-0d84-4464-aad9-8f9fee540b97", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "eab6c539-f5b1-4e75-8de9-6220e5fe7b83", "documentation": "Add user to given application. Admin permission will be required to perform this operation.", "method": "post", "endpoint": "api/2/user/application", "responses": [ { "uuid": "5d726201-76d2-4591-b1ac-146811b5defe", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "26b1783e-b437-4644-a263-1b0ec3ed5b6a", "documentation": "Returns a list of users that match the search string and can be assigned issues for all the given projects.\n This resource cannot be accessed anonymously.", "method": "get", "endpoint": "api/2/user/assignable/multiProjectSearch", "responses": [ { "uuid": "8d0d67d4-e8cc-4872-bb49-b9c037ca0848", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "11327b22-4ae4-4251-83df-20d6ddab26e3", "documentation": "Returns a list of users that match the search string. This resource cannot be accessed anonymously.\n Please note that this resource should be called with an issue key when a list of assignable users is retrieved\n for editing. For create only a project key should be supplied. The list of assignable users may be incorrect\n if it's called with the project key for editing.", "method": "get", "endpoint": "api/2/user/assignable/search", "responses": [ { "uuid": "2ea6f43c-ab07-48da-8590-64e271c2a5d5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "846200cd-ba91-4a19-b882-4836912177e9", "documentation": "Converts temporary avatar into a real avatar", "method": "post", "endpoint": "api/2/user/avatar", "responses": [ { "uuid": "d5da58d0-ca2f-49d0-8fee-4e45a380aa50", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c067e84e-3796-44c4-8910-8bb7378a1332", "documentation": "", "method": "put", "endpoint": "api/2/user/avatar", "responses": [ { "uuid": "82cee2f3-171f-4f2c-8322-a4d17bd4df40", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "963ea310-1bca-4b3b-b464-0397e980b96e", "documentation": "Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because\n the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from\n which the client parses the JSON from.\n

\n Creating a temporary avatar is part of a 3-step process in uploading a new\n avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload\n instead of sending the image directly as the request body.\n

\n

\n You *must* use \"avatar\" as the name of the upload parameter:

\n

\n 

\n curl -c cookiejar.txt -X POST -u admin:admin -H \"X-Atlassian-Token: no-check\" \\\n   -F \"avatar=@mynewavatar.png;type=image/png\" \\\n   'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'\n
", "method": "post", "endpoint": "api/2/user/avatar/temporary", "responses": [ { "uuid": "db7cf9b7-5da6-44dd-82bb-3fe7f72e04a1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "963837ac-909f-469f-854a-fbd53f54dc31", "documentation": "Deletes avatar", "method": "delete", "endpoint": "api/2/user/avatar/:id", "responses": [ { "uuid": "eaad2dbe-0152-4ad6-8bff-41a989cd7faf", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ff04684d-058e-4d34-8feb-b10f01c08d61", "documentation": "Returns all avatars which are visible for the currently logged in user.", "method": "get", "endpoint": "api/2/user/avatars", "responses": [ { "uuid": "169e8967-ba4e-4beb-8486-151cb1ab380b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4711ca70-3d48-4341-8cf1-a1e8d609a353", "documentation": "Reset the default columns for the given user to the system default. Admin permission will be required to get\n columns for a user other than the currently logged in user.", "method": "delete", "endpoint": "api/2/user/columns", "responses": [ { "uuid": "63f595a4-fb82-4331-8236-155f2bc33b3c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cdc78dd6-f2c3-48fb-952c-a4af31b1cc47", "documentation": "Returns the default columns for the given user. Admin permission will be required to get columns for a user\n other than the currently logged in user.", "method": "get", "endpoint": "api/2/user/columns", "responses": [ { "uuid": "73582ada-f65a-4d7a-82b5-50f170ee1224", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "68242f10-8279-4dab-aa57-73dcf573be19", "documentation": "Sets the default columns for the given user. Admin permission will be required to get columns for a user\n other than the currently logged in user.", "method": "put", "endpoint": "api/2/user/columns", "responses": [ { "uuid": "feb3b580-57ef-484f-b7b2-1b632d8c54df", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "99da81b7-9085-4927-9ad1-a87e5f875899", "documentation": "Modify user password.", "method": "put", "endpoint": "api/2/user/password", "responses": [ { "uuid": "9747057c-8ae4-4b18-8499-e796eb5d62f2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "70e5bcb2-00cd-46d9-83db-a8733894d540", "documentation": "Returns a list of active users that match the search string and have all specified permissions for the project or issue.
\n This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights.", "method": "get", "endpoint": "api/2/user/permission/search", "responses": [ { "uuid": "82329c1f-fa42-436a-9549-31d6839b0be8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "018b4bf2-bfc6-4b1f-8d68-075eaf7667b1", "documentation": "Returns a list of users matching query with highlighting. This resource cannot be accessed anonymously.", "method": "get", "endpoint": "api/2/user/picker", "responses": [ { "uuid": "2d8c6f3a-a2ce-4ea9-9af9-e28575df0cff", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c09c4664-2137-44f3-be0c-2f7e61543c70", "documentation": "Returns the keys of all properties for the user identified by the key or by the id.", "method": "get", "endpoint": "api/2/user/properties/", "responses": [ { "uuid": "c4593a35-d90c-47b5-89bb-ff6698492901", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "46325b9f-f2a3-4abf-8d7d-f21581024e77", "documentation": "Removes the property from the user identified by the key or by the id. Ths user removing the property is required\n to have permissions to administer the user.", "method": "delete", "endpoint": "api/2/user/properties/:propertyKey", "responses": [ { "uuid": "5281ac98-2355-4c52-99a6-13d5e098f730", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "908a58a0-83d3-444f-837c-29d2b1cf29d9", "documentation": "Returns the value of the property with a given key from the user identified by the key or by the id. The user who retrieves\n the property is required to have permissions to read the user.", "method": "get", "endpoint": "api/2/user/properties/:propertyKey", "responses": [ { "uuid": "84562661-d167-4b6f-92d2-21ec15fed8cb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "61f34c58-d4ed-47a9-936e-c50b603a1510", "documentation": "Sets the value of the specified user's property.\n

\n You can use this resource to store a custom data against the user identified by the key or by the id. The user\n who stores the data is required to have permissions to administer the user.\n

", "method": "put", "endpoint": "api/2/user/properties/:propertyKey", "responses": [ { "uuid": "8f4fb80d-a79a-485d-9a82-e9228077cda1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "aa9314d3-a0fb-4064-812b-a148f2d02d6e", "documentation": "Returns a list of users that match the search string. This resource cannot be accessed anonymously.", "method": "get", "endpoint": "api/2/user/search", "responses": [ { "uuid": "2d010ee5-8f22-4658-a882-4beb29e5274b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "78824a66-0706-44f3-8e72-a7e8c05f7423", "documentation": "Returns a list of active users that match the search string. This resource cannot be accessed anonymously \n and requires the Browse Users global permission.\n Given an issue key this resource will provide a list of users that match the search string and have\n the browse issue permission for the issue provided.", "method": "get", "endpoint": "api/2/user/viewissue/search", "responses": [ { "uuid": "8d436202-d368-4e8a-92e6-6c1087a0e195", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0dbd1e96-a9b2-4fd9-804c-e44d804d5423", "documentation": "Create a version via POST.", "method": "post", "endpoint": "api/2/version", "responses": [ { "uuid": "9617ab0d-31d3-436e-897e-e1620aa9f097", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b0e62260-fd9f-4424-862b-8a72f879a0e4", "documentation": "Returns the remote version links for a given global ID.", "method": "get", "endpoint": "api/2/version/remotelink", "responses": [ { "uuid": "e26c1777-98db-45f9-ab43-60bd2d778380", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "57fde285-7489-4960-99b0-a7078cfb028c", "documentation": "Delete a project version.", "method": "delete", "endpoint": "api/2/version/:id", "responses": [ { "uuid": "92f601f2-fab4-4f31-8a0d-fe40a5fbd015", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "87874bbb-9e7a-4c3e-989a-4a870a4cce53", "documentation": "Returns a project version.", "method": "get", "endpoint": "api/2/version/:id", "responses": [ { "uuid": "5f254e27-b5fd-41e9-8db5-176ff043de3a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1c61e166-1454-4a2b-a9f4-fa816765b07c", "documentation": "Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field\n is not present, it is silently ignored.", "method": "put", "endpoint": "api/2/version/:id", "responses": [ { "uuid": "953b0221-8377-4cb8-b648-e844e07f8eb8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2909e900-89a9-444e-b2f8-6fa9872ca557", "documentation": "Merge versions", "method": "put", "endpoint": "api/2/version/:id/mergeto/:moveIssuesTo", "responses": [ { "uuid": "a18492ad-bc42-4571-b6cd-7aa444b07b97", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "87777005-6913-4431-a57e-72066406c029", "documentation": "Modify a version's sequence within a project.\n

\n The move version bean has 2 alternative field value pairs:\n

\n
position
An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'
\n
after
A version to place this version after. The value should be the self link of another version
\n
", "method": "post", "endpoint": "api/2/version/:id/move", "responses": [ { "uuid": "ec8e9b99-5e83-495d-a504-11bc2f2ec821", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "259050c8-27e7-4091-bf66-fab0c07556ab", "documentation": "Returns a bean containing the number of fixed in and affected issues for the given version.", "method": "get", "endpoint": "api/2/version/:id/relatedIssueCounts", "responses": [ { "uuid": "3f3bc1c2-2a80-4c1f-b8e8-e02320702b1d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ce59d29d-a8ad-4364-a84c-57aa9f458f9c", "documentation": "Delete a project version.", "method": "post", "endpoint": "api/2/version/:id/removeAndSwap", "responses": [ { "uuid": "1ade8dd8-200a-41d6-bf1f-1a61383361e2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b39fce4c-f928-4e65-8b2a-161cf0346ded", "documentation": "Returns the number of unresolved issues for the given version", "method": "get", "endpoint": "api/2/version/:id/unresolvedIssueCount", "responses": [ { "uuid": "89958175-6e0c-4c76-9a2c-2f92649a0396", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "121d8887-474e-4a37-8e11-b5f7293401e2", "documentation": "Delete all remote version links for a given version ID.", "method": "delete", "endpoint": "api/2/version/:versionId/remotelink", "responses": [ { "uuid": "118b15ba-8aeb-461f-8450-04efab125e77", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a33e1225-f9f5-4014-bc11-8be37fccc6c3", "documentation": "Returns the remote version links associated with the given version ID.", "method": "get", "endpoint": "api/2/version/:versionId/remotelink", "responses": [ { "uuid": "ac125a18-67e5-448a-9fd8-7be581ea5744", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8a2ed20b-2c99-4ff8-a452-7670148279f5", "documentation": "Create a remote version link via POST. The link's global ID will be taken from the\n JSON payload if provided; otherwise, it will be generated.", "method": "post", "endpoint": "api/2/version/:versionId/remotelink", "responses": [ { "uuid": "38253add-acdd-458c-b02b-bee84b35f1e4", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4d1782a7-4e1b-4f9c-941c-53e05a41871d", "documentation": "Delete a specific remote version link with the given version ID and global ID.", "method": "delete", "endpoint": "api/2/version/:versionId/remotelink/:globalId", "responses": [ { "uuid": "8628a5d5-cdd8-48c4-ac56-66fd69e44535", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ec23bd7e-0fe3-4e6c-b41f-d68b7864cd5d", "documentation": "A REST sub-resource representing a remote version link", "method": "get", "endpoint": "api/2/version/:versionId/remotelink/:globalId", "responses": [ { "uuid": "6a39fc33-9b2f-4f14-8093-8a964fe1ef5a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "95c5bc71-6f2b-49a4-88e7-586848904107", "documentation": "Create a remote version link via POST. The link's global ID will be taken from the\n JSON payload if provided; otherwise, it will be generated.", "method": "post", "endpoint": "api/2/version/:versionId/remotelink/:globalId", "responses": [ { "uuid": "0a2c3061-c180-41fc-8625-a627cb2cafef", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6d21ef14-57e8-4e54-b3d3-549d7b79d30d", "documentation": "Returns all workflows.", "method": "get", "endpoint": "api/2/workflow", "responses": [ { "uuid": "1ab04a17-b91c-4413-aa9f-3dc72cd21874", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4ccf5043-4844-447c-b86c-1e67caf4bd35", "documentation": "Delete a property from the passed transition on the passed workflow. It is not an error to delete a property that\n does not exist.", "method": "delete", "endpoint": "api/2/workflow/api/2/transitions/:id/properties", "responses": [ { "uuid": "d6e5f0b0-b64f-4438-8ffb-b1366f65b251", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5e0691fd-8a2a-4d2d-ac75-43608a665569", "documentation": "Return the property or properties associated with a transition.", "method": "get", "endpoint": "api/2/workflow/api/2/transitions/:id/properties", "responses": [ { "uuid": "b7f333a0-709f-4574-ba42-602513962a72", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5320c12e-4103-4d6c-b969-984df8158aaa", "documentation": "Add a new property to a transition. Trying to add a property that already\n exists will fail.", "method": "post", "endpoint": "api/2/workflow/api/2/transitions/:id/properties", "responses": [ { "uuid": "9696a6ef-a39a-4f65-894f-71bc483cf2c5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "451a0e48-0c25-49f5-8637-360f9a42762d", "documentation": "Update/add new property to a transition. Trying to update a property that does\n not exist will result in a new property being added.", "method": "put", "endpoint": "api/2/workflow/api/2/transitions/:id/properties", "responses": [ { "uuid": "793ff35f-9637-4d58-8c06-fe47e69c0d56", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5e5717ca-6b7b-4f6d-8b43-e0e96fb7a83a", "documentation": "Create a new workflow scheme.\n

\n The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.", "method": "post", "endpoint": "api/2/workflowscheme", "responses": [ { "uuid": "2b599b79-373a-46a9-b510-d121bc06e76f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a4afa240-8033-4120-a607-4cd003e59862", "documentation": "Delete the passed workflow scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id", "responses": [ { "uuid": "a4d90535-83bd-4177-86c4-0335e16405ab", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ae3f35dd-e707-490b-a22a-e1ec237409c8", "documentation": "Returns the requested workflow scheme to the caller.", "method": "get", "endpoint": "api/2/workflowscheme/:id", "responses": [ { "uuid": "80d87fd8-cbd1-4b34-ae7a-dbc29f9563b5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "25707cf6-94d6-495d-b064-db4fdbce61a6", "documentation": "Update the passed workflow scheme.\n

\n The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate\n no change for that field.\n

\n The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft\n should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by\n a project). Values not appearing the body will not be touched.", "method": "put", "endpoint": "api/2/workflowscheme/:id", "responses": [ { "uuid": "7055962d-a977-4c86-9777-e68c728c723a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "740128ae-116f-4300-ac3e-67bb46bff892", "documentation": "Create a draft for the passed scheme. The draft will be a copy of the state of the parent.", "method": "post", "endpoint": "api/2/workflowscheme/:id/createdraft", "responses": [ { "uuid": "80827059-ff16-4535-995e-fa2ea8f41fd6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b6f6b9b0-27ac-42b3-80a0-f1c5b5c7e6fd", "documentation": "Remove the default workflow from the passed workflow scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/default", "responses": [ { "uuid": "6e76b92d-8993-4fb4-ba55-c520fd8e1bcd", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2a958f01-0125-4f3b-a1c2-64654f1408e9", "documentation": "Return the default workflow from the passed workflow scheme.", "method": "get", "endpoint": "api/2/workflowscheme/:id/default", "responses": [ { "uuid": "a924c9b8-fcfa-4a9e-853f-d0114681dd93", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0cccd60e-a487-4865-95f0-3d7c34d8a8da", "documentation": "Set the default workflow for the passed workflow scheme.\n

\n The passed representation can have its\n updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme\n cannot be edited.", "method": "put", "endpoint": "api/2/workflowscheme/:id/default", "responses": [ { "uuid": "fb9bf073-fa60-498a-9a3c-1b464e840057", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "29eaf3c6-e68c-48b4-92aa-aad377e58fe1", "documentation": "Delete the passed draft workflow scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/draft", "responses": [ { "uuid": "7675f55f-932a-4788-9304-38bb10002c97", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8d4fd545-cfaa-46c8-b507-990df2bf111d", "documentation": "Returns the requested draft workflow scheme to the caller.", "method": "get", "endpoint": "api/2/workflowscheme/:id/draft", "responses": [ { "uuid": "98f26ecb-c5a1-4624-b02e-a037276bf0ae", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "31ce6ca5-f520-4534-849a-4d6c613f7b12", "documentation": "Update a draft workflow scheme. The draft will created if necessary.\n

\n The body is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.", "method": "put", "endpoint": "api/2/workflowscheme/:id/draft", "responses": [ { "uuid": "cefba447-98d0-4603-a88f-0300aa6eaaad", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "afd48bf0-a2af-4862-9fe4-b1ddf49c6c24", "documentation": "Remove the default workflow from the passed draft workflow scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/draft/default", "responses": [ { "uuid": "002d5bfb-e14c-4529-a5a7-a0d889d74280", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a68cf116-03b4-416a-ab5a-e66daf0c2b23", "documentation": "Return the default workflow from the passed draft workflow scheme to the caller.", "method": "get", "endpoint": "api/2/workflowscheme/:id/draft/default", "responses": [ { "uuid": "782bc11b-e99a-4465-836f-3d472a18fb06", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b5ace981-06d7-4c6c-8ab5-430bfa72d2d0", "documentation": "Set the default workflow for the passed draft workflow scheme.", "method": "put", "endpoint": "api/2/workflowscheme/:id/draft/default", "responses": [ { "uuid": "6f091ea2-825d-4ed6-88b2-cfb30e00d5a7", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4a046ff7-d878-49a1-92aa-2411d12c06c3", "documentation": "Remove the specified issue type mapping from the draft scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/draft/issuetype/:issueType", "responses": [ { "uuid": "390aa3b9-8a4a-455f-a7a9-d3ef444e479b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fd568887-0992-4832-a134-d20765598b8a", "documentation": "Returns the issue type mapping for the passed draft workflow scheme.", "method": "get", "endpoint": "api/2/workflowscheme/:id/draft/issuetype/:issueType", "responses": [ { "uuid": "3547c36f-d26e-42e5-a177-ed534a78bf1c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ddd59199-91ba-45ec-b3e4-42f51a53904a", "documentation": "Set the issue type mapping for the passed draft scheme.\n

\n The passed representation can have its updateDraftIfNeeded flag set to true to indicate that\n the draft should be created/updated when the actual scheme cannot be edited.", "method": "put", "endpoint": "api/2/workflowscheme/:id/draft/issuetype/:issueType", "responses": [ { "uuid": "4852b242-719f-4b56-a44b-881403e2ecd4", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9228789e-83ef-40ac-a1db-87ff9861af7c", "documentation": "Delete the passed workflow from the draft workflow scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/draft/workflow", "responses": [ { "uuid": "29441b19-c98a-4fff-82d2-19e48ba47ad3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0a542e35-3d12-46f3-a4b8-77f8d9e22098", "documentation": "Returns the draft workflow mappings or requested mapping to the caller.", "method": "get", "endpoint": "api/2/workflowscheme/:id/draft/workflow", "responses": [ { "uuid": "fee41915-8406-44af-a597-7988a7dd7133", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7ea3c0e4-fc93-480b-9ce4-2a2303315b75", "documentation": "Update the draft scheme to include the passed mapping.\n

\n The body is a representation of the workflow mapping.\n Values not passed are assumed to indicate no change for that field.", "method": "put", "endpoint": "api/2/workflowscheme/:id/draft/workflow", "responses": [ { "uuid": "1060a2dc-1da3-4149-980d-d457cedb4093", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6028dadd-e6f3-4dd4-97ca-1c86868775f8", "documentation": "Remove the specified issue type mapping from the scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/issuetype/:issueType", "responses": [ { "uuid": "8990a639-66dc-4d12-8bb8-abc8dc27582d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5b61eb79-209a-411a-98a6-6dcf393f73e7", "documentation": "Returns the issue type mapping for the passed workflow scheme.", "method": "get", "endpoint": "api/2/workflowscheme/:id/issuetype/:issueType", "responses": [ { "uuid": "77573619-9ba7-4804-8f88-d146fa95bbef", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "384119e1-3db4-47bd-a186-bf5d88d362b9", "documentation": "Set the issue type mapping for the passed scheme.\n

\n The passed representation can have its updateDraftIfNeeded flag set to true to indicate that\n the draft should be created/updated when the actual scheme cannot be edited.", "method": "put", "endpoint": "api/2/workflowscheme/:id/issuetype/:issueType", "responses": [ { "uuid": "ed4cb095-726f-4cb3-803f-06ec85f71711", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d59a8374-4d2b-409b-b86b-35c01c59883d", "documentation": "Delete the passed workflow from the workflow scheme.", "method": "delete", "endpoint": "api/2/workflowscheme/:id/workflow", "responses": [ { "uuid": "3bca46f5-50ba-4cfa-accf-0242f563f725", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7d3c4c5c-ec9c-41e8-9685-120cea9f1668", "documentation": "Returns the workflow mappings or requested mapping to the caller for the passed scheme.", "method": "get", "endpoint": "api/2/workflowscheme/:id/workflow", "responses": [ { "uuid": "8d857bf1-200d-4e43-9eb7-0cdda5950660", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "712bec69-7d26-4a22-99cd-23258b5a8b91", "documentation": "Update the scheme to include the passed mapping.\n

\n The body is a representation of the workflow mapping.\n Values not passed are assumed to indicate no change for that field.\n

\n The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft\n should be created/updated when the actual scheme cannot be edited.", "method": "put", "endpoint": "api/2/workflowscheme/:id/workflow", "responses": [ { "uuid": "5d5dee95-c069-4c1a-9910-dcf93ea78596", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "209e1225-c04c-4e74-909d-4ca8caea4e10", "documentation": "Returns worklogs id and delete time of worklogs that was deleted since given time.\n The returns set of worklogs is limited to 1000 elements.\n This API will not return worklogs deleted during last minute.", "method": "get", "endpoint": "api/2/worklog/deleted", "responses": [ { "uuid": "38b8f0dd-7f3d-4d81-b455-7c44e67c3faa", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3ac6df25-754f-4159-a0c1-e2dc46e8cdfa", "documentation": "Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result.\n The returns set of worklogs is limited to 1000 elements.", "method": "post", "endpoint": "api/2/worklog/list", "responses": [ { "uuid": "3bc623c8-14ea-4934-bcd1-6a1d25c8c3eb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1d29b17d-917f-4791-a0d2-c457fa0636a8", "documentation": "Returns worklogs id and update time of worklogs that was updated since given time.\n The returns set of worklogs is limited to 1000 elements.\n This API will not return worklogs updated during last minute.", "method": "get", "endpoint": "api/2/worklog/updated", "responses": [ { "uuid": "2a0e812b-f0e5-4229-85ad-8805572b17f2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5ad8bb21-ccc4-4b06-b240-cdaaa370c449", "documentation": "Logs the current user out of JIRA, destroying the existing session, if any.", "method": "delete", "endpoint": "auth/1/session", "responses": [ { "uuid": "1bf08979-0177-42d3-af14-f11484cd87e5", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "adb8d968-1b42-4b80-875b-463e9ea888d2", "documentation": "Returns information about the currently authenticated user's session. If the caller is not authenticated they\n will get a 401 Unauthorized status code.", "method": "get", "endpoint": "auth/1/session", "responses": [ { "uuid": "b20b060a-1f1d-41d6-862d-aa20564fdb74", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8dd55ae3-647f-4451-88cc-eec2905200f5", "documentation": "Creates a new session for a user in JIRA. Once a session has been successfully created it can be used to access\n any of JIRA's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.\n

\n Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource\n may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user).", "method": "post", "endpoint": "auth/1/session", "responses": [ { "uuid": "0b1115c3-63e5-4b4a-93b2-5042458bca2f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c259d4aa-aef8-488b-89d9-7acd220f8045", "documentation": "This method invalidates the any current WebSudo session.", "method": "delete", "endpoint": "auth/1/websudo", "responses": [ { "uuid": "2b560abc-1237-47ab-8830-8ad4af8266a3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ], "data": [] }