Versions Compared

Key

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

...


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

decisionType

bodyStringpermitRequiredcurrently supported 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

cmHandleId

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

resourceIdentifer

payloadStringManagedElement=Kista/GNBDUFunction=1/UECC=1OptionalRemainder of FDN
NCMP will populate when available
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' ?!
4

cmChangeRequest

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


Code Block
languagexml
titleCreate Schema JSON
collapsetrue
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.policy-executor:ncmp-create-schema:1.0.0",
  "$ref": "#/definitions/NcmpCreate",
  "definitions": {
    "NcmpCreate": {
      "javaType": "org.onap.cps.ncmp.impl.data.policyexecutor.NcmpCreate",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "cmHandleId": {
          "type": "string"
        },
        "resourceIdentifier": {
          "type": "string"
        },
        "targetIdentifier": {
          "type": "string"
        },
        "cmChangeRequest": {
          "type": "object"
        }
      },
      "required": [
        "targetIdentifier",
        "cmChangeRequest"
      ],
      "title": "NCMP Create"
    }
  }
}





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"
            }
          }
        ]
      }
    }
  ]
}

...