REST API - Get Information of Import Task Capture Payload Job Request
6 min
api/v1/taskCapture/jobs/{jobId}Description
Returns the information of a specific Import Task Capture Payload job.
URL Structure
[Blueprint_URI]/api/v1/taskCapture/jobs/{jobId}- jobId: the ID of the Import Task Capture Payload Job.
Supported Methods
- GET
HTTP Status Codes
- 200: OK – the request is successfully fulfilled.
- 400: Bad Request – the jobId URL parameter is invalid (errorCode=180).
- 401: Unauthorized – the Blueprint authorization token is missing, invalid, or expired (in the Authorization request header).
- 404: Not Found – the Import Task Capture Payload job with the specified ID is not found (errorCode=181).
Example
JSON Example
Request URI
https://production.blueprintcloud.com/api/v1/taskCapture/jobs/14Response Body
In the case of the returned 200: OK HTTP status code, contains the job info object.
{ "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, "Nessage": "The Task Capture payload has been successfully completed.", "ImportedArtifacts": [ { "Id": 1390, "Prefix": "PF", "Name": "Imported Process", "BaseArtifactType": "Process", "ParentId": 1380 } ]}In the case of the 400: Bad Request or 404: Not Found HTTP status code, contains the error message.
{ "Message": "The jobId URL parameter is invalid.", "ErrorCode": 180}