CPS-2141 Define DMI REST interface for Datajobs

Is the requestId in the southbound request equal to the dataJobId coming in from the northound interfaces? (see writeJob for example)

Can the dataJobId used as the requestId? @Csaba Kocsis 

Aug 1, 2024 

@Csaba Kocsis and @Toine Siebelink  agreed that requestId should be renamed to jobId on all interfaces

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 DMI3gppReadOperation

Y

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

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

N

privateProperties

CMHandle private properties for the alternateID in the path.

Map

N

dataProducerJobId

The ID of the created job by the data producer.

response body

String

Y

dmiPluginName

The target DMI that the job was performed on

response body

String

Y

dataProducerJobID

ID of the job created by the data producer

response body

String

Y

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

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

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
"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

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

N

privateProperties

CMHandle private properties for the alternateID in the path.

Map

N

dataProducerJobId

The ID of the created job by the data producer.

response body

String

Y

dmiPluginName

The target DMI that the job was performed on

response body

String

Y

dataProducerJobId

ID of the job created by the data producer

response body

String

Y

dataProducerId

ID of the producer registered by DMI for the alernateIDs in the operations in this request.

Path

String

Y

dataProducerJobId

Identifier of the job created by the data producer.

Path

String

Y

status

enum that represents the status of the subjob.
Possible values:

response body

enum:
[ NOT_STARTED, RUNNING, FINSHED, FAILED, PARTIALLY_FAILED, CANCELLING, CANCELLED ]

Y

dataProducerId

ID of the producer registered by DMI for the alternateIDs in the operations in this request.

Path

String

Y

dataProducerJobId

Identifier of the job created by the data producer. (not globally unique)

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

resulturi

internal ncmp topic name

response body

String

Y