{ "uuid": "fa16dad8-aa5c-47a8-a926-62156a5bb873", "lastMigration": 29, "name": "Crucible", "endpointPrefix": "context/", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "707c6d67-f691-4de6-8e8d-75a1698f7d1f", "documentation": "Get the user authentication token.\n \n This is a legacy version of the login request. Using GET is deprecated as your password is likely to appear in logs which record request URLs.\n Use the POST version instead.", "method": "get", "endpoint": "rest-service/auth-v1/login", "responses": [ { "uuid": "6c7c9690-285d-4aee-af2e-d5b95a3a55ab", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2b299adb-adda-4f85-aa0e-b2b0a9fc137b", "documentation": "Get the user authentication token.", "method": "post", "endpoint": "rest-service/auth-v1/login", "responses": [ { "uuid": "4e3209c6-d59b-45a6-b766-6379812a4005", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "140de25d-fce7-4b41-8990-bbeefeef127a", "documentation": "Get the list of projects that the authenticated user is entitled to access.", "method": "get", "endpoint": "rest-service/projects-v1", "responses": [ { "uuid": "9f31d3ff-663f-48fc-bcc7-91b2589328a8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cbc66c06-d0f5-4098-b722-b6b8de6bcc05", "documentation": "Returns a project description.", "method": "get", "endpoint": "rest-service/projects-v1/:key", "responses": [ { "uuid": "2e9b36c7-ff4b-402c-9619-1223e5e72db8", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1455bdf0-acc2-47a7-9fba-9a4246035365", "documentation": "Returns a list of all repositories. This includes plugin provided repositories", "method": "get", "endpoint": "rest-service/repositories-v1", "responses": [ { "uuid": "5caa109d-6574-406c-a519-666efc327adc", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fff7a655-e220-44c6-ac49-77e8705e21a9", "documentation": "Lists the contents of the specified directory.", "method": "get", "endpoint": "rest-service/repositories-v1/browse/:repository/:path", "responses": [ { "uuid": "d2591ab8-9c36-4ff3-81e6-83521f82f53e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b43f1dc3-7669-443f-b8c2-b26df133f904", "documentation": "Represents a particular changeset.", "method": "get", "endpoint": "rest-service/repositories-v1/change/:repository/:revision", "responses": [ { "uuid": "8971bf4a-f958-43a6-a056-5c0821472f13", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82d56fef-4d86-48d9-8cc0-03d6e994701a", "documentation": "Represents a sorted list of changesets, newest first.", "method": "get", "endpoint": "rest-service/repositories-v1/changes/:repository/:path", "responses": [ { "uuid": "185f9124-db2b-48a5-acf3-f2441dc5ced9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "12f3b11b-5139-49f5-bddf-6f9828fafc74", "documentation": "Returns the raw content of the specified file revision as a binary\n stream. No attempt is made to identify the content type and no mime\n type is provided.", "method": "get", "endpoint": "rest-service/repositories-v1/content/:repository/:revision/:path", "responses": [ { "uuid": "68f0f5dc-9335-4c94-9cfe-85c96f95e379", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c5430ad9-95a7-4042-94ba-f54888c03fab", "documentation": "Represents the history of a versioned entity.", "method": "get", "endpoint": "rest-service/repositories-v1/history/:repository/:revision/:path", "responses": [ { "uuid": "6cbb3f7c-82a2-49b8-a312-7e6d3c701caf", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a389f81-30f5-418b-8061-a84fe09ff19f", "documentation": "", "method": "get", "endpoint": "rest-service/repositories-v1/:repository", "responses": [ { "uuid": "994ae53a-d41e-4847-8de6-c41d543a92ce", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a4d45fc1-db7d-48e1-b614-b576be6e8061", "documentation": "For backward compatibility we provide this method, but repositories should be referred to just by their key.", "method": "get", "endpoint": "rest-service/repositories-v1/:repository/svn", "responses": [ { "uuid": "52f15868-1121-43f0-9423-27976f8f854e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b9c4e7d-d612-4b10-9c9b-96ca10b1ff73", "documentation": "", "method": "get", "endpoint": "rest-service/repositories-v1/:repository/:revision/:path", "responses": [ { "uuid": "45945687-33b8-4189-8568-e74d37897114", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3cde55c1-9759-44b7-936e-d500a09ddf01", "documentation": "", "method": "get", "endpoint": "rest-service/reviews-v1", "responses": [ { "uuid": "cd7caff3-ad9c-4d5a-89a9-1a8431abd019", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "59d3e003-e0d7-4a5b-b881-12c0bb3afe02", "documentation": "", "method": "post", "endpoint": "rest-service/reviews-v1", "responses": [ { "uuid": "e53963cf-2930-46b3-a4f2-f7cddb4f1f2f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "830915e1-f50b-4dd8-aaca-4b644aedf98f", "documentation": "Retrieves all reviews that are in one of the the specified states. For each review all details are included (review items + comments). The\n wiki rendered comments will be available via the element", "method": "get", "endpoint": "rest-service/reviews-v1/details", "responses": [ { "uuid": "b8e06ded-0f36-493c-b3e1-19eeeb1a5365", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5391b408-9561-4029-a8a1-417d0c82ee38", "documentation": "To ignore a property, omit it from the query string.", "method": "get", "endpoint": "rest-service/reviews-v1/filter", "responses": [ { "uuid": "e68eabe6-fcdc-4db8-af5c-53a577eaa918", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6f3b239f-c229-4d90-98b6-28d2cda254dc", "documentation": "This method should no longer be used, as it uses a POST for a read-only\n retrieval operation and is provided for backward compatibility only.", "method": "post", "endpoint": "rest-service/reviews-v1/filter", "responses": [ { "uuid": "48e09596-e752-47e9-890c-cf2de7e48771", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fff25ff6-30e3-4f29-964e-50bb4fd99798", "documentation": "To ignore a property, omit it from the query string.", "method": "get", "endpoint": "rest-service/reviews-v1/filter/details", "responses": [ { "uuid": "ad095c0a-8568-41a2-ac03-095db2521cc2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e937803f-5127-4db7-9f15-c5d25b753f37", "documentation": "This method should no longer be used, as it uses a POST for a read-only\n retrieval operation and is provided for backward compatibility only.", "method": "post", "endpoint": "rest-service/reviews-v1/filter/details", "responses": [ { "uuid": "b9afdc4c-9add-42f6-9c98-891e42e9c616", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8c413738-85db-498e-9844-fb6b7027351e", "documentation": "Get all the reviews which match the given filter, for the current user.", "method": "get", "endpoint": "rest-service/reviews-v1/filter/:filter", "responses": [ { "uuid": "1d22eaf2-9af7-4884-bea0-8d46b682b53a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "39dbc8f3-8326-491d-b008-3e97f05c6e26", "documentation": "Gets a list of all the reviews that match the specified filter criteria.", "method": "get", "endpoint": "rest-service/reviews-v1/filter/:filter/details", "responses": [ { "uuid": "298df2e1-bea6-4140-89a8-b868c9dce739", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "201fadb3-b9f3-452e-ad52-807db855da09", "documentation": "Get comment metrics metadata for the specified metrics version.", "method": "get", "endpoint": "rest-service/reviews-v1/metrics/:version", "responses": [ { "uuid": "800ce0cb-e054-41f7-8a7d-2af1b30d5be6", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d960913e-4585-4a71-bdaf-dd844fb566e5", "documentation": "Return a list of Reviews which include a particular file.", "method": "get", "endpoint": "rest-service/reviews-v1/search/:repository", "responses": [ { "uuid": "7bceb140-988e-447b-bc62-5bec73488a0b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d6035d23-1e07-4dd2-91de-3a17726810de", "documentation": "Return a list of Reviews which include a particular file.", "method": "get", "endpoint": "rest-service/reviews-v1/search/:repository/details", "responses": [ { "uuid": "3819fb14-0e78-4593-b2d7-fee6709ad799", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4acf5db1-2950-44a7-862e-9f858cbf1499", "documentation": "Returns Crucible version information.", "method": "get", "endpoint": "rest-service/reviews-v1/versionInfo", "responses": [ { "uuid": "1a845c87-712c-4c1d-859c-33d6c8e3b243", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c35de7fe-7083-4b64-bfdd-4dcd9b7acd7a", "documentation": "Permanently deletes the specified review.\n The review must have been abandoned.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id", "responses": [ { "uuid": "176f70c3-5767-4d98-9ff9-a4a59ce1fbde", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ba22130f-6bca-4f92-92c8-3c48ffcabeec", "documentation": "Get a single review by its permId (e.g. \"CR-45\").\n If the review does not exist, a 404 is returned.\n \n The moderator element may not exist if the review does not have a Moderator.", "method": "get", "endpoint": "rest-service/reviews-v1/:id", "responses": [ { "uuid": "836f693c-e5dd-4215-bac2-6fa0dc706500", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3f1379a0-201e-4761-8e97-0545b6d36067", "documentation": "Get a list of the actions which the current user is allowed to perform\n on the review.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/actions", "responses": [ { "uuid": "bad909e7-095f-4c45-8ee1-cfc7186cc510", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2cd2a269-e430-4b2e-aadd-c0f10037b4d9", "documentation": "", "method": "post", "endpoint": "rest-service/reviews-v1/:id/addChangeset", "responses": [ { "uuid": "a73766ac-a36a-479c-ad89-5bc10d70099d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "67345c01-9b2d-419d-8bce-bc04bfb747f9", "documentation": "", "method": "post", "endpoint": "rest-service/reviews-v1/:id/addFile", "responses": [ { "uuid": "37cebe5d-c5f3-4c3a-b9bc-ad2fc0c1f5f2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b639fce-ed37-420f-a426-cae4af62fb3f", "documentation": "Old, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch", "method": "post", "endpoint": "rest-service/reviews-v1/:id/addPatch", "responses": [ { "uuid": "3f010c5d-b2ee-4bda-8b76-f60e20e2200a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b74e45d9-4a8b-4759-bb39-4d698fbcc21d", "documentation": "Closes the given review with the summary given.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/close", "responses": [ { "uuid": "e67b01ff-c3af-4429-ba41-47c4c01e8942", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81fcc3ec-25c8-42d4-b20a-776bde0bb515", "documentation": "Return all the comments visible to the requesting user for the review.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/comments", "responses": [ { "uuid": "a21872ac-00a9-4975-990d-48a860dedd05", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "29b58461-19b6-48f3-9238-cb17532a937e", "documentation": "Add a general comment to the review.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments", "responses": [ { "uuid": "58554479-4e87-4cb6-9870-44d3f2bd65d2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "93113402-6338-454c-963b-4b7193df7db7", "documentation": "", "method": "get", "endpoint": "rest-service/reviews-v1/:id/comments/general", "responses": [ { "uuid": "9e2852db-d7c7-4d33-a252-fb2129de6f8b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63e6a13d-c910-4993-b7a0-b4b302121b02", "documentation": "For the effective user, mark all comments in a review as read (except\n those marked as leave unread).", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments/markAllAsRead", "responses": [ { "uuid": "e4ac0c28-8680-493b-9524-80652771f50f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ad232490-e1ca-4b4d-afca-b5d322dff5d4", "documentation": "", "method": "get", "endpoint": "rest-service/reviews-v1/:id/comments/versioned", "responses": [ { "uuid": "635cead5-17d5-4ddc-99bf-b0b44044137b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0fe97876-f9e6-493e-a5d3-0738bec8368c", "documentation": "Deletes the given comment.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id/comments/:cId", "responses": [ { "uuid": "af6a7695-ce95-4828-87c3-57cf6ae86e09", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "edc01c8b-6f0c-4983-a904-782f3dac3604", "documentation": "Gets the given comment.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/comments/:cId", "responses": [ { "uuid": "6fa23c33-2862-4613-bb1b-dd716b85ea03", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2a55e37a-7a8d-4d16-80f3-ee1bca054eb4", "documentation": "Updates the comment given by the perma id to the new comment posted.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments/:cId", "responses": [ { "uuid": "5aad702a-29e2-4650-9028-4f159c1d5a57", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21f21864-b7b8-4cfc-bc25-90cf4582dd4b", "documentation": "Marks the comment as leave unread to the current user - it will not automatically be marked as read by crucible.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments/:cId/markAsLeaveUnread", "responses": [ { "uuid": "48cf8425-d75c-43ff-bc8e-1295e806d49d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d5401c7b-5b97-4385-923c-7fc43d54d56c", "documentation": "Mark the given comment as read for the user used to make this POST.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments/:cId/markAsRead", "responses": [ { "uuid": "4f028387-89e1-450a-8d48-4e885a3f5791", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fa5b859c-bfec-4041-a65c-8bc1ddd21d90", "documentation": "Gets the replies to the given comment.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/comments/:cId/replies", "responses": [ { "uuid": "b36ffe4c-32a3-4f46-8298-c0fd2166bd2b", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d0ab0fbd-20fb-4c7a-b053-09248af42584", "documentation": "Adds a reply to the given comment. This call includes the repsonse header that\n contains the URL of the newly created entity.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments/:cId/replies", "responses": [ { "uuid": "430f5c53-62b3-40af-825d-25f6e5218eec", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7d4dfc04-098e-4b04-81e7-6bf0570de4a0", "documentation": "Deletes the reply.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id/comments/:cId/replies/:rId", "responses": [ { "uuid": "40716857-fa56-4083-bf73-f9be817bc0ce", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c4c49bf1-65de-4777-be32-83cf5e85c48b", "documentation": "Updates a reply with the given newComment.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/comments/:cId/replies/:rId", "responses": [ { "uuid": "28501533-d778-4b6b-b0bf-c158a1b13a10", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a49e24f6-bcc0-40fd-ae35-07e5c3784622", "documentation": "Completes the review for the current user", "method": "post", "endpoint": "rest-service/reviews-v1/:id/complete", "responses": [ { "uuid": "386ba80f-fdb4-409b-98c3-521d7d66c902", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ac6424e7-9268-4370-b3df-79eaf7180826", "documentation": "Returns the specified review.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/details", "responses": [ { "uuid": "bb460431-5cc8-46a1-a989-5d1c738bce31", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "776a25f8-cc98-433f-8cc6-402c4ffe2866", "documentation": "Get a list of patches and their details for the given review", "method": "get", "endpoint": "rest-service/reviews-v1/:id/patch", "responses": [ { "uuid": "d4b2e57f-9327-4a2c-a6aa-1a47a0d3f4e0", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8cca134e-1bb8-47b2-acb4-ae431b00aec0", "documentation": "Add the revisions in a patch to an existing review.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/patch", "responses": [ { "uuid": "affdf8b9-e124-4409-9873-405b202bbb42", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18bf2372-56fa-496f-8794-9ce8ab4669b7", "documentation": "Removes the patch with the given id from the review. All of the revisions provided by the patch will be removed as well.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id/patch/:patchId", "responses": [ { "uuid": "66bf416e-a390-415d-a07d-11658f0a6ca1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7bc1b110-28ca-477c-a198-b636a2344bbb", "documentation": "Publishes all the draft comments of the current user.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/publish", "responses": [ { "uuid": "4496a84e-ba3e-422e-a6ac-afb2f7c5df7f", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4cbe273e-1c86-4aff-bced-fd30f78a6557", "documentation": "publishes the given draft comment.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/publish/:cId", "responses": [ { "uuid": "8d006bea-03a1-4712-8b96-9566cb60163d", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a915bbf5-4916-4911-80b9-ab170a9eabb5", "documentation": "Immediately send a reminder to incomplete reviewers about the given review.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/remind", "responses": [ { "uuid": "d3ca081a-2602-41bc-8019-63d1452e3428", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f48197c0-533d-40e6-8b57-4c6b0e9d84ae", "documentation": "Get a list of reviewers in the review given by the permaid id.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/reviewers", "responses": [ { "uuid": "f497893c-cb22-4cb9-aadd-7cf1bb290d2c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "22434259-cd18-4dad-bcee-96ebc3b5b542", "documentation": "Adds the given list of reviewers to the review.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/reviewers", "responses": [ { "uuid": "c87fa62d-9646-4040-951b-37b8c29844cc", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2d62c783-2a02-4acb-8c16-98d6b5c81396", "documentation": "Gets a list of completed reviewers.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/reviewers/completed", "responses": [ { "uuid": "87ac9d40-fcf6-42a4-8278-9c2b2f5c3dd9", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7a5cb53-8e86-4dac-8867-78c8dca0f77b", "documentation": "Gets a list of reviewers that have not completed the review.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/reviewers/uncompleted", "responses": [ { "uuid": "b7f188a8-0e54-4390-b025-65b92fb8b261", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3abb902a-085d-45c1-b2dc-c1712ab12065", "documentation": "Removes the reviewer from the review.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id/reviewers/:username", "responses": [ { "uuid": "1acc4119-5ad4-4c11-b7f1-943d1077060e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0c153049-9527-4469-93de-e0a2265c71e8", "documentation": "Returns a list of all the items in a review.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/reviewitems", "responses": [ { "uuid": "2f0e0ea9-0002-40ac-95d6-c7e230a21b39", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "921741a3-da72-4806-af90-3af4e88a6b12", "documentation": "Add the changes between two files in a fisheye repository to the review.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/reviewitems", "responses": [ { "uuid": "6f569f23-54b5-4b9b-aa93-082728dc1cf3", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4ba2b419-7212-48cf-853e-f6a38f2eb5b8", "documentation": "Adds the given review item to the review. This will always create a new review item, even if there is an existing\n one with the same data in the review (in which case the existing item will be replaced).", "method": "post", "endpoint": "rest-service/reviews-v1/:id/reviewitems/details", "responses": [ { "uuid": "eb36aa79-3994-4c44-a14b-5545eda90353", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d7b77008-59c5-4918-83ef-930b9ea9a620", "documentation": "Adds a review item for each of the supplied crucibleRevisionData elements.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/reviewitems/revisions", "responses": [ { "uuid": "0a097925-239a-4fe8-b769-bf28f9ab88ab", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "04737f13-3936-4ec6-bbf9-9b29d77750da", "documentation": "Removes an item from a review.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId", "responses": [ { "uuid": "ae49e9ca-13cf-4f4c-9809-825f63eb31f1", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "12b10217-a67e-45ab-91d8-cae736f658d7", "documentation": "Returns detailed information for a specific review item.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId", "responses": [ { "uuid": "87960955-a93f-45c9-b771-764bbb354638", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2d705f7c-7e93-4265-8c3e-9c86792d770c", "documentation": "", "method": "get", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId/comments", "responses": [ { "uuid": "a068f22e-f15e-4b33-a3c6-3b597b4bfb85", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "006223d7-a73f-4a97-bfd5-6e131fb8c1f7", "documentation": "This call includes the repsonse header that contains the URL of the newly created entity.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId/comments", "responses": [ { "uuid": "54c3a8f0-fd2d-43fc-8f75-41e571d73c89", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e42705a3-d690-4687-9da4-a723ea6a0c42", "documentation": "Sets the review item specified by itemId with the given reviewItem. The old review item is discarded. Can only\n perform this operation if the old review item specified by itemId can be deleted. The old review item's permId is\n not changed.", "method": "put", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId/details", "responses": [ { "uuid": "ca604fb2-c5be-4f3e-a516-c20d8c0953c2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b8ea583-296d-4162-8ba6-8c3776e5638c", "documentation": "Removes the revisions given from the review item in the review specified by the id. If the review item has no\n more revisions left, it is automatically deleted.", "method": "delete", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId/revisions", "responses": [ { "uuid": "5f566177-0da6-41cb-822f-49cfbb69907c", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "46dce7ac-9b23-4cf3-bd4a-e9c5ef839994", "documentation": "Adds the given list of revisions to the supplied review item, merging if required. For example, if the review\n item for contains revisions 3 to 6, and if:", "method": "post", "endpoint": "rest-service/reviews-v1/:id/reviewitems/:riId/revisions", "responses": [ { "uuid": "5b230d88-2d14-4e97-8dac-36aa857c8cfb", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "479c21b6-80a1-4ef4-aba7-dcf6b5b217a1", "documentation": "Change the state of a review by performing an action on it.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/transition", "responses": [ { "uuid": "1e0d8a63-7457-4c5f-b86e-8e591dfc51f2", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6c6a5d86-4685-46cf-8d9f-82558108fc67", "documentation": "Get a list of the actions which the current user can perform on this\n review, given its current state and the user's permissions.", "method": "get", "endpoint": "rest-service/reviews-v1/:id/transitions", "responses": [ { "uuid": "211de177-d8e5-4844-b09b-04687530be06", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "344a0980-f564-4592-b714-74011bb193dd", "documentation": "Uncompletes the review for the current user.", "method": "post", "endpoint": "rest-service/reviews-v1/:id/uncomplete", "responses": [ { "uuid": "04bd9cf5-1dba-4e7c-af9a-5bca5f9e6b0e", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "836b8d08-9337-442b-b452-f3a36ea68a07", "documentation": "Search for reviews where the name, description, state or permaId contain the specified term.", "method": "get", "endpoint": "rest-service/search-v1/reviews", "responses": [ { "uuid": "49809e07-232c-43c8-a600-2b98fa5d9782", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "51142ad8-9369-466d-b493-23ea610e35af", "documentation": "Get a list of all reviews that have been linked to the specified JIRA issue key.", "method": "get", "endpoint": "rest-service/search-v1/reviewsForIssue", "responses": [ { "uuid": "9840dd3f-d3da-48ab-b476-d0db127518ea", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2cce09d3-c5c4-459f-938c-b509cad6f69a", "documentation": "Get a list of all the users. You can also ask for a set of users.", "method": "get", "endpoint": "rest-service/users-v1", "responses": [ { "uuid": "66e2ca9a-3d9b-4bf8-82b1-acae7b212f9a", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0bbbb0d4-3aed-42a9-b564-d4b6baae0427", "documentation": "Returns the user details of the user mapped to a committer in a repository.", "method": "get", "endpoint": "rest-service/users-v1/:repository/:username", "responses": [ { "uuid": "acc473bd-2668-4c3c-9b89-1d9af01d3403", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ffc7a6eb-e5df-42a3-98b5-2e2b96b920a8", "documentation": "Returns the user's profile details.", "method": "get", "endpoint": "rest-service/users-v1/:username", "responses": [ { "uuid": "c6aebeef-54a8-4ca0-b946-96138ce628fe", "body": "", "latency": 0, "statusCode": 200, "label": "Successful Response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "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": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "707c6d67-f691-4de6-8e8d-75a1698f7d1f" }, { "type": "route", "uuid": "2b299adb-adda-4f85-aa0e-b2b0a9fc137b" }, { "type": "route", "uuid": "140de25d-fce7-4b41-8990-bbeefeef127a" }, { "type": "route", "uuid": "cbc66c06-d0f5-4098-b722-b6b8de6bcc05" }, { "type": "route", "uuid": "1455bdf0-acc2-47a7-9fba-9a4246035365" }, { "type": "route", "uuid": "fff7a655-e220-44c6-ac49-77e8705e21a9" }, { "type": "route", "uuid": "b43f1dc3-7669-443f-b8c2-b26df133f904" }, { "type": "route", "uuid": "82d56fef-4d86-48d9-8cc0-03d6e994701a" }, { "type": "route", "uuid": "12f3b11b-5139-49f5-bddf-6f9828fafc74" }, { "type": "route", "uuid": "c5430ad9-95a7-4042-94ba-f54888c03fab" }, { "type": "route", "uuid": "9a389f81-30f5-418b-8061-a84fe09ff19f" }, { "type": "route", "uuid": "a4d45fc1-db7d-48e1-b614-b576be6e8061" }, { "type": "route", "uuid": "1b9c4e7d-d612-4b10-9c9b-96ca10b1ff73" }, { "type": "route", "uuid": "3cde55c1-9759-44b7-936e-d500a09ddf01" }, { "type": "route", "uuid": "59d3e003-e0d7-4a5b-b881-12c0bb3afe02" }, { "type": "route", "uuid": "830915e1-f50b-4dd8-aaca-4b644aedf98f" }, { "type": "route", "uuid": "5391b408-9561-4029-a8a1-417d0c82ee38" }, { "type": "route", "uuid": "6f3b239f-c229-4d90-98b6-28d2cda254dc" }, { "type": "route", "uuid": "fff25ff6-30e3-4f29-964e-50bb4fd99798" }, { "type": "route", "uuid": "e937803f-5127-4db7-9f15-c5d25b753f37" }, { "type": "route", "uuid": "8c413738-85db-498e-9844-fb6b7027351e" }, { "type": "route", "uuid": "39dbc8f3-8326-491d-b008-3e97f05c6e26" }, { "type": "route", "uuid": "201fadb3-b9f3-452e-ad52-807db855da09" }, { "type": "route", "uuid": "d960913e-4585-4a71-bdaf-dd844fb566e5" }, { "type": "route", "uuid": "d6035d23-1e07-4dd2-91de-3a17726810de" }, { "type": "route", "uuid": "4acf5db1-2950-44a7-862e-9f858cbf1499" }, { "type": "route", "uuid": "c35de7fe-7083-4b64-bfdd-4dcd9b7acd7a" }, { "type": "route", "uuid": "ba22130f-6bca-4f92-92c8-3c48ffcabeec" }, { "type": "route", "uuid": "3f1379a0-201e-4761-8e97-0545b6d36067" }, { "type": "route", "uuid": "2cd2a269-e430-4b2e-aadd-c0f10037b4d9" }, { "type": "route", "uuid": "67345c01-9b2d-419d-8bce-bc04bfb747f9" }, { "type": "route", "uuid": "5b639fce-ed37-420f-a426-cae4af62fb3f" }, { "type": "route", "uuid": "b74e45d9-4a8b-4759-bb39-4d698fbcc21d" }, { "type": "route", "uuid": "81fcc3ec-25c8-42d4-b20a-776bde0bb515" }, { "type": "route", "uuid": "29b58461-19b6-48f3-9238-cb17532a937e" }, { "type": "route", "uuid": "93113402-6338-454c-963b-4b7193df7db7" }, { "type": "route", "uuid": "63e6a13d-c910-4993-b7a0-b4b302121b02" }, { "type": "route", "uuid": "ad232490-e1ca-4b4d-afca-b5d322dff5d4" }, { "type": "route", "uuid": "0fe97876-f9e6-493e-a5d3-0738bec8368c" }, { "type": "route", "uuid": "edc01c8b-6f0c-4983-a904-782f3dac3604" }, { "type": "route", "uuid": "2a55e37a-7a8d-4d16-80f3-ee1bca054eb4" }, { "type": "route", "uuid": "21f21864-b7b8-4cfc-bc25-90cf4582dd4b" }, { "type": "route", "uuid": "d5401c7b-5b97-4385-923c-7fc43d54d56c" }, { "type": "route", "uuid": "fa5b859c-bfec-4041-a65c-8bc1ddd21d90" }, { "type": "route", "uuid": "d0ab0fbd-20fb-4c7a-b053-09248af42584" }, { "type": "route", "uuid": "7d4dfc04-098e-4b04-81e7-6bf0570de4a0" }, { "type": "route", "uuid": "c4c49bf1-65de-4777-be32-83cf5e85c48b" }, { "type": "route", "uuid": "a49e24f6-bcc0-40fd-ae35-07e5c3784622" }, { "type": "route", "uuid": "ac6424e7-9268-4370-b3df-79eaf7180826" }, { "type": "route", "uuid": "776a25f8-cc98-433f-8cc6-402c4ffe2866" }, { "type": "route", "uuid": "8cca134e-1bb8-47b2-acb4-ae431b00aec0" }, { "type": "route", "uuid": "18bf2372-56fa-496f-8794-9ce8ab4669b7" }, { "type": "route", "uuid": "7bc1b110-28ca-477c-a198-b636a2344bbb" }, { "type": "route", "uuid": "4cbe273e-1c86-4aff-bced-fd30f78a6557" }, { "type": "route", "uuid": "a915bbf5-4916-4911-80b9-ab170a9eabb5" }, { "type": "route", "uuid": "f48197c0-533d-40e6-8b57-4c6b0e9d84ae" }, { "type": "route", "uuid": "22434259-cd18-4dad-bcee-96ebc3b5b542" }, { "type": "route", "uuid": "2d62c783-2a02-4acb-8c16-98d6b5c81396" }, { "type": "route", "uuid": "d7a5cb53-8e86-4dac-8867-78c8dca0f77b" }, { "type": "route", "uuid": "3abb902a-085d-45c1-b2dc-c1712ab12065" }, { "type": "route", "uuid": "0c153049-9527-4469-93de-e0a2265c71e8" }, { "type": "route", "uuid": "921741a3-da72-4806-af90-3af4e88a6b12" }, { "type": "route", "uuid": "4ba2b419-7212-48cf-853e-f6a38f2eb5b8" }, { "type": "route", "uuid": "d7b77008-59c5-4918-83ef-930b9ea9a620" }, { "type": "route", "uuid": "04737f13-3936-4ec6-bbf9-9b29d77750da" }, { "type": "route", "uuid": "12b10217-a67e-45ab-91d8-cae736f658d7" }, { "type": "route", "uuid": "2d705f7c-7e93-4265-8c3e-9c86792d770c" }, { "type": "route", "uuid": "006223d7-a73f-4a97-bfd5-6e131fb8c1f7" }, { "type": "route", "uuid": "e42705a3-d690-4687-9da4-a723ea6a0c42" }, { "type": "route", "uuid": "1b8ea583-296d-4162-8ba6-8c3776e5638c" }, { "type": "route", "uuid": "46dce7ac-9b23-4cf3-bd4a-e9c5ef839994" }, { "type": "route", "uuid": "479c21b6-80a1-4ef4-aba7-dcf6b5b217a1" }, { "type": "route", "uuid": "6c6a5d86-4685-46cf-8d9f-82558108fc67" }, { "type": "route", "uuid": "344a0980-f564-4592-b714-74011bb193dd" }, { "type": "route", "uuid": "836b8d08-9337-442b-b452-f3a36ea68a07" }, { "type": "route", "uuid": "51142ad8-9369-466d-b493-23ea610e35af" }, { "type": "route", "uuid": "2cce09d3-c5c4-459f-938c-b509cad6f69a" }, { "type": "route", "uuid": "0bbbb0d4-3aed-42a9-b564-d4b6baae0427" }, { "type": "route", "uuid": "ffc7a6eb-e5df-42a3-98b5-2e2b96b920a8" } ] }