Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#Sub interfaceMethodScenarioSpecified HTTP Response CodeImplemented HTTP Response CodeComments
1DMI Plugin Internal

POST - /v1/inventory/cmHandles

DmiPluginInternalApi.registerCmHandles()



Register given list of cm handles (internal use only)

201

400

401

403

  • 201
-
  • (created)
    • for success
  • 400
- for invalid input (
  • (bad request)
    • for empty cm handles list from input
  • 500 (internal server error)
500 -
    • for parsing error when converting provided cm handles into json
    • for any response code from NCMP that is different form 201
    • for unexpected system errors
  • Input cm handle conversion error should return a 4xx client error
2DMI Plugin

POST - /v1/ch/{cmHandle}/modules

DmiPluginApi.getModuleReferences()

Get all modules for given cm handle

200

400

401

403


500 - for unexpected system errors


3DMI Plugin

POST - /v1/ch/{cmHandle}/moduleResources

DmiPluginApi.retrieveModuleResources()

Retrieve module resources for one or more modules

200

400

401

403

  • 404
- for
  • (not found
data (
  • )
    • module resource not found from SDNC for the given cm handle
,
    • error occurred when trying to parse the response body from
sdnc)500 -
    • SDNC
  • 500 (internal server error)
    • for any SDNC response code that is different from 200 and 404
    • for unexpected system errors
  • SDNC errors are not really consistent (404 and 500)
4DMI Plugin

POST - /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational

DmiPluginApi.dataAccessPassthroughOperational()

Get resource data from passthrough-operational for cm handle. Will support read operations only.

200

400

401

403


500 - for unexpected system errors


5DMI Plugin

POST - /v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running

DmiPluginApi.dataAccessPassthroughRunning()

Post request to Get, Create or to Update resource data for a cm-handle. Since all requests need to include additional information in a request body HTTP Post is used for all use cases and the actual operation is defined in the request body instead.

201

400

401

403


500 - for unexpected system errors

  • Should success be 200 (general ok) instead of 201 (created) ?

...