3 description: NCMP Inventory API
4 title: NCMP Inventory API
13 description: "Register a DMI Plugin with any new, updated or removed CM Handles."
14 operationId: updateDmiPluginRegistration
19 $ref: '#/components/schemas/RestDmiPluginRegistration'
24 description: No Content
29 status: 400 BAD_REQUEST
30 message: Bad request error message
31 details: Bad request error details
33 $ref: '#/components/schemas/ErrorMessage'
34 description: Bad Request
40 message: Unauthorized error message
41 details: Unauthorized error details
43 $ref: '#/components/schemas/ErrorMessage'
44 description: Unauthorized
50 message: Forbidden error message
51 details: Forbidden error details
53 $ref: '#/components/schemas/ErrorMessage'
54 description: Forbidden
59 failedCreatedCmHandles:
60 - cmHandle: my-cm-handle-01
62 errorText: Unknown error. <error-details>
63 - cmHandle: my-cm-handle-02
65 errorText: cm-handle already exists
66 - cmHandle: my-cm-handle-03
68 errorText: cm-handle has an invalid character(s) in id
69 failedUpdatedCmHandles:
70 - cmHandle: my-cm-handle-01
72 errorText: Unknown error. <error-details>
73 - cmHandle: my-cm-handle-02
75 errorText: cm-handle does not exist
76 - cmHandle: my-cm-handle-03
78 errorText: cm-handle has an invalid character(s) in id
79 failedRemovedCmHandles:
80 - cmHandle: my-cm-handle-01
82 errorText: Unknown error. <error-details>
83 - cmHandle: my-cm-handle-02
85 errorText: cm-handle does not exists
86 - cmHandle: my-cm-handle-03
88 errorText: cm-handle has an invalid character(s) in id
90 $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
91 description: Partial or Complete failure. The error details are provided
92 in the response body and all supported error codes are documented in the
94 summary: DMI notifies NCMP of new CM Handles
96 - network-cm-proxy-inventory
99 description: Get all cm handle IDs for a registered DMI plugin
100 operationId: getAllCmHandleIdsForRegisteredDmi
102 - description: dmi-plugin-identifier
104 name: dmi-plugin-identifier
107 example: my-dmi-plugin
123 message: Unauthorized error message
124 details: Unauthorized error details
126 $ref: '#/components/schemas/ErrorMessage'
127 description: Unauthorized
133 message: Forbidden error message
134 details: Forbidden error details
136 $ref: '#/components/schemas/ErrorMessage'
137 description: Forbidden
143 message: Internal Server Error
144 details: Internal Server Error occurred
146 $ref: '#/components/schemas/ErrorMessage'
147 description: Internal Server Error
148 summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
149 \ data plugin, DMI model plugin)"
151 - network-cm-proxy-inventory
154 description: "Query and get CMHandleIds for additional properties, public properties\
155 \ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)."
156 operationId: searchCmHandleIds
161 $ref: '#/components/schemas/CmHandleQueryParameters'
177 message: Unauthorized error message
178 details: Unauthorized error details
180 $ref: '#/components/schemas/ErrorMessage'
181 description: Unauthorized
187 message: Forbidden error message
188 details: Forbidden error details
190 $ref: '#/components/schemas/ErrorMessage'
191 description: Forbidden
197 message: Internal Server Error
198 details: Internal Server Error occurred
200 $ref: '#/components/schemas/ErrorMessage'
201 description: Internal Server Error
202 summary: Query for CM Handle IDs
204 - network-cm-proxy-inventory
207 dmiPluginIdentifierInQuery:
208 description: dmi-plugin-identifier
210 name: dmi-plugin-identifier
213 example: my-dmi-plugin
218 description: No Content
223 status: 400 BAD_REQUEST
224 message: Bad request error message
225 details: Bad request error details
227 $ref: '#/components/schemas/ErrorMessage'
228 description: Bad Request
234 message: Unauthorized error message
235 details: Unauthorized error details
237 $ref: '#/components/schemas/ErrorMessage'
238 description: Unauthorized
244 message: Forbidden error message
245 details: Forbidden error details
247 $ref: '#/components/schemas/ErrorMessage'
248 description: Forbidden
254 message: Internal Server Error
255 details: Internal Server Error occurred
257 $ref: '#/components/schemas/ErrorMessage'
258 description: Internal Server Error
260 RestDmiPluginRegistration:
263 - cmHandle: my-cm-handle
264 alternateId: my-alternate-id
265 publicCmHandleProperties:
269 moduleSetTag: my-module-set-tag
271 - cmHandle: my-cm-handle
272 alternateId: my-alternate-id
273 publicCmHandleProperties:
277 moduleSetTag: my-module-set-tag
280 - cmHandle: my-cm-handle
281 alternateId: my-alternate-id
282 publicCmHandleProperties:
286 moduleSetTag: my-module-set-tag
288 - cmHandle: my-cm-handle
289 alternateId: my-alternate-id
290 publicCmHandleProperties:
294 moduleSetTag: my-module-set-tag
296 dmiPlugin: my-dmi-plugin
297 dmiModelPlugin: my-dmi-model-plugin
303 moduleSetTag: my-module-set-tag
304 dmiDataPlugin: my-dmi-data-plugin
312 example: my-dmi-plugin
316 example: my-dmi-data-plugin
320 example: my-dmi-model-plugin
324 $ref: '#/components/schemas/RestInputCmHandle'
328 $ref: '#/components/schemas/RestInputCmHandle'
339 $ref: '#/components/schemas/UpgradedCmHandles'
343 cmHandle: my-cm-handle
344 alternateId: my-alternate-id
345 publicCmHandleProperties:
349 moduleSetTag: my-module-set-tag
353 example: my-cm-handle
356 additionalProperties:
360 publicCmHandleProperties:
361 additionalProperties:
366 example: my-module-set-tag
375 example: my-alternate-id
380 RestCmHandleProperties:
381 additionalProperties:
391 moduleSetTag: my-module-set-tag
403 example: my-module-set-tag
418 DmiPluginRegistrationErrorResponse:
420 failedCreatedCmHandles:
422 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
424 failedUpdatedCmHandles:
426 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
428 failedRemovedCmHandles:
430 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
432 failedUpgradeCmHandles:
434 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
437 CmHandlerRegistrationErrorResponse:
440 example: my-cm-handle
446 example: Unknown error. <error-details>
449 CmHandleQueryParameters:
451 cmHandleQueryParameters:
452 - conditionParameters:
453 - key: conditionParameters
454 - key: conditionParameters
455 conditionName: conditionName
456 - conditionParameters:
457 - key: conditionParameters
458 - key: conditionParameters
459 conditionName: conditionName
463 - moduleName: my-module
464 - moduleName: my-module
467 - moduleName: my-module
468 - moduleName: my-module
470 cmHandleQueryParameters:
472 $ref: '#/components/schemas/ConditionProperties'
476 description: "not necessary, it is just for backward compatibility"
478 $ref: '#/components/schemas/OldConditionProperties'
480 title: Cm Handle query parameters for executing cm handle search
485 - key: conditionParameters
486 - key: conditionParameters
487 conditionName: conditionName
493 additionalProperties:
497 OldConditionProperties:
502 - moduleName: my-module
503 - moduleName: my-module
509 $ref: '#/components/schemas/ModuleNameAsJsonObject'
511 ModuleNameAsJsonObject:
513 moduleName: my-module