- CPS-909Getting issue details... STATUS
Currently
http://<cps-servic>/ncmp/v1/ch/{cm-handle}
Will return just the (public) cm handle properties (metadata). Once state is implement this URI should also return the State details (more metadata) But then for convenience we want to have more specific URIs to return just state data and to return just Properties. so the client can choose from 3 options:
- http://<cps-servic>/ncmp/v1/ch/{cm-handle}
- http://<cps-servic>/ncmp/v1/ch/{cm-handle}/properties
- http://<cps-servic>/ncmp/v1/ch/{cm-handle}/state
Note: 'modules' have been agreed not to be part of this type of cm-handle data (there is a separate URI to get those). If needed a special URL can be proposed in the future to combine modules with other metadata e.g somethin like '/export?metadata=all'
A/C
- Agree exact URI's with team and stakeholders
- Agree respons details for each with team and stakeholders
- Update documentation (OpenAPI ?)
(current) Structure (just properties)
{ "cmHandle": "Bookstore", "publicCmHandleProperties": [ { "Public-Book2": "Public Horror Book", "Public-Book1": "Public Sci-Fi Book", "Public-Book3": "Public Crime Book" } ] }
Properties
1 | URI | |
---|---|---|
2 | Response | { "cmHandle": "Bookstore", "publicCmHandleProperties": [ { "Public-Book2": "Public Horror Book", "Public-Book1": "Public Sci-Fi Book", "Public-Book3": "Public Crime Book" } ] } |
State
Dependent on update to dmi-registry
1 | URI | |
---|---|---|
2 | Response | Decide if just cmHandle state or does this include lock-reason if cm-handle in locked state { "cmHandle": "Bookstore", "state": { ... } } |