{"info":{"_postman_id":"f3447aab-83b7-4ef4-bff0-1ec875794f12","name":"Time to SLA - REST API","description":"

Welcome to the Time to SLA (TTS) app's REST API reference. This page documents the REST resources available to use with the app, along with the expected HTTP response codes and sample requests.

\n

URI Structure

\n

The Time to SLA app uses the URI structure that is appropriate to the structure that Jira presents. The URI in the Next-Gen SLAs REST services is as follows:

\n
https://jira.yourcompany.com/rest/tts-api/1.0\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15299464","collectionId":"f3447aab-83b7-4ef4-bff0-1ec875794f12","publishedId":"Tzsfn5ju","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-08-02T09:17:13.000Z"},"item":[{"name":"/customfields","item":[{"name":"Edit SLA field's included SLAs","id":"510ee563-24b0-4d0a-baa5-4618fe0a2e3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fieldId\": \"customfield_10109\",\n \"fieldConfigId\": 10209,\n \"selectedSlasIds\": [1,2]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2990/jira/rest/tts-api/1.0/customfields/includeSlas","description":"\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeExplanation
fieldIdstringThe ID of the TTS custom field whose included SLAs property you are editing
fieldConfigIdintegerthe configuration ID of the custom field whose included SLAs property you are editing
selectedSlasIdsinteger arraythe ID(s) of the SLA(s) your TTS custom field will have in its \"included SLAs\" property.
\n
\n

Please note: To set the TTS custom field's \"included SLAs\" to include all SLAs, simply set the \"selectedSlasIds\" property to an empty array in the request body.

\n
\n\n","urlObject":{"protocol":"http","port":"2990","path":["jira","rest","tts-api","1.0","customfields","includeSlas"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a5b83cda-3b53-43f7-bc32-36bec7f2e5ba","name":"successful request: setting included SLAs","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fieldId\": \"customfield_10109\",\n \"fieldConfigId\": 10209,\n \"selectedSlasIds\": [1,2]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2990/jira/rest/tts-api/1.0/customfields/includeSlas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"X-AREQUESTID","value":"718x7025x1"},{"key":"X-ASESSIONID","value":"1ileomq"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Seraph-LoginReason","value":"OK"},{"key":"X-AUSERNAME","value":"admin"},{"key":"Cache-Control","value":"no-cache, no-store, no-transform"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 02 Aug 2021 08:58:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"The custom field with id customfield_10109 has been set to include the following SLAs: [1, 2]\",\n \"code\": 0\n}"},{"id":"2056ee63-5499-4c85-8e88-e6edabc15486","name":"successful request: setting included SLAs to all SLAs","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fieldId\": \"customfield_10109\",\n \"fieldConfigId\": 10209,\n \"selectedSlasIds\": []\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2990/jira/rest/tts-api/1.0/customfields/includeSlas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"X-AREQUESTID","value":"721x7026x1"},{"key":"X-ASESSIONID","value":"1ileomq"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Seraph-LoginReason","value":"OK"},{"key":"X-AUSERNAME","value":"admin"},{"key":"Cache-Control","value":"no-cache, no-store, no-transform"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 02 Aug 2021 09:01:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"The custom field with id customfield_10109 has been set to include all SLAs\",\n \"code\": 0\n}"},{"id":"8b335ef8-e777-4fc9-ad9c-528688720a48","name":"unsuccessful request: invalid SLA id","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fieldId\": \"customfield_10109\",\n \"fieldConfigId\": 10209,\n \"selectedSlasIds\": [45]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2990/jira/rest/tts-api/1.0/customfields/includeSlas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"X-AREQUESTID","value":"721x7027x1"},{"key":"X-ASESSIONID","value":"1ileomq"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Seraph-LoginReason","value":"OK"},{"key":"X-AUSERNAME","value":"admin"},{"key":"Cache-Control","value":"no-cache, no-store, no-transform"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 02 Aug 2021 09:01:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Please enter valid SLA ids\",\n \"code\": 0\n}"},{"id":"8ab295da-a06b-4c92-ac67-69e3b152b188","name":"unsuccessful request: invalid/missing customfield id","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fieldConfigId\": 10209,\n \"selectedSlasIds\": [45]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2990/jira/rest/tts-api/1.0/customfields/includeSlas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"X-AREQUESTID","value":"722x7028x1"},{"key":"X-ASESSIONID","value":"1ileomq"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Seraph-LoginReason","value":"OK"},{"key":"X-AUSERNAME","value":"admin"},{"key":"Cache-Control","value":"no-cache, no-store, no-transform"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 02 Aug 2021 09:02:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Please enter a valid custom field id\",\n \"code\": 0\n}"},{"id":"18f9e92e-45d1-47df-8213-91738bf14568","name":"unsuccessful request: invalid/missing customfield config id","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"fieldId\": \"customfield_10109\",\n \"selectedSlasIds\": [1]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:2990/jira/rest/tts-api/1.0/customfields/includeSlas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Apache-Coyote/1.1"},{"key":"X-AREQUESTID","value":"724x7029x1"},{"key":"X-ASESSIONID","value":"1ileomq"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'"},{"key":"X-Seraph-LoginReason","value":"OK"},{"key":"X-AUSERNAME","value":"admin"},{"key":"Cache-Control","value":"no-cache, no-store, no-transform"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"User-Agent"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 02 Aug 2021 09:04:11 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"Please enter a valid field configuration id\",\n \"code\": 0\n}"}],"_postman_id":"510ee563-24b0-4d0a-baa5-4618fe0a2e3e"}],"id":"0c649cdb-1036-4628-913a-31f75285273a","_postman_id":"0c649cdb-1036-4628-913a-31f75285273a","description":""}]}