3 title: NCMP Inventory API
4 description: NCMP Inventory API
12 - network-cm-proxy-inventory
13 summary: DMI notifies NCMP of new CM Handles
14 description: "Register a DMI Plugin with any new, updated or removed CM Handles."
15 operationId: updateDmiPluginRegistration
20 $ref: '#/components/schemas/RestDmiPluginRegistration'
24 description: No Content
27 description: Bad Request
31 $ref: '#/components/schemas/ErrorMessage'
33 status: 400 BAD_REQUEST
34 message: Bad request error message
35 details: Bad request error details
37 description: Unauthorized
41 $ref: '#/components/schemas/ErrorMessage'
44 message: Unauthorized error message
45 details: Unauthorized error details
47 description: Forbidden
51 $ref: '#/components/schemas/ErrorMessage'
54 message: Forbidden error message
55 details: Forbidden error details
57 description: Partial or Complete failure. The error details are provided
58 in the response body and all supported error codes are documented in the
63 $ref: '#/components/schemas/DmiPluginRegistrationErrorResponse'
65 failedCreatedCmHandles:
66 - cmHandle: my-cm-handle-01
68 errorText: Unknown error. <error-details>
69 - cmHandle: my-cm-handle-02
71 errorText: cm-handle already exists
72 - cmHandle: my-cm-handle-03
74 errorText: cm-handle has an invalid character(s) in id
75 failedUpdatedCmHandles:
76 - cmHandle: my-cm-handle-01
78 errorText: Unknown error. <error-details>
79 - cmHandle: my-cm-handle-02
81 errorText: cm-handle does not exist
82 - cmHandle: my-cm-handle-03
84 errorText: cm-handle has an invalid character(s) in id
85 failedRemovedCmHandles:
86 - cmHandle: my-cm-handle-01
88 errorText: Unknown error. <error-details>
89 - cmHandle: my-cm-handle-02
91 errorText: cm-handle does not exists
92 - cmHandle: my-cm-handle-03
94 errorText: cm-handle has an invalid character(s) in id
98 - network-cm-proxy-inventory
99 summary: "Get all cm handle IDs for a registered DMI plugin (DMI plugin, DMI\
100 \ data plugin, DMI model plugin)"
101 description: Get all cm handle IDs for a registered DMI plugin
102 operationId: getAllCmHandleIdsForRegisteredDmi
104 - name: dmi-plugin-identifier
106 description: dmi-plugin-identifier
110 example: my-dmi-plugin
121 description: Unauthorized
125 $ref: '#/components/schemas/ErrorMessage'
128 message: Unauthorized error message
129 details: Unauthorized error details
131 description: Forbidden
135 $ref: '#/components/schemas/ErrorMessage'
138 message: Forbidden error message
139 details: Forbidden error details
141 description: Internal Server Error
145 $ref: '#/components/schemas/ErrorMessage'
148 message: Internal Server Error
149 details: Internal Server Error occurred
152 RestDmiPluginRegistration:
157 example: my-dmi-plugin
161 example: my-dmi-data-plugin
165 example: my-dmi-model-plugin
170 $ref: '#/components/schemas/RestInputCmHandle'
174 $ref: '#/components/schemas/RestInputCmHandle'
190 example: my-cm-handle
192 $ref: '#/components/schemas/RestCmHandleProperties'
193 publicCmHandleProperties:
194 $ref: '#/components/schemas/RestCmHandleProperties'
195 RestCmHandleProperties:
197 additionalProperties:
210 DmiPluginRegistrationErrorResponse:
213 failedCreatedCmHandles:
216 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
217 failedUpdatedCmHandles:
220 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
221 failedRemovedCmHandles:
224 $ref: '#/components/schemas/CmHandlerRegistrationErrorResponse'
225 CmHandlerRegistrationErrorResponse:
230 example: my-cm-handle
236 example: Unknown error. <error-details>