{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/jobs/:uid","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"uid\": \"4f6a3a32-6d57-450d-8b46-44abb3b01994\",\n  \"status\": \"SCHEDULED\",\n  \"serviceUid\": \"4f6a3a32-6d57-450d-8b46-44abb3b12378\",\n  \"jobDate\": \"2017-02-25\",\n  \"startTime\": \"12\",\n  \"endTime\": \"15\",\n  \"notes\": \"Job Details Description of the job to be done\"\n}","name":""},{"name":"","status":400,"language":"text","code":"Orbirental API - Bad request."},{"status":409,"language":"text","code":"Orbirental API - Job not found."}]},"method":"get","examples":{"codes":[]},"params":[{"name":"uid","type":"string","default":"","desc":"The unique ID of the job","required":true,"in":"path","ref":"","_id":"56e75cbb5669091700c5b2b2"}]},"next":{"description":"","pages":[]},"title":"/jobs/:uid","type":"endpoint","slug":"jobsuid","excerpt":"Retrieve the job associated to the provided job unique id.","body":"","updates":[],"order":27,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3367","category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"githubsync":"","createdAt":"2017-05-19T19:31:42.121Z","project":"56e3719a591f620e00bf5095","parentDoc":null,"user":"56e371538b32a10e00f79750","__v":1,"version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"}}

get/jobs/:uid

Retrieve the job associated to the provided job unique id.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
The unique ID of the job

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}