Dispatch Service
Job Workflow
Get job workflow by job workflow id
1min
GET
API to get specific job details by job ID. | Header/Path | Description | Type |
|--- |--- |--- |
| X-COREOS-REQUEST-ID* (header) | Unique request ID. | string |
| X-USER-ID* (header) | User ID. | string |
| X-USER-NAME* (header) | User name. | string |
| jobWorkflowId* (path) | Job workflow ID. | string |
*This is required.
HTTP Status Code Summary
| Code | Description |
|---|---|
| 200 - OK | Everything worked as expected. |
| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized | No valid API key provided. |
| 404 - Not Found | The requested resource doesn't exist. |
Path Parameters
jobWorkflowId
JobWorkflowId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
Responses
200
OK
object
error
Error
*
request
Request
*
data
JobWorkflowResponseData
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
404
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
1curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/job-workflows/{jobWorkflowId}' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
400
401
404
1// OK
2{
3 "error": {
4 "code": "",
5 "description": "",
6 "additionalInfo": {}
7 },
8 "request": {
9 "uri": "",
10 "method": "",
11 "queryString": "",
12 "body": {}
13 },
14 "data": {
15 "id": "",
16 "jobWorkflowStatus": "",
17 "entityType": "",
18 "schemaNamespace": "",
19 "schemaVersion": "",
20 "entityMeta": {
21 "entityType": "",
22 "cassandra": {
23 "fields": {
24 "status": "",
25 "created": {
26 "$db_function": ""
27 }
28 },
29 "key": [
30 ""
31 ]
32 },
33 "schemaVersion": "",
34 "schemaNamespace": "",
35 "kafka": {
36 "topic": "",
37 "keyField": ""
38 },
39 "readStore": false,
40 "lock": {
41 "seqNumber": "",
42 "primaryTerm": ""
43 }
44 },
45 "tenantId": "",
46 "name": "",
47 "start": "",
48 "objectives": [
49 {
50 "id": "",
51 "entityType": "",
52 "schemaVersion": "",
53 "schemaNamespace": "",
54 "entityMeta": {
55 "cassandra": {},
56 "schemaVersion": "",
57 "schemaNamespace": "",
58 "entityType": ""
59 },
60 "objectiveRef": "",
61 "workflow": "",
62 "next": [
63 {
64 "id": "",
65 "entityType": "",
66 "schemaVersion": "",
67 "schemaNamespace": "",
68 "entityMeta": {
69 "cassandra": {},
70 "schemaVersion": "",
71 "schemaNamespace": "",
72 "entityType": ""
73 },
74 "code": "",
75 "nextObjective": "",
76 "reason": ""
77 }
78 ]
79 }
80 ],
81 "tag": [
82 {
83 "id": "",
84 "entityType": "",
85 "schemaVersion": "",
86 "schemaNamespace": "",
87 "entityMeta": {
88 "cassandra": {},
89 "schemaVersion": "",
90 "schemaNamespace": "",
91 "entityType": ""
92 },
93 "name": "",
94 "value": ""
95 }
96 ],
97 "createdAt": "",
98 "createdBy": {
99 "id": "",
100 "name": "",
101 "appId": ""
102 },
103 "updatedAt": "",
104 "updatedBy": {
105 "id": "",
106 "name": "",
107 "appId": ""
108 }
109 }
110}
Updated 03 Aug 2023
Did this page help you?