REST API - Get Information of Import Task Capture Payload Jobs Request
6 min
api/v1/taskcapture/jobs?offset={offset}\&limit={limit} description returns the information of import task capture payload docid\ mzejnf m9gpbz9uh8rvws jobs url structure \[blueprint uri]/api/v1/taskcapture/jobs?offset={offset}\&limit={limit} offset (optional) defines the paging offset (that is, zer0 based index) at which the results start the request returns an array of jobs info objects in descending order by the jobid property (the latest jobs come first) limit (optional) defines the number of jobs info to retrieve per query the default is 100 supported methods get docid 7hm2r py7e84xk2msf11b http status codes 200 ok – if the pagination parameters, the offset, and the limit, are not provided, and info of all jobs is returned 400 bad request – if the offset or the limit query parameter is invalid 401 unauthorized – the authorization blueprint token is missing, invalid, or expired (in the authorization request header) 206 partial content – the request is successfully fulfilled 416 request range not satisfiable – if the offset query parameter points to a part of a collection that is not available response body contains the array of jobs info the status property is an enumeration and has the following items • 0 – scheduled • 1 – running • 2 – completed • 3 – failed example json example request uri https //production blueprintcloud com/api/v1/taskcapture/jobs response body { "jobinfos" \[ { "jobid" 14, "status" 2, "userid" 12, "userdisplayname" "john smith", "projectid" 1371, "project" "project 1", "submitteddatetime" "2021 10 24t20 02 03 107z", "jobstartdatetime" "2021 10 24t20 13 26 747z", "jobenddatetime" "2021 10 24t20 13 29 553z", "errorcode" null, "message" "the task capture payload has been successfully completed ", "importedartifacts" \[ { "id" 1390, "prefix" "pf", "name" "imported process", "baseartifacttype" "process", "parentid" 1380 } ] }, { "jobid" 13, "status" 3, "userid" 21, "userdisplayname" "glen white", "projectid" 9398, "project" "project 2", "pubmitteddatetime" "2021 10 24t19 58 28 327z", "jobstartdatetime" "2021 10 24t19 58 29 287z", "jobenddatetime" "2021 10 24t20 00 13 38z", "errorcode" 23, "message" "an unexpected error has occurred please try again if the problem continues, contact your administrator " } ]}