...
| Name | Description | Type | Mandatory |
|---|---|---|---|
| path | It is a unique identifier of a managed object (MO) on a network element. | String | Y |
| op | Describes the operation to execute. The value can be: "add": creates a new MO with the id and attributes given in the value | String | Y |
| operationId | Unique identifier of the operation within the request | Integer | N |
| value | NA if op == remove Resource if op == add Object if op == replace Object ActionParameters if op == action | Object | N |
Resource
| Name | Description | Type | Mandatory |
|---|---|---|---|
| id | Identifier of the resource object | String | N |
| attributes | Attributes object whose members are the class attributes and values. The object contains key/value map where:
| Object | N |
ActionParameters
| Name | Description | Type | Mandatory |
|---|---|---|---|
| input | The input of the action. Key value pairs. | Object | N |
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 |
...
Path: /dmi/v1/dataJob/{requestId}/subJob
DMI Data SubJob read request
...
| Name | Description | Type | Mandatory |
|---|---|---|---|
| path | It is a unique identifier of a managed object (MO) on a network element. | String | Y |
| op | Describes the operation to execute. The value can be: "read" | String | Y |
| operationId | Unique identifier of the operation within the request | Integer | N |
| attributes | This parameter specifies the attributes of the scoped resources that are returned. | List of String | N |
| fields | This parameter specifies the attribute fields of the scoped resources that are returned. This should be used if an attribute is a struct and only a subset of its fields should be returned. | List of String | N |
| filter | The parameter is used to filter the scoped Managed Objects. Only Managed Objects passing the filter criteria will be fetched. | List of String | N |
| scopeType | ScopeType selects MOs depending on relationships with Base Managed Object. | enum[BASE_ONLY, BASE_ALL, BASE_NTH_LEVEL, BASE_SUBTREE] | N |
| scopeLevel | Only used when the scope type is BASE_NTH_LEVEL | Integer | N |
| moduleSetTag | Module set identifier | String | Y |
| privateProperties | CMHandle private properties for the alternateID in the path. | Map | Y |
Response
Status code: 200 - OK
| Name | Description | Type | Mandatory |
|---|---|---|---|
| subJobIddataProducerJobId | The ID of the created job by the data producer. | String | Y |
...
Path: /dmi/v1/dataJob/{requestId}/subJobdataProducerJob/{subJobIDdataProducerJobId}/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 |
subJobIddataProducerJobId | 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 |
...
Path: /dmi/v1/dataJob/{requestId}/subjobdataProducerJob/{subJobIddataProducerJobId}/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 |
subJobIddataProducerJobId | 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:Status code: 204
WRITE
Status Code: 200 - Ok
Data part of the message
READ
Status Code: 200 - Ok
{
resulturi: <ncmp-internal-topic>
}
Examples from DCM Study
DataJob Read request (rAPP -> DCM)
...