Versions Compared

Old Version 36

changes.mady.by.user Sourabh Sourabh

Saved on

compared with

New Version 37

changes.mady.by.user Csaba Kocsis

Saved on

Key

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

...

NameDescriptionLocationTypeMandatory

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

data

List of operations to be executed. 

request body

List of 3gppReadOperation

Y

3gppReadOperation

NameDescriptionTypeMandatory
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

Datajob write request

NameDescriptionLocationTypeMandatory

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

data

List of operations to be executed. 

request body

List of 3gppPatchOperation

Y

3gppPatchOperation

NameDescriptionTypeMandatory
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 with the object in the value
"remove"

,
"action",  

: removes the MO given in the path, value is not applicable
"action": executes an MO action (last RDN in the path) with the input parameters in the value

StringY
String
operationId

Unique identifier of the operation

within the requestIntegervalue

within the request

IntegerN
value

NA if op == remove

Resource if op == add

Object if op == replace

Object if op == action



ObjectN

Resource

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

Datajob create (NCMP → DMI)

TO BE UPDATED

Datajob status check (NCMP → DMI)

TO BE UPDATED

Datajob retrieve result (NCMP → DMI)

TO BE UPDATED

...

Examples from DCM Study

DataJob Read request (rAPP -> DCM)

JSON Viewer
width1250
height450
{                 
  "dataaccepttype": "application/vnd.3gpp.object-tree-hierarchical+json",
  "datacontenttype": "application/3gpp-json-patch+json",
  "data": [
    {
      "op": "read",
      "operationId": 1,
      "path": "SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=2",
      "attributes": "userLabel",
      "scope": {
        "scopeType" : "BASE_ONLY"
      }
    },
    {
      "op": "read", 
      "operationId": 2,
      "path": "SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR01gNodeBRadio00001/ManagedElement=NR01gNodeBRadio00001/GNBDUFunction=1",
      "filter": "NRCellDU/attributes/administrativeState==LOCKED"
    },
    {
      "op": "read", 
      "operationId": 3,
      "path": "SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=1",
      "attributes ": "cellId"
    }]
}

Datajob create (NCMP → DMI)

TO BE UPDATED

Datajob status check (NCMP → DMI)

TO BE UPDATED

Datajob retrieve result (NCMP → DMI)

...

Datajob Write request (rAPP -> DCM)
...