openapi: 3.0.3
info:
description: SupportAdds datajobs through one or more subjob for each DMI and Data Producer
Identifier combinationsubjob capabilities for DCM
title: NCMP Data Subjob API
version: 1.0.0
servers:
- url: /dmi
tags:
- description: DMI plugin rest apis
name: dmi-datajob
paths:
/v1/dataJobdataJobRead/{requestId}:
post:
description: Create a read request
operationId: createReadRequestreadDataJob
parameters:
- description: Identifier for the overall Datajob$ref: '#/components/parameters/requestIdInPath'
requestBody:
explodedescription: Operation falsebody
incontent:
path
name: requestIdapplication/3gpp-json-patch+json:
required: true
schema:
schema:
example$ref: some-identifier
'#/components/schemas/SubjobReadRequest'
tags:
type: string
- dmi-datajob
styleresponses:
simple
requestBody"200":
content: description: Response for subjob
application/3gpp-json-patch+jsoncontent:
schemaapplication/json:
$ref: '#/components/schemas/SubjobRequest'schema:
description: Operation body
responsestype: object
"200":
contentproperties:
application/json:
dataProducerJobId:
schema:
$ref: '#/components/schemas/createReadRequest_200_response'type: string
description: Response for subjob
tagsdescription:
The data - dmi-datajob
components:job ID.
parameters/v1/dataJobWrite/{requestId}:
requestIdInPathpost:
description: IdentifierCreate fora theread overall Datajobrequest
explodeoperationId: falsewriteDataJob
inparameters: path
name: requestId
- required$ref: true'#/components/parameters/requestIdInPath'
schemarequestBody:
exampledescription: Operation some-identifierbody
typecontent:
string
style: simple
schemasapplication/3gpp-json-patch+json:
SubjobRequest:
propertiesschema:
dataAcceptType:
$ref: '#/components/schemas/SubjobWriteRequest'
descriptiontags: Defines
the data response accept type
- dmi-datajob
example: application/vnd.3gpp.object-tree-hierarchical+jsonresponses:
type: string"200":
dataContentType:
description: Response for subjob
description: Defines the data request content:
type
example: application/3gpp-json-patch+json
json:
typeschema:
string
dataProducerId:
type: object
description: ID of the producer registered by DMI for the alternateIds inproperties:
the operations in this requestdataProducerJobId:
example: my-data-producer-identifier
type: string
data:
$ref: '#/components/schemas/SubjobRequest_data' description: The data job ID.
components:
parameters:
requiredrequestIdInPath:
-description: datarequestId
-in: dataProducerIdpath
typename: objectrequestId
ReadOperation required: true
exampleschema:
opexample: readrequestId
operationIdtype: 1string
schemas:
path: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=2SubjobReadRequest:
attributestype: userLabelobject
scoperequired:
scopeTyp: BASE_ONLY- dataProducerId
items:
$ref: '#/components/schemas/ReadOperation_inner'- data
typeproperties: array
WriteOperation:
exampledataAcceptType:
op: add
path: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=1/EUtraNetwork=1/EUtranFrequency=12 example: application/vnd.3gpp.object-tree-hierarchical+json
value:
idtype: 12string
attributesdataContentType:
userLabel: label12example: application/3gpp-json-patch+json
items:
type: string
$ref: '#/components/schemas/WriteOperation_inner'
typedataProducerId: array
CmHandleProperties:
typeexample: objectmy-data-producer-identifier
Resource:
propertiestype: string
iddata:
description$ref: Identifier of the resource object'#/components/schemas/ReadOperation'
SubjobWriteRequest:
exampletype: resource-identifierobject
typerequired:
string
- attributes:dataProducerId
- data
additionalProperties:
properties:
example: "userLabeldataAcceptType: label11"
typeexample: stringapplication/vnd.3gpp.object-tree-hierarchical+json
descriptiontype: Keystring
value map representing the objects class attributes anddataContentType:
valuesexample: application/3gpp-json-patch+json
type: objectstring
type: object
ActionParametersdataProducerId:
additionalProperties:
typeexample: string
description: The input of the action in the form of key value pairs
my-data-producer-identifier
type: string
typedata: object
Object:
type$ref: object'#/components/schemas/WriteOperation'
createReadRequest_200_responseReadOperation:
example:
dataProducerJobIdop: dataProducerJobIdread
propertiesoperationId: 1
dataProducerJobId:
path: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=2
attributes: userLabel
description: The data job ID.scope:
typescopeTyp: stringBASE_ONLY
type: objectarray
SubjobRequest_data items:
oneOf type: object
- $refrequired: '#/components/schemas/ReadOperation'
- $ref: '#/components/schemas/WriteOperation'
path
ReadOperation_inner:
- properties:op
pathproperties:
description: Defines the resource on which operation is executed
path:
example: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003
type: string
op:
description: Describes theexample: operationread
to execute
exampletype: readstring
typeoperationId: string
operationId:
example: 1
description: Unique identifier for the operation within thetype: requeststring
exampleattributes:
"1"
type: stringarray
attributes:
items:
description: This parameter specifies the attributes of the scopedexample: resourcescellId
that aretype: returnedstring
itemsfields:
exampletype: cellIdarray
typeitems:
string
type: arraystring
fieldsfilter:
description example: This parameter specifies the attribute fields of the scoped
NRCellDU/attributes/administrativeState==LOCKED
type: string
resources that are returnedscopeType:
items: example: BASE_ONLY
type: string
typescopeLevel:
array
filterexample: 0
descriptiontype: integer
This parameter is used to filter the scoped Managed Objects.moduleSetTag:
example: Only Managed Objects passing the filter criteria will be fetched
my-module-set-tag
type: string
example: NRCellDU/attributes/administrativeState==LOCKED
cmHandleProperties:
type: string
$ref: '#/components/schemas/CmHandleProperties'
scopeTypeWriteOperation:
example:
description: ScopeType selects MOsop: dependingadd
on relationships with Base
path: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003/GNBCUCPFunction=1/EUtraNetwork=1/EUtranFrequency=12
Managed Objectvalue:
exampleid: BASE_ONLY12
typeattributes: string
scopeLevel:
userLabel: label12
description: Only used whentype: thearray
scope type is BASE_NTH_LEVEL to specifyitems:
type: object
amount of levels to searchrequired:
example:- 0path
type:- integerop
moduleSetTagproperties:
descriptionpath: Module
set identifier
example: my-module-set-tag
SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003
type: string
cmHandleProperties:
type: objectop:
required:
-example: opadd
- path
type: objectstring
WriteOperation_inner_value:
descriptionoperationId:
Value dependent on the op specified. Resource for an add.example: Object1
for a replace. ActionParameters for an action.type: string
oneOf:
- $ref: '#/components/schemas/Resource'
value:
- $ref: '#/components/schemas/ActionParameters'
- $reftype: '#/components/schemas/Object'object
type: object
WriteOperation_inneroneOf:
properties:
- path:
$ref: '#/components/schemas/Resource'
description: Defines- the resource on which operation is executed
$ref: '#/components/schemas/ActionParameters'
- example$ref: SubNetwork=Europe/SubNetwork=Ireland/MeContext=NR03gNodeBRadio00003/ManagedElement=NR03gNodeBRadio00003'#/components/schemas/Object'
CmHandleProperties:
type: stringobject
Resource:
optype: object
properties:
description: Describes the operation to executeid:
example: addresource-identifier
type: string
operationIdattributes:
descriptiontype: object
Unique identifier for the operation within the requestadditionalProperties:
example: 'userLabel: "1"
label11'
type: string
valueActionParameters:
$ref: '#/components/schemas/WriteOperation_inner_value'type: object
requiredadditionalProperties:
- op
type: string
- pathObject:
type: object
| 