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
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
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 dataProducerIdentifier: my-data-producer-identifier
226 publicCmHandleProperties:
230 moduleSetTag: my-module-set-tag
232 - cmHandle: my-cm-handle
233 alternateId: my-alternate-id
234 dataProducerIdentifier: my-data-producer-identifier
235 publicCmHandleProperties:
239 moduleSetTag: my-module-set-tag
242 - cmHandle: my-cm-handle
243 alternateId: my-alternate-id
244 dataProducerIdentifier: my-data-producer-identifier
245 publicCmHandleProperties:
249 moduleSetTag: my-module-set-tag
251 - cmHandle: my-cm-handle
252 alternateId: my-alternate-id
253 dataProducerIdentifier: my-data-producer-identifier
254 publicCmHandleProperties:
258 moduleSetTag: my-module-set-tag
260 dmiPlugin: my-dmi-plugin
261 dmiModelPlugin: my-dmi-model-plugin
267 moduleSetTag: my-module-set-tag
268 dmiDataPlugin: my-dmi-data-plugin
276 example: my-dmi-plugin
280 example: my-dmi-data-plugin
284 example: my-dmi-model-plugin
288 $ref: '#/components/schemas/RestInputCmHandle'
292 $ref: '#/components/schemas/RestInputCmHandle'
303 $ref: '#/components/schemas/UpgradedCmHandles'
307 cmHandle: my-cm-handle
308 alternateId: my-alternate-id
309 dataProducerIdentifier: my-data-producer-identifier
310 publicCmHandleProperties:
314 moduleSetTag: my-module-set-tag
318 example: my-cm-handle
321 additionalProperties:
325 publicCmHandleProperties:
326 additionalProperties:
331 example: my-module-set-tag
340 example: my-alternate-id
342 dataProducerIdentifier:
343 example: my-data-producer-identifier
348 RestCmHandleProperties:
349 additionalProperties:
359 moduleSetTag: my-module-set-tag
371 example: my-module-set-tag
386 DmiPluginRegistrationErrorResponse:
388 failedCreatedCmHandles:
390 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
392 failedUpdatedCmHandles:
394 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
396 failedRemovedCmHandles:
398 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
400 failedUpgradeCmHandles:
402 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
405 CmHandlerRegistrationErrorResponse:
408 example: my-cm-handle
414 example: Unknown error. <error-details>
417 CmHandleQueryParameters:
419 cmHandleQueryParameters:
420 - conditionParameters:
421 - key: conditionParameters
422 - key: conditionParameters
423 conditionName: conditionName
424 - conditionParameters:
425 - key: conditionParameters
426 - key: conditionParameters
427 conditionName: conditionName
431 - moduleName: my-module
432 - moduleName: my-module
435 - moduleName: my-module
436 - moduleName: my-module
438 cmHandleQueryParameters:
440 $ref: '#/components/schemas/ConditionProperties'
444 description: "not necessary, it is just for backward compatibility"
446 $ref: '#/components/schemas/OldConditionProperties'
448 title: Cm Handle query parameters for executing cm handle search
453 - key: conditionParameters
454 - key: conditionParameters
455 conditionName: conditionName
461 additionalProperties:
465 OldConditionProperties:
470 - moduleName: my-module
471 - moduleName: my-module
477 $ref: '#/components/schemas/ModuleNameAsJsonObject'
479 ModuleNameAsJsonObject:
481 moduleName: my-module