Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescriptionTypeMandatory
id

Identifier of the resource object

StringN
attributes

Attributes object whose members are the class attributes and values. The object contains key/value map where:

  • key is the attribute name
  • value is the attribute value
ObjectN

ActionParameters

NameDescriptionTypeMandatory
input

The input of the action. Key value pairs.

ObjectN

Response

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

...

Response

Status code: 200 - OK

NameDescriptionLocationTypeMandatory
dataProducerJobIdThe ID of the created job by the data producer.response bodyStringY

Data subjob status check (NCMP → DMI)

...

READ

Status Code: 200 - Ok{
     resulturi: <ncmp-internal-topic>
}

NameDescriptionLocationTypeMandatory

resulturi

internal ncmp topic name

response body

String

Y

Examples from DCM Study

DataJob Read request (rAPP -> DCM)

...