Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

POST compliance/policy

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

POST

Creates custom policy

Since Product Version: 3.1

Resource URL

/webacs/api/v1/op/compliance/policy

Request Payload Parameters

Type Attribute Name Description

String

policyDescription

Description.

String

policyId

Policy ID. Required.

String

policyTitle

Policy title. Required.

CompliancePolicyRule[]

ruleList

At least one should be provided.

Response Parameters

Type Attribute Name Description

boolean

isSuccess

If true, the action was successfully performed. If false, it ended in some failure condition.

String

message

The action status message.

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://172.25.123.114/webacs/api/v1/op/compliance/policy

<?xml version="1.0" ?>
<compliancePolicy>
  <policyDescription>String value</policyDescription>
  <policyId>String value</policyId>
  <policyTitle>String value</policyTitle>
  <ruleList>
    <ruleList>
      <applicablePlatformList>
        <applicablePlatformList>
          <platformId>String value</platformId>
        </applicablePlatformList>
      </applicablePlatformList>
      <conditionsList>
        <conditionsList>
          <blockEachFailingInstance>true</blockEachFailingInstance>
          <blockEndExpression>String value</blockEndExpression>
          <blockRulePass>String value</blockRulePass>
          <blockStartExpression>String value</blockStartExpression>
          <conditionId>String value</conditionId>
          <conditionScope>String value</conditionScope>
          <conditionsEachFailingInstance>true</conditionsEachFailingInstance>
          <conditionsRulePass>String value</conditionsRulePass>
          <deviceProperty>String value</deviceProperty>
          <displayString>String value</displayString>
          <doesNotMatchAction>String value</doesNotMatchAction>
          <doesNotMatchConditionNumber>String value</doesNotMatchConditionNumber>
          <doesNotMatchFix>String value</doesNotMatchFix>
          <doesNotMatchViolationMessage>String value</doesNotMatchViolationMessage>
          <doesNotMatchViolationMessageId>String value</doesNotMatchViolationMessageId>
          <doesNotMatchViolationMessageType>String value</doesNotMatchViolationMessageType>
          <doesNotMatchViolationSeverity>String value</doesNotMatchViolationSeverity>
          <matchAction>String value</matchAction>
          <matchConditionNumber>String value</matchConditionNumber>
          <matchFix>String value</matchFix>
          <matchViolationMessage>String value</matchViolationMessage>
          <matchViolationMessageId>String value</matchViolationMessageId>
          <matchViolationMessageType>String value</matchViolationMessageType>
          <matchViolationSeverity>String value</matchViolationSeverity>
          <operator>String value</operator>
          <operatorFunction>
            <functionName>String value</functionName>
            <params>
              <params>
                <name>String value</name>
                <value>String value</value>
              </params>
            </params>
          </operatorFunction>
          <parseAsBlocks>true</parseAsBlocks>
          <showCommand>String value</showCommand>
          <value>String value</value>
        </conditionsList>
      </conditionsList>
      <ruleDescription>String value</ruleDescription>
      <ruleId>String value</ruleId>
      <ruleImpact>String value</ruleImpact>
      <ruleInputList>
        <ruleInputList>
          <cardinality>true</cardinality>
          <customConstraint>
            <accessMode>String value</accessMode>
            <defaultValues>
              <defaultValues>String value</defaultValues>
            </defaultValues>
            <defaultvalue>String value</defaultvalue>
            <description>String value</description>
            <inputScope>String value</inputScope>
            <isLov>true</isLov>
            <isRequired>String value</isRequired>
            <key>String value</key>
            <mapOfLOVList>
              <mapOfLOVList>
                <id>String value</id>
                <value>String value</value>
              </mapOfLOVList>
            </mapOfLOVList>
            <maxInclusive>String value</maxInclusive>
            <maximumLength>String value</maximumLength>
            <minInclusive>String value</minInclusive>
            <regularExpression>String value</regularExpression>
          </customConstraint>
          <inputDataType>String value</inputDataType>
          <inputId>String value</inputId>
          <inputScope>String value</inputScope>
          <inputTitle>String value</inputTitle>
          <isRequired>true</isRequired>
        </ruleInputList>
      </ruleInputList>
      <ruleSuggestedfix>String value</ruleSuggestedfix>
      <ruleTitle>String value</ruleTitle>
    </ruleList>
  </ruleList>
</compliancePolicy>

Sample JSON Request Payload

https://172.25.123.114/webacs/api/v1/op/compliance/policy.json

{
  "compliancePolicy" : {
    "policyDescription" : "String value",
    "policyId" : "String value",
    "policyTitle" : "String value",
    "ruleList" : {
      "ruleList" : {
        "applicablePlatformList" : {
          "applicablePlatformList" : {
            "platformId" : "String value"
          }
        },
        "conditionsList" : {
          "conditionsList" : {
            "blockEachFailingInstance" : true,
            "blockEndExpression" : "String value",
            "blockRulePass" : "String value",
            "blockStartExpression" : "String value",
            "conditionId" : "String value",
            "conditionScope" : "String value",
            "conditionsEachFailingInstance" : true,
            "conditionsRulePass" : "String value",
            "deviceProperty" : "String value",
            "displayString" : "String value",
            "doesNotMatchAction" : "String value",
            "doesNotMatchConditionNumber" : "String value",
            "doesNotMatchFix" : "String value",
            "doesNotMatchViolationMessage" : "String value",
            "doesNotMatchViolationMessageId" : "String value",
            "doesNotMatchViolationMessageType" : "String value",
            "doesNotMatchViolationSeverity" : "String value",
            "matchAction" : "String value",
            "matchConditionNumber" : "String value",
            "matchFix" : "String value",
            "matchViolationMessage" : "String value",
            "matchViolationMessageId" : "String value",
            "matchViolationMessageType" : "String value",
            "matchViolationSeverity" : "String value",
            "operator" : "String value",
            "operatorFunction" : {
              "functionName" : "String value",
              "params" : {
                "params" : {
                  "name" : "String value",
                  "value" : "String value"
                }
              }
            },
            "parseAsBlocks" : true,
            "showCommand" : "String value",
            "value" : "String value"
          }
        },
        "ruleDescription" : "String value",
        "ruleId" : "String value",
        "ruleImpact" : "String value",
        "ruleInputList" : {
          "ruleInputList" : {
            "cardinality" : true,
            "customConstraint" : {
              "accessMode" : "String value",
              "defaultValues" : {
                "defaultValues" : "String value"
              },
              "defaultvalue" : "String value",
              "description" : "String value",
              "inputScope" : "String value",
              "isLov" : true,
              "isRequired" : "String value",
              "key" : "String value",
              "mapOfLOVList" : {
                "mapOfLOVList" : {
                  "id" : "String value",
                  "value" : "String value"
                }
              },
              "maxInclusive" : "String value",
              "maximumLength" : "String value",
              "minInclusive" : "String value",
              "regularExpression" : "String value"
            },
            "inputDataType" : "String value",
            "inputId" : "String value",
            "inputScope" : "String value",
            "inputTitle" : "String value",
            "isRequired" : true
          }
        },
        "ruleSuggestedfix" : "String value",
        "ruleTitle" : "String value"
      }
    }
  }
}

Sample XML Response Payload

https://172.25.123.114/webacs/api/v1/op/compliance/policy

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <complianceResult>
    <isSuccess>true</isSuccess>
    <message>String value</message>
  </complianceResult>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/compliance/policy.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/compliance\/policy",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "complianceResult" : {
      "isSuccess" : true,
      "message" : "String value"
    }
  }
}