CPS-2234 Identify and List all Legacy Interfaces

NCMP shall be expected to return back alternateID when alternateid is passed in

NCMP shall be expected to return back to the normal cmhandle error scenario if alternateID is NOT passed on 

1. This shall be based on par unique identifier. 
2. For most legacy interfaces Performance impact was never agreed.
3. CPS should do performance check before and after for comparable value
4. FYI - Increase of 30 ms shall be allowed

Exact resource path required or partial match is accepted

Exact match example:

Incoming: "CmHandle='a/b/c/d', Resource=''"

Outgoing: "CmHandleID='Ch-1', Resource='a/b/c/d'"

Partial match example:

Incoming: "CmHandle='a/b', Resource=''"

Outgoing: "CmHandleID='Ch-1', Resource='a/b/c/d'"

Append match example:

Incoming: "CmHandle='a/b', Resource=''e/f"

Outgoing: "CmHandleID='Ch-1', Resource='a/b/c/d/e/f'"

**Should split based on URI**

• All Out of scope for this epic, this shall only focus on 'legacy interfaces'
• CPS-E-09.e - should be scoped in the new subscription epic - [CPS-2233] CM Subscription with DME interface - ONAP JIRA

1. FYI - Increase of 40 ms shall be allowed
2. Without alternateId 20ms, with alternateId 20ms total overhead allowable = 40ms as confirmed

CM Handle LCM events

CM Data Notification Subscription LCM (incl. merge)

Asynchronous . Data Jobs (bulk request). 3GPP SBMA (Service Based Management Architecture) Compliant Interface (using FDNs)

Synchronous Single FDN request 3GPP SBMA (Service Based Management Architecture) Compliant Interface (using FDNs) - 

CPS Application Monitoring and Management API

/v1/ch/{cm-handle}/data/ds/{datastore-name}

Delete resource data from pass-through running for a given cm handle

/v1/ch/{cm-handle}/data/ds/{datastore-name}

Get resource data for given cm handle

/v1/ch/{cm-handle}/data/ds/{datastore-name}

Patch resource data from pass-through running for the given cm handle

/v1/ch/{cm-handle}/data/ds/{datastore-name}

create resource data from pass-through running for given cm handle

/v1/ch/{cm-handle}/data/ds/{datastore-name}

Update resource data from pass-through running for the given cm handle

/v1/data

Execute a data operation for group of cm handle ids

/v1/ch/{cm-handle}/data/ds/{datastore-name}/query

Query resource data for a given cm handle

/v1/ch/{cm-handle}/modules

fetch all module references (name and revision) for a given cm handle

/v1/ch/{cm-handle}/modules/definitions

Get module definitions (module name, revision, yang resource) with options to filter on module name and revision

/v1/ch/searches

Execute cm handle query search and return a list of cm handle details.

/v1/ch/{cm-handle}

Retrieve CM handle details and properties by cm handle id

/v1/ch/{cm-handle}/properties

Get CM handle properties by cm handle id

/v1/ch/id-searches

Execute cm handle query search and return a list of cm handle ids.

28 Aug 2024 Kolawole Adebisi-Adeolokun CPS to implement option #1 optional query parameter

/v1/ch/{cm-handle}/data-sync

Set the data sync enabled flag to true or false for a specified Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and NONE_REQUESTED respectfully.

v1/ch/{cm-handle}/state 

Get CM handle state by cm handle id. (Not event driven, moved out of CPS-E-08.e)

/ncmpInventory/v1/ch

Register a DMI Plugin with any new, updated or removed CM Handles

/ncmpInventory/v1/ch/cmHandles

Get all cm handle IDs for a registered DMI plugin

/ncmpInventory/v1/ch/searches

Query and get CM Handle Ids for additional properties, public properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin).

/dmi/v1/ch/{cmHandle}/modules

Get all modules for given cm handle

/dmi/v1/ch/{cmHandle}/moduleResources

Retrieve module resources for one or more modules

/dmi/v1/inventory/cmHandles

register given list of cm handles (internal use only)

/dmi/v1/ch/{cmHandle}/data/ds/{datastore-name}

Get resource data from passthrough operational or running for a cm handle

/dmi/v1/data

Execute a data operation for group of cm handle ids by supplied operation details