Versions Compared

Key

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

...

  • 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.

...

  1. New Interface DMI-I-02 with document and diagram updates. Both Wiki and RTD
  2. Define swagger for request/response (additional info for forwarding data job request : moduleSetTag, privateProperties, dataProducerId, requestId dataJobId)
  3. Agree and implement yaml for this interface
  4. 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. 
Defines the resource on which operation is executed. Typically could be Fully Distinguished Name (FDN).

StringY
op

Describes the operation to execute. The value can be: "read" 

StringY
operationId

Unique identifier of the operation within the request

IntegerN
attributes

This parameter specifies the attributes of the scoped resources that are returned. 

List of StringN
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 StringN
filter

The parameter is used to filter the scoped Managed Objects. Only Managed Objects passing the filter criteria will be fetched.

List of StringN
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

IntegerN
moduleSetTag

Module set identifier

StringYN
privateProperties

CMHandle private properties for the alternateID in the path.

MapYN

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. 
Defines the resource on which operation is executed. Typically could be Fully Distinguished Name (FDN).

StringY
op

Describes the operation to execute. The value can be:

"add": creates a new MO with the id and attributes given in the value
"replace":  replaces the value of an attribute specified in the path (attribute is separated with a # from the MO path) with the object in the value
"remove": removes the MO given in the path, value is not applicable
"action": executes an MO action in the path (action is separated with a # from the MO path) with the input parameters in the value

StringY
operationId

Unique identifier of the operation within the request

IntegerN
value

NA if op == remove

Resource if op == add

Object if op == replace

ActionParameters if op == action



ObjectN
moduleSetTag

Module set identifier

StringYN
privateProperties

CMHandle private properties for the alternateID in the path.

MapYN


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}

...