3 title: NCMP to CPS Proxy API
4 description: NCMP to CPS Proxy API
9 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational:
13 summary: Get resource data from pass-through operational for cm handle
14 description: Get resource data from pass-through operational for given cm handle
15 operationId: getResourceDataOperationalForCmHandle
19 description: "The identifier for a network function, network element, subnetwork\
20 \ or any other cm object by managed Network CM Proxy"
24 - name: resourceIdentifier
26 description: The format of resource identifier depend on the associated DMI
27 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
28 it can really be anything.
36 resourceIdentifier: \parent\child
39 resourceIdentifier: "\\parent\\listElement[key=value]"
42 resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
45 resourceIdentifier: "parent=1,child=abc"
48 description: "Accept parameter for response, if accept parameter is null,\
49 \ that means client can accept any format."
55 - application/yang-data+json
58 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
59 \ in parenthesis'()'."
67 options: "(key1=value1,key2=value2)"
70 options: "(key1=value1,key2=value1/value2)"
73 options: "(key1=10,key2=value2,key3=[val31;val32])"
82 description: Bad Request
86 $ref: '#/components/schemas/ErrorMessage'
88 description: Unauthorized
92 $ref: '#/components/schemas/ErrorMessage'
94 description: Forbidden
98 $ref: '#/components/schemas/ErrorMessage'
100 description: The specified resource was not found
104 $ref: '#/components/schemas/ErrorMessage'
105 /v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
109 summary: Get resource data from pass-through running for cm handle
110 description: Get resource data from pass-through running for given cm handle
111 operationId: getResourceDataRunningForCmHandle
115 description: "The identifier for a network function, network element, subnetwork\
116 \ or any other cm object by managed Network CM Proxy"
120 - name: resourceIdentifier
122 description: The format of resource identifier depend on the associated DMI
123 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
124 it can really be anything.
132 resourceIdentifier: \parent\child
135 resourceIdentifier: "\\parent\\listElement[key=value]"
138 resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
141 resourceIdentifier: "parent=1,child=abc"
144 description: "Accept parameter for response, if accept parameter is null,\
145 \ that means client can accept any format."
151 - application/yang-data+json
154 description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\
155 \ in parenthesis'()'."
163 options: "(key1=value1,key2=value2)"
166 options: "(key1=value1,key2=value1/value2)"
169 options: "(key1=10,key2=value2,key3=[val31;val32])"
178 description: Bad Request
182 $ref: '#/components/schemas/ErrorMessage'
184 description: Unauthorized
188 $ref: '#/components/schemas/ErrorMessage'
190 description: Forbidden
194 $ref: '#/components/schemas/ErrorMessage'
196 description: The specified resource was not found
200 $ref: '#/components/schemas/ErrorMessage'
204 summary: create resource data from pass-through running for cm handle
205 description: create resource data from pass-through running for given cm handle
206 operationId: createResourceDataRunningForCmHandle
210 description: "The identifier for a network function, network element, subnetwork\
211 \ or any other cm object by managed Network CM Proxy"
215 - name: resourceIdentifier
217 description: The format of resource identifier depend on the associated DMI
218 Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
219 it can really be anything.
227 resourceIdentifier: \parent\child
230 resourceIdentifier: "\\parent\\listElement[key=value]"
233 resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
236 resourceIdentifier: "parent=1,child=abc"
239 description: "Content parameter for request, if content parameter is null,\
240 \ default value is application/json."
244 default: application/json
250 application/yang-data+json:
259 description: Bad Request
263 $ref: '#/components/schemas/ErrorMessage'
265 description: Unauthorized
269 $ref: '#/components/schemas/ErrorMessage'
271 description: Forbidden
275 $ref: '#/components/schemas/ErrorMessage'
277 description: The specified resource was not found
281 $ref: '#/components/schemas/ErrorMessage'
282 /v1/ch/{cm-handle}/modules:
286 summary: Fetch all module references (name and revision) for a given cm handle
287 description: fetch all module references (name and revision) for a given cm
289 operationId: getModuleReferencesByCmHandle
293 description: "The identifier for a network function, network element, subnetwork\
294 \ or any other cm object by managed Network CM Proxy"
306 description: Bad Request
310 $ref: '#/components/schemas/ErrorMessage'
312 description: Unauthorized
316 $ref: '#/components/schemas/ErrorMessage'
318 description: Forbidden
322 $ref: '#/components/schemas/ErrorMessage'
324 description: The specified resource was not found
328 $ref: '#/components/schemas/ErrorMessage'