...
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
...
This is a mirror of the Datajob read/write request with the added details needed for the DMI plugins. Below you can see the changes for the READ but the same changes are applicable for the WRITE too.
Method: POST
Path: /dmi/v1/dataJob/{requestId}
DMI Data SubJob read request
...
destination
...
The destination of the results. ( e.g. S3 Bucket)
...
Query
...
string
...
N
...
dataaccepttype
...
Define the data response accept type. Passible values:
· application/vnd.3gpp.object-tree-hierarchical+json (default)
· application/vnd.3gpp.object-tree-flat+json
...
request body
...
enum
...
N
...
datacontenttype
...
Define the data request content type. Passible values:
· application/3gpp-json-patch+json (default)
...
request body
...
enum
...
N
...
dataProducerId
...
ID of the producer registered by DMI for the alernateIDs in the operations in this request.
...
request body
...
String
...
Y
...
requestId
...
Identifier for the overall Datajob
...
Path
...
String
...
Y
...
data
...
List of operations to be executed.
...
request body
...
List of DMI3gppReadOperation
...
Y
DMI3gppReadOperation
...
It is a unique identifier of a managed object (MO) on a network element.
Defines the resource on which operation is executed. Typically could be Fully Distinguished Name (FDN).
...
Describes the operation to execute. The value can be: "read"
...
Unique identifier of the operation within the request
...
This parameter specifies the attributes of the scoped resources that are returned.
...
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.
...
The parameter is used to filter the scoped Managed Objects. Only Managed Objects passing the filter criteria will be fetched.
...
ScopeType selects MOs depending on relationships with Base Managed Object.
...
Only used when the scope type is BASE_NTH_LEVEL
...
Module set identifier
...
CMHandle private properties for the alternateID in the path.
...
Response
Status code: 200 - OK
...
Data subjob status check (NCMP → DMI)
...