...
Name | Description | Type | Mandatory |
jobId | The id of the data job | string | Y |
status | The status of the jobid | enum: [ NOT_STARTED, RUNNING, FINSHED, FAILED, PARTIALLY_FAILED, CANCELLING, CANCELLED ] | Y |
statusuri | Status uri for the jobid. Example: {apiRoot}/ranoam/cm/v1/dataJob/{jobId} | uri | Y |
resultsuri | Result uri for the jobid. Example: {apiRoot}/s3-bucket/{bucketId} | uri | Y |
Data subjob status check (NCMP → DMI)
Request:
Method: GET
Path: /dmi/v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/status
...
dataProducerId
...
ID of the producer registered by DMI for the alernateIDs in the operations in this request.
...
Query
...
String
...
Y
...
requestId
...
Identifier for the overall Datajob
...
Path
...
String
...
Y
...
dataProducerJobId
...
Identifier of the job created by the data producer.
...
Path
...
String
...
Y
Response:
Status code: 200 - OK
...
status
...
Y
Data subjob retrieve result (NCMP → DMI)
Request:
Method: GET
Path: /dmi/v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/result
Parameters:
...
dataProducerId
...
ID of the producer registered by DMI for the alernateIDs in the operations in this request.
...
Query
...
String
...
Y
...
requestId
...
Identifier for the overall Datajob
...
Path
...
String
...
Y
...
dataProducerJobId
...
Identifier of the job created by the data producer.
...
Path
...
String
...
Y
...
destination
...
The destination of the results: Kafka topic name or s3 bucket name. This shall be put into the Kafka message headers returned to NCMP
...
Query
...
String
...
Y
Response:
WRITE
Status Code: 200 - Ok
Data part of the message
READ
Status Code: 200 - Ok
...
resulturi
...
internal ncmp topic name
...
response body
...
String
...
Y
Examples from DCM Study
DataJob Read request (rAPP -> DCM)
...