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: Forbidden error message
41 details: Forbidden error details
43 $ref: '#/components/schemas/ErrorMessage'
44 description: Forbidden
49 failedCreatedCmHandles:
50 - cmHandle: my-cm-handle-01
52 errorText: Unknown error. <error-details>
53 - cmHandle: my-cm-handle-02
55 errorText: cm-handle already exists
56 - cmHandle: my-cm-handle-03
58 errorText: cm-handle has an invalid character(s) in id
59 failedUpdatedCmHandles:
60 - cmHandle: my-cm-handle-01
62 errorText: Unknown error. <error-details>
63 - cmHandle: my-cm-handle-02
65 errorText: cm-handle does not exist
66 - cmHandle: my-cm-handle-03
68 errorText: cm-handle has an invalid character(s) in id
69 failedRemovedCmHandles:
70 - cmHandle: my-cm-handle-01
72 errorText: Unknown error. <error-details>
73 - cmHandle: my-cm-handle-02
75 errorText: cm-handle does not exists
76 - cmHandle: my-cm-handle-03
78 errorText: cm-handle has an invalid character(s) in id
80 $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
81 description: Partial or Complete failure. The error details are provided
82 in the response body and all supported error codes are documented in the
84 summary: DMI notifies NCMP of new CM Handles
86 - network-cm-proxy-inventory
89 description: Get all cm handle IDs for a registered DMI plugin
90 operationId: getAllCmHandleIdsForRegisteredDmi
92 - description: dmi-plugin-identifier
94 name: dmi-plugin-identifier
97 example: my-dmi-plugin
113 message: Forbidden error message
114 details: Forbidden error details
116 $ref: '#/components/schemas/ErrorMessage'
117 description: Forbidden
123 message: Internal Server Error
124 details: Internal Server Error occurred
126 $ref: '#/components/schemas/ErrorMessage'
127 description: Internal Server Error
128 summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
129 \ data plugin, DMI model plugin)"
131 - network-cm-proxy-inventory
134 description: "Query and get CMHandleIds for additional properties, public properties\
135 \ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)."
136 operationId: searchCmHandleIds
141 $ref: '#/components/schemas/CmHandleQueryParameters'
157 message: Forbidden error message
158 details: Forbidden error details
160 $ref: '#/components/schemas/ErrorMessage'
161 description: Forbidden
167 message: Internal Server Error
168 details: Internal Server Error occurred
170 $ref: '#/components/schemas/ErrorMessage'
171 description: Internal Server Error
172 summary: Query for CM Handle IDs
174 - network-cm-proxy-inventory
177 dmiPluginIdentifierInQuery:
178 description: dmi-plugin-identifier
180 name: dmi-plugin-identifier
183 example: my-dmi-plugin
188 description: No Content
193 status: 400 BAD_REQUEST
194 message: Bad request error message
195 details: Bad request error details
197 $ref: '#/components/schemas/ErrorMessage'
198 description: Bad Request
204 message: Forbidden error message
205 details: Forbidden error details
207 $ref: '#/components/schemas/ErrorMessage'
208 description: Forbidden
214 message: Internal Server Error
215 details: Internal Server Error occurred
217 $ref: '#/components/schemas/ErrorMessage'
218 description: Internal Server Error
220 RestDmiPluginRegistration:
223 - cmHandle: my-cm-handle
224 alternateId: my-alternate-id
225 publicCmHandleProperties:
229 moduleSetTag: my-module-set-tag
231 - cmHandle: my-cm-handle
232 alternateId: my-alternate-id
233 publicCmHandleProperties:
237 moduleSetTag: my-module-set-tag
240 - cmHandle: my-cm-handle
241 alternateId: my-alternate-id
242 publicCmHandleProperties:
246 moduleSetTag: my-module-set-tag
248 - cmHandle: my-cm-handle
249 alternateId: my-alternate-id
250 publicCmHandleProperties:
254 moduleSetTag: my-module-set-tag
256 dmiPlugin: my-dmi-plugin
257 dmiModelPlugin: my-dmi-model-plugin
263 moduleSetTag: my-module-set-tag
264 dmiDataPlugin: my-dmi-data-plugin
272 example: my-dmi-plugin
276 example: my-dmi-data-plugin
280 example: my-dmi-model-plugin
284 $ref: '#/components/schemas/RestInputCmHandle'
288 $ref: '#/components/schemas/RestInputCmHandle'
299 $ref: '#/components/schemas/UpgradedCmHandles'
303 cmHandle: my-cm-handle
304 alternateId: my-alternate-id
305 publicCmHandleProperties:
309 moduleSetTag: my-module-set-tag
313 example: my-cm-handle
316 additionalProperties:
320 publicCmHandleProperties:
321 additionalProperties:
326 example: my-module-set-tag
335 example: my-alternate-id
340 RestCmHandleProperties:
341 additionalProperties:
351 moduleSetTag: my-module-set-tag
363 example: my-module-set-tag
378 DmiPluginRegistrationErrorResponse:
380 failedCreatedCmHandles:
382 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
384 failedUpdatedCmHandles:
386 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
388 failedRemovedCmHandles:
390 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
392 failedUpgradeCmHandles:
394 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
397 CmHandlerRegistrationErrorResponse:
400 example: my-cm-handle
406 example: Unknown error. <error-details>
409 CmHandleQueryParameters:
411 cmHandleQueryParameters:
412 - conditionParameters:
413 - key: conditionParameters
414 - key: conditionParameters
415 conditionName: conditionName
416 - conditionParameters:
417 - key: conditionParameters
418 - key: conditionParameters
419 conditionName: conditionName
423 - moduleName: my-module
424 - moduleName: my-module
427 - moduleName: my-module
428 - moduleName: my-module
430 cmHandleQueryParameters:
432 $ref: '#/components/schemas/ConditionProperties'
436 description: "not necessary, it is just for backward compatibility"
438 $ref: '#/components/schemas/OldConditionProperties'
440 title: Cm Handle query parameters for executing cm handle search
445 - key: conditionParameters
446 - key: conditionParameters
447 conditionName: conditionName
453 additionalProperties:
457 OldConditionProperties:
462 - moduleName: my-module
463 - moduleName: my-module
469 $ref: '#/components/schemas/ModuleNameAsJsonObject'
471 ModuleNameAsJsonObject:
473 moduleName: my-module