Versions Compared

Key

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

...

e.g. myhost:1234//policy-executor/api/v1/payload/CM_Write/decision/Allow


Input Parameters


NameParentTypeExample ValueOptional/CompulsoryNotes
1actionurl pathStringexecuteRequired

The policy action. Currently supported value: execute

2Authorizationrequest (authorization header)StringBearer edaa8e7ce30f8904Required

required for tracking/ (future) authentication and to identify the source  (rApp) of the request

3
requestType

decisionType

body
String 
String
cm_create
permitRequiredcurrently supported
values: cm_create, cm_delete, cm_update, cm_patch
value: permit
4

requests

bodyObject[] Array
Required
5

schema

requests[n]Stringcps:org.onap.cps.ncmp.ploicy-executor:ncmp-create-schema:1.0.0Requiredthe schema name can also be used to determine the type of operation as each ncmp operation has its won schema (but can have similar/identical) content
6

data

objectString
RequiredDefined by schema above
Create Schema

NameParentTypeExample ValueOptional/CompulsoryNotes
1
4

decisionType

bodyStringpermitRequiredcurrently supported value: permit5

payload

bodyObject ArrayRequiredNo needed if payload and decision are in URL6

cmHandleId

payloadStringF811AF64F5146DFC545EC60B73DE948EOptionalCan be sent while cmHandle is used instead of alternateId
NCMP will populate when available
7
2

resourceIdentifer

payloadStringManagedElement=Kista/GNBDUFunction=1/UECC=1OptionalRemainder of FDN
NCMP will populate when available
8
3

targetIdentifier

payloadString/Subnetwork=22/MeContext=Kista/ManagedElement=Kista/GNBDUFunction=1/UECC=1RequiredComplete FDN representing the cm handle and the resource identifier ie point to the target of the change to 'CM-Handle' ?!
9
4

cmChangeRequest

payloadObject{"Cell":[{"id":"Cell-id","attributes":{"administrativeState":"UNLOCKED"}}]}RequiredCM Change Request


Code Block
languagexml
titleSample Body
linenumberstrue
collapsetrue
{
  "payloadType": "CM_Write",
  "decisionType": "Allow",
  "payload": [
    {
      "cmHandleId": "F811AF64F5146DFC545EC60B73DE948E",
      "resourceIdentifier": "GNBDUFunction=1/UECC=1",
      "targetFdn": "/Subnetwork=22/MeContext=Kista/ManagedElement=Kista/GNBDUFunction=1/UECC=1",
      "cmChangeRequest": {
        "Cell": [
          {
            "id": "Cell-id",
            "attributes": {
              "administrativeState": "UNLOCKED"
            }
          }
        ]
      }
    }
  ]
}

...