Dispatch Service
Job
Get job by job 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 |
| jobId* (path) | Job 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
jobId
JobId
*
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
JobResponseData
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/jobs/{jobId}' \
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 "entityCode": "",
16 "status": "",
17 "jobId": "",
18 "entityType": "",
19 "schemaNamespace": "",
20 "schemaVersion": "",
21 "entityMeta": {
22 "entityType": "",
23 "cassandra": {
24 "fields": {
25 "status": "",
26 "created": {
27 "$db_function": ""
28 }
29 },
30 "key": [
31 ""
32 ]
33 },
34 "schemaVersion": "",
35 "schemaNamespace": "",
36 "kafka": {
37 "topic": "",
38 "keyField": ""
39 },
40 "readStore": false
41 },
42 "jobRef": "",
43 "jobTypeName": "",
44 "jobTypeId": "",
45 "tenantId": "",
46 "start": "",
47 "defaultObjectiveStart": "",
48 "objectives": [
49 {
50 "status": "",
51 "entityType": "",
52 "id": "",
53 "schemaVersion": "",
54 "schemaNamespace": "",
55 "entityMeta": {
56 "entityType": "",
57 "cassandra": {
58 "fields": {
59 "status": "",
60 "created": {
61 "$db_function": ""
62 }
63 },
64 "key": [
65 ""
66 ]
67 },
68 "schemaVersion": "",
69 "schemaNamespace": ""
70 },
71 "objectiveRef": "",
72 "location": {},
73 "contact": {},
74 "timeSlot": {
75 "id": "",
76 "entityType": "",
77 "schemaVersion": "",
78 "schemaNamespace": "",
79 "entityMeta": {
80 "cassandra": {},
81 "schemaVersion": "",
82 "schemaNamespace": "",
83 "entityType": ""
84 },
85 "from": "",
86 "to": ""
87 },
88 "workflowInstance": "",
89 "groupId": "",
90 "next": [
91 {
92 "id": "",
93 "entityType": "",
94 "schemaVersion": "",
95 "schemaNamespace": "",
96 "entityMeta": {
97 "cassandra": {},
98 "schemaVersion": "",
99 "schemaNamespace": "",
100 "entityType": ""
101 },
102 "code": "",
103 "nextObjective": "",
104 "reason": ""
105 }
106 ]
107 }
108 ],
109 "ledger": [
110 {
111 "aggregateRoot": "",
112 "custodyEntityAmount": "",
113 "custodyEntityId": "",
114 "custodyLocationId": "",
115 "entityCode": "",
116 "entityMeta": {
117 "cassandra": {},
118 "entityType": "",
119 "kafka": {
120 "keyField": "",
121 "topic": ""
122 },
123 "keysToParse": [
124 ""
125 ],
126 "lock": {},
127 "primaryKey": [
128 {}
129 ],
130 "readStore": false,
131 "schemaNamespace": "",
132 "schemaVersion": ""
133 },
134 "entityType": "",
135 "id": "",
136 "jobCustodyEntity": "",
137 "jobCustodyType": "",
138 "jobId": "",
139 "schemaNamespace": "",
140 "schemaVersion": "",
141 "tenantId": ""
142 }
143 ],
144 "containers": [
145 ""
146 ],
147 "batchId": "",
148 "jobType": {
149 "name": "",
150 "_event_meta": {},
151 "callback": {
152 "url": "",
153 "meta": {}
154 },
155 "defaultJobWorkflow": ""
156 },
157 "cancelled": false,
158 "subStatus": "",
159 "onHold": false,
160 "customData": {
161 "non_indexed": ""
162 },
163 "orderId": "",
164 "workOrderId": "",
165 "dispatchRef": "",
166 "defaultObjectives": [
167 {
168 "id": "",
169 "objectiveRef": "",
170 "workflow": "",
171 "next": [
172 {
173 "id": "",
174 "code": "",
175 "nextObjective": "",
176 "reason": ""
177 }
178 ],
179 "status": ""
180 }
181 ],
182 "createdAt": "",
183 "createdBy": {
184 "id": "",
185 "name": "",
186 "appId": ""
187 },
188 "updatedAt": "",
189 "updatedBy": {
190 "id": "",
191 "name": "",
192 "appId": ""
193 }
194 }
195}
Updated 03 Aug 2023
Did this page help you?