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

Could be in URL, See alt. b above



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

23payloadTyperequestTypebodyString CMcm_WritecreateRequiredCould be in URL, See alt. b above
'CM_Write' currently, the only support value
currently supported values: cm_create, cm_delete, cm_update, cm_patch
43

decisionType

bodyStringAllowpermitRequiredCould be in URL, See alt. b above
'Allow' currently , the only supported value: permit
45

payload

bodyObject Array
RequiredNo needed if payload and decision are in URL
56

cmHandleId

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

resourceIdentifer

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

targetFdntargetIdentifier

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' ?!
89

cmChangeRequest

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

...


NameParentTypeExampleOptional/CompulsoryNotes
1decisionIdbodyString550e8400-e29b-41d4-a716-446655440000RequiredUUID
2decisionbodyStringDenydenyRequiredcurrently only 'Allow' and 'Deny' are supported
(case sensitive ?!)supported values: permit, deny
3messagebodyString to many updatesOptional

How to use the Interface in NCMP

...