{"_id":"5de85dbbb0b885003ddf336d","githubsync":"","parentDoc":null,"category":{"_id":"5de85dbbb0b885003ddf3334","pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"project":"56e3719a591f620e00bf5095","__v":19,"version":"5de85dbbb0b885003ddf339f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-12T01:32:11.359Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"user":"56e371538b32a10e00f79750","__v":2,"project":"56e3719a591f620e00bf5095","version":{"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z","categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"Domain","version_clean":"1.5.0","version":"1.5"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-22T22:27:58.949Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"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}","language":"json","status":200,"name":""},{"name":"","code":"Orbirental API - Bad request.","language":"text","status":400},{"code":"Orbirental API - Service not found.","language":"text","status":409}]},"settings":"","auth":"required","params":[{"_id":"59235f547180400f00049011","ref":"","in":"body","required":false,"desc":"","default":"","type":"yyyy-mm-dd","name":"jobDate"},{"_id":"59235f547180400f00049010","ref":"","in":"body","required":false,"desc":"Can be SCHEDULED, CANCELLED, DONE","default":"","type":"string","name":"status"},{"_id":"59235f547180400f0004900f","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"startTime"},{"_id":"59235f547180400f0004900e","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"endTime"},{"_id":"592366328226200f00c55785","ref":"","in":"path","required":true,"desc":"Unique ID of the job","default":"","type":"string","name":"uid"},{"_id":"5adb590394c8e80003644c98","ref":"","in":"body","required":false,"desc":"Description of the job to be done","default":"","type":"string","name":"notes"}],"url":"/jobs/:uid"},"isReference":false,"order":28,"body":"","excerpt":"Edit a job","slug":"jobsuid-1","type":"endpoint","title":"/jobs/:uid"}

put/jobs/:uid

Edit a job

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

uid:
required
string
Unique ID of the job

Body Params

jobDate:
yyyy-mm-dd
status:
string
Can be SCHEDULED, CANCELLED, DONE
startTime:
integer
endTime:
integer
notes:
string
Description of the job to be done

Result Format


User Information

Try It Out

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