...
- Define new REST interface :
- Method: POST
- Path: /dmi/v1/dataJobwriteJob/{requestId}
Only writeJob required for MVP. Read, Status, Result will be completed in a later iteration.
Acceptance Criteria (pending stakeholder agreement):
...
Path: /dmi/v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/status
| Name | Description | Location | Type | Mandatory |
|---|---|---|---|---|
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
| Name | Description | Location | Type | Mandatory |
|---|---|---|---|---|
status | enum that represents the status of the subjob. Possible values: | response body | enum: [ NOT_STARTED, RUNNING, FINSHED, FAILED, PARTIALLY_FAILED, CANCELLING, CANCELLED ] | Y |
Data subjob retrieve result (NCMP → DMI)
...
Path: /dmi/v1/dataJob/{requestId}/dataProducerJob/{dataProducerJobId}/result
Parameters:
| Name | Description | Location | Type | Mandatory |
|---|---|---|---|---|
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
...
READ
Status Code: 200 - Ok
| Name | Description | Location | Type | Mandatory |
|---|---|---|---|---|
resulturi | internal ncmp topic name | response body | String | Y |