3 title: NCMP Inventory API
4 description: NCMP Inventory API
14 - network-cm-proxy-inventory
15 summary: DMI notifies NCMP of new CM Handles
16 description: "Register a DMI Plugin with any new, updated or removed CM Handles."
17 operationId: updateDmiPluginRegistration
22 $ref: '#/components/schemas/RestDmiPluginRegistration'
26 description: No Content
29 description: Bad Request
33 $ref: '#/components/schemas/ErrorMessage'
35 status: 400 BAD_REQUEST
36 message: Bad request error message
37 details: Bad request error details
39 description: Unauthorized
43 $ref: '#/components/schemas/ErrorMessage'
46 message: Unauthorized error message
47 details: Unauthorized error details
49 description: Forbidden
53 $ref: '#/components/schemas/ErrorMessage'
56 message: Forbidden error message
57 details: Forbidden error details
59 description: Partial or Complete failure. The error details are provided
60 in the response body and all supported error codes are documented in the
65 $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
67 failedCreatedCmHandles:
68 - cmHandle: my-cm-handle-01
70 errorText: Unknown error. <error-details>
71 - cmHandle: my-cm-handle-02
73 errorText: cm-handle already exists
74 - cmHandle: my-cm-handle-03
76 errorText: cm-handle has an invalid character(s) in id
77 failedUpdatedCmHandles:
78 - cmHandle: my-cm-handle-01
80 errorText: Unknown error. <error-details>
81 - cmHandle: my-cm-handle-02
83 errorText: cm-handle does not exist
84 - cmHandle: my-cm-handle-03
86 errorText: cm-handle has an invalid character(s) in id
87 failedRemovedCmHandles:
88 - cmHandle: my-cm-handle-01
90 errorText: Unknown error. <error-details>
91 - cmHandle: my-cm-handle-02
93 errorText: cm-handle does not exists
94 - cmHandle: my-cm-handle-03
96 errorText: cm-handle has an invalid character(s) in id
100 - network-cm-proxy-inventory
101 summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
102 \ data plugin, DMI model plugin)"
103 description: Get all cm handle IDs for a registered DMI plugin
104 operationId: getAllCmHandleIdsForRegisteredDmi
106 - name: dmi-plugin-identifier
108 description: dmi-plugin-identifier
112 example: my-dmi-plugin
123 description: Unauthorized
127 $ref: '#/components/schemas/ErrorMessage'
130 message: Unauthorized error message
131 details: Unauthorized error details
133 description: Forbidden
137 $ref: '#/components/schemas/ErrorMessage'
140 message: Forbidden error message
141 details: Forbidden error details
143 description: Internal Server Error
147 $ref: '#/components/schemas/ErrorMessage'
150 message: Internal Server Error
151 details: Internal Server Error occurred
155 - network-cm-proxy-inventory
156 summary: Query for CM Handle IDs
157 description: "Query and get CMHandleIds for additional properties, public properties\
158 \ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)."
159 operationId: searchCmHandleIds
164 $ref: '#/components/schemas/CmHandleQueryParameters'
176 description: Unauthorized
180 $ref: '#/components/schemas/ErrorMessage'
183 message: Unauthorized error message
184 details: Unauthorized error details
186 description: Forbidden
190 $ref: '#/components/schemas/ErrorMessage'
193 message: Forbidden error message
194 details: Forbidden error details
196 description: Internal Server Error
200 $ref: '#/components/schemas/ErrorMessage'
203 message: Internal Server Error
204 details: Internal Server Error occurred
207 RestDmiPluginRegistration:
212 example: my-dmi-plugin
216 example: my-dmi-data-plugin
220 example: my-dmi-model-plugin
225 $ref: '#/components/schemas/RestInputCmHandle'
229 $ref: '#/components/schemas/RestInputCmHandle'
245 example: my-cm-handle
247 $ref: '#/components/schemas/RestCmHandleProperties'
248 publicCmHandleProperties:
249 $ref: '#/components/schemas/RestCmHandleProperties'
250 RestCmHandleProperties:
252 additionalProperties:
265 DmiPluginRegistrationErrorResponse:
268 failedCreatedCmHandles:
271 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
272 failedUpdatedCmHandles:
275 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
276 failedRemovedCmHandles:
279 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
280 CmHandlerRegistrationErrorResponse:
285 example: my-cm-handle
291 example: Unknown error. <error-details>
292 CmHandleQueryParameters:
293 title: Cm Handle query parameters for executing cm handle search
296 cmHandleQueryParameters:
299 $ref: '#/components/schemas/ConditionProperties'
302 description: "not necessary, it is just for backward compatibility"
305 $ref: '#/components/schemas/OldConditionProperties'
314 additionalProperties:
316 OldConditionProperties:
323 $ref: '#/components/schemas/ModuleNameAsJsonObject'
325 ModuleNameAsJsonObject: