...
- Define new REST interface :
- Method: POST
- Path: /dmi/v1/writeJobcmwriteJob/{requestId}
Only writeJob required for MVP. Read, Status, Result will be completed in a later iteration.
...
- New Interface DMI-I-02 with document and diagram updates. Both Wiki and RTD
- Define swagger for request/response (additional info for forwarding data job request : moduleSetTag, privateProperties, dataProducerId, requestId dataJobId)
- Agree and implement yaml for this interface
- Stakeholder acceptance of yaml
...
Method: POST
Path: /dmi/v1/readJobcmreadJob
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 | YN |
| privateProperties | CMHandle private properties for the alternateID in the path. | Map | YN |
Response
Status code: 200 - OK
...
Method: POST
Path: /dmi/v1/writeJobcmwriteJob
Name | Description | Location | Type | Mandatory |
|---|---|---|---|---|
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 |
dataJobId | Identifier for the overall Datajob | request body | String | Y |
data | List of operations to be executed. | request body | List of DMI3gppWriteOperation | Y |
...
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 ActionParameters if op == action | Object | N |
| moduleSetTag | Module set identifier | String | YN |
| privateProperties | CMHandle private properties for the alternateID in the path. | Map | YN |
Response
Status code: 200 - OK
...
Method: GET
Path: /dmi/v1/writeJobcmwriteJob/dataProducer/{dataProducerd}/dataProducerJob/{dataProducerdJobId}/status
...
Method: GET
Path: /dmi/v1/writeJobcmwriteJob/dataProducer/{dataProducerd}/dataProducerJob/{dataProducerdJobId}/result?destination={destination}
...