Page Comparison

...

Method: POST

Path: /dmi/v1/dataJob/{requestId}readJob

DMI Data SubJob read READ request

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
requestId	Identifier for the overall Datajob	Pathrequest body	String	Y
data	List of operations to be executed.	request body	List of DMI3gppReadOperation	Y

...

Name	Description	Location	Type	Mandatory
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
subjobIddataProducerJobID	ID of the specific subjobthe job created by the data producer	response body	String	Y

DMI Data SubJob write requestWRITE request

Method: POST

Path: /dmi/v1/writeJob

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
requestId	Identifier for the overall Datajob	Pathrequest body	String	Y
data	List of operations to be executed.	request body	List of DMI3gppWriteOperation	Y

DMI3gppWriteOperation

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).	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	Y
privateProperties	CMHandle private properties for the alternateID in the path.	Map	Y

...

Name	Description	Location	Type	Mandatory
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
subjobIddataProducerJobId	ID of the specific subjobthe job created by the data producer	response body	String	Y

Data subjob status check (NCMP → DMI)

Request:

Method: GET

Path: /dmi/v1/writeJob/dataJobdataProducer/{requestIddataProducerd}/dataProducerJob/{dataProducerJobIddataProducerdJobId}/status?dataProducerId={dataProducerId}

Name	Description	Location	Type	Mandatory
dataProducerId	ID of the producer registered by DMI for the alernateIDs in the operations in this request.	Query	String	Y	requestId	Identifier for the overall Datajob	Path	String	Y
dataProducerJobId	Identifier of the job created by the data producer.	Path	String	Y

...

Request:

Method: GET

Path: /dmi/v1/writeJob/dataProducer/{dataProducerd}/dataProducerJob/{dataProducerdJobId}/result?destination={destination}

...

Versions Compared

Old Version 14

New Version 15

Key

Data subjob status check (NCMP → DMI)