Versions Compared

Key

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

...

  • New method retrieveCmHandleDetails().

API details

Description

URI

Sample Response Body

Get Cm Handle details by name.

GET

 {ncmpRoot}/ncmp/v1/ch/PNFDemo

{
    "cmHandle": "Bookstore",
    "cmHandleProperties": [
        {
            "Public-Book1": "Public Sci-Fi Book",
            "Public-Book2": "Public Horror Book",
            "Public-Book3": "Public Crime Book"
        }
    ]
}


Open Issues

Currently within CPS we have two separate models for CmHandles these being CmHandle and PersistenceCmHandle. These are both very similar models, the primary difference being that persistenceCmHandle also contains references to the dmiServiceName, the dmiDataServiceName and the dmiModelServiceName as seen below.

Code Block
languagejava
titleCmHandle.java
/**
 * CmHandle.
 */
@Validated
@Getter
@Setter
@NoArgsConstructor
public class CmHandle {

    @JsonProperty("cmHandle")
    private String cmHandleID;

    @JsonSetter(nulls = Nulls.AS_EMPTY)
    @JsonProperty("cmHandleProperties")
    private Map<String, String> dmiProperties = Collections.emptyMap();

    @JsonSetter(nulls = Nulls.AS_EMPTY)
    @JsonProperty("publicCmHandleProperties")
    private Map<String, String> publicProperties = Collections.emptyMap();

}


Code Block
languagejava
titlePersistenceCmHandle.java
/**
 * DmiRegistry.
 */
@Getter
@Setter
@NoArgsConstructor
public class PersistenceCmHandle {

    private String id;

    @JsonProperty("dmi-service-name")
    private String dmiServiceName;

    @JsonProperty("dmi-data-service-name")
    private String dmiDataServiceName;

    @JsonProperty("dmi-model-service-name")
    private String dmiModelServiceName;

    @JsonProperty("additional-properties")
    private List<Property> dmiProperties;

    @JsonProperty("public-properties")
    private List<Property> publicProperties;