Creates custom policy
Since Product Version: 3.1
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (9)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (for Operations Center) (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/op/compliance/policyRequest Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policyDescription String |
Description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyId String |
Policy ID. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyTitle String |
Policy title. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
At least one should be provided. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
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://localhost/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://localhost/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://localhost/webacs/api/v1/op/compliance/policy
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/compliance/policy" rootUrl="https://localhost/webacs/api/v1/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/compliance/policy.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/compliance\/policy",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"complianceResult" : {
"isSuccess" : true,
"message" : "String value"
}
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v2/op/compliance/policy UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policyDescription String |
Description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyId String |
Policy ID. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyTitle String |
Policy title. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
At least one should be provided. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
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://localhost/webacs/api/v2/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://localhost/webacs/api/v2/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://localhost/webacs/api/v2/op/compliance/policy
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v2/op/compliance/policy" rootUrl="https://localhost/webacs/api/v2/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v2/op/compliance/policy.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v2/op/compliance/policy",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v2/op",
"complianceResult" : [ {
"isSuccess" : true,
"message" : "String value"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v3/op/compliance/policy UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policyDescription String |
Description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyId String |
Policy ID. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyTitle String |
Policy title. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
At least one should be provided. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
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://localhost/webacs/api/v3/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>
<platformId>Another 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>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>true</parseAsBlocks>
<showCommand>String value</showCommand>
<value>String value</value>
</conditionsList>
<conditionsList>
<blockEachFailingInstance>false</blockEachFailingInstance>
<blockEndExpression>Another string value</blockEndExpression>
<blockRulePass>Another string value</blockRulePass>
<blockStartExpression>Another string value</blockStartExpression>
<conditionId>Another string value</conditionId>
<conditionScope>Another string value</conditionScope>
<conditionsEachFailingInstance>false</conditionsEachFailingInstance>
<conditionsRulePass>Another string value</conditionsRulePass>
<deviceProperty>Another string value</deviceProperty>
<displayString>Another string value</displayString>
<doesNotMatchAction>Another string value</doesNotMatchAction>
<doesNotMatchConditionNumber>Another string value</doesNotMatchConditionNumber>
<doesNotMatchFix>Another string value</doesNotMatchFix>
<doesNotMatchViolationMessage>Another string value</doesNotMatchViolationMessage>
<doesNotMatchViolationMessageId>Another string value</doesNotMatchViolationMessageId>
<doesNotMatchViolationMessageType>Another string value</doesNotMatchViolationMessageType>
<doesNotMatchViolationSeverity>Another string value</doesNotMatchViolationSeverity>
<matchAction>Another string value</matchAction>
<matchConditionNumber>Another string value</matchConditionNumber>
<matchFix>Another string value</matchFix>
<matchViolationMessage>Another string value</matchViolationMessage>
<matchViolationMessageId>Another string value</matchViolationMessageId>
<matchViolationMessageType>Another string value</matchViolationMessageType>
<matchViolationSeverity>Another string value</matchViolationSeverity>
<operator>Another string value</operator>
<operatorFunction>
<functionName>Another string value</functionName>
<params>
<params>
<name>String value</name>
<value>String value</value>
</params>
<params>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>false</parseAsBlocks>
<showCommand>Another string value</showCommand>
<value>Another 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>Another 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>
<id>Another string value</id>
<value>Another 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>
<cardinality>false</cardinality>
<customConstraint>
<accessMode>Another string value</accessMode>
<defaultValues>
<defaultValues>String value</defaultValues>
<defaultValues>Another string value</defaultValues>
</defaultValues>
<defaultvalue>Another string value</defaultvalue>
<description>Another string value</description>
<inputScope>Another string value</inputScope>
<isLov>false</isLov>
<isRequired>Another string value</isRequired>
<key>Another string value</key>
<mapOfLOVList>
<mapOfLOVList>
<id>String value</id>
<value>String value</value>
</mapOfLOVList>
<mapOfLOVList>
<id>Another string value</id>
<value>Another string value</value>
</mapOfLOVList>
</mapOfLOVList>
<maxInclusive>Another string value</maxInclusive>
<maximumLength>Another string value</maximumLength>
<minInclusive>Another string value</minInclusive>
<regularExpression>Another string value</regularExpression>
</customConstraint>
<inputDataType>Another string value</inputDataType>
<inputId>Another string value</inputId>
<inputScope>Another string value</inputScope>
<inputTitle>Another string value</inputTitle>
<isRequired>false</isRequired>
</ruleInputList>
</ruleInputList>
<ruleSuggestedfix>String value</ruleSuggestedfix>
<ruleTitle>String value</ruleTitle>
</ruleList>
<ruleList>
<applicablePlatformList>
<applicablePlatformList>
<platformId>String value</platformId>
</applicablePlatformList>
<applicablePlatformList>
<platformId>Another 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>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>true</parseAsBlocks>
<showCommand>String value</showCommand>
<value>String value</value>
</conditionsList>
<conditionsList>
<blockEachFailingInstance>false</blockEachFailingInstance>
<blockEndExpression>Another string value</blockEndExpression>
<blockRulePass>Another string value</blockRulePass>
<blockStartExpression>Another string value</blockStartExpression>
<conditionId>Another string value</conditionId>
<conditionScope>Another string value</conditionScope>
<conditionsEachFailingInstance>false</conditionsEachFailingInstance>
<conditionsRulePass>Another string value</conditionsRulePass>
<deviceProperty>Another string value</deviceProperty>
<displayString>Another string value</displayString>
<doesNotMatchAction>Another string value</doesNotMatchAction>
<doesNotMatchConditionNumber>Another string value</doesNotMatchConditionNumber>
<doesNotMatchFix>Another string value</doesNotMatchFix>
<doesNotMatchViolationMessage>Another string value</doesNotMatchViolationMessage>
<doesNotMatchViolationMessageId>Another string value</doesNotMatchViolationMessageId>
<doesNotMatchViolationMessageType>Another string value</doesNotMatchViolationMessageType>
<doesNotMatchViolationSeverity>Another string value</doesNotMatchViolationSeverity>
<matchAction>Another string value</matchAction>
<matchConditionNumber>Another string value</matchConditionNumber>
<matchFix>Another string value</matchFix>
<matchViolationMessage>Another string value</matchViolationMessage>
<matchViolationMessageId>Another string value</matchViolationMessageId>
<matchViolationMessageType>Another string value</matchViolationMessageType>
<matchViolationSeverity>Another string value</matchViolationSeverity>
<operator>Another string value</operator>
<operatorFunction>
<functionName>Another string value</functionName>
<params>
<params>
<name>String value</name>
<value>String value</value>
</params>
<params>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>false</parseAsBlocks>
<showCommand>Another string value</showCommand>
<value>Another string value</value>
</conditionsList>
</conditionsList>
<ruleDescription>Another string value</ruleDescription>
<ruleId>Another string value</ruleId>
<ruleImpact>Another string value</ruleImpact>
<ruleInputList>
<ruleInputList>
<cardinality>true</cardinality>
<customConstraint>
<accessMode>String value</accessMode>
<defaultValues>
<defaultValues>String value</defaultValues>
<defaultValues>Another 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>
<id>Another string value</id>
<value>Another 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>
<cardinality>false</cardinality>
<customConstraint>
<accessMode>Another string value</accessMode>
<defaultValues>
<defaultValues>String value</defaultValues>
<defaultValues>Another string value</defaultValues>
</defaultValues>
<defaultvalue>Another string value</defaultvalue>
<description>Another string value</description>
<inputScope>Another string value</inputScope>
<isLov>false</isLov>
<isRequired>Another string value</isRequired>
<key>Another string value</key>
<mapOfLOVList>
<mapOfLOVList>
<id>String value</id>
<value>String value</value>
</mapOfLOVList>
<mapOfLOVList>
<id>Another string value</id>
<value>Another string value</value>
</mapOfLOVList>
</mapOfLOVList>
<maxInclusive>Another string value</maxInclusive>
<maximumLength>Another string value</maximumLength>
<minInclusive>Another string value</minInclusive>
<regularExpression>Another string value</regularExpression>
</customConstraint>
<inputDataType>Another string value</inputDataType>
<inputId>Another string value</inputId>
<inputScope>Another string value</inputScope>
<inputTitle>Another string value</inputTitle>
<isRequired>false</isRequired>
</ruleInputList>
</ruleInputList>
<ruleSuggestedfix>Another string value</ruleSuggestedfix>
<ruleTitle>Another string value</ruleTitle>
</ruleList>
</ruleList>
</compliancePolicy>
Sample JSON Request Payload
https://localhost/webacs/api/v3/op/compliance/policy.json
{
"compliancePolicy" : {
"policyDescription" : "String value",
"policyId" : "String value",
"policyTitle" : "String value",
"ruleList" : {
"ruleList" : [ {
"applicablePlatformList" : {
"applicablePlatformList" : [ {
"platformId" : "String value"
}, {
"platformId" : "Another 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"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : true,
"showCommand" : "String value",
"value" : "String value"
}, {
"blockEachFailingInstance" : false,
"blockEndExpression" : "Another string value",
"blockRulePass" : "Another string value",
"blockStartExpression" : "Another string value",
"conditionId" : "Another string value",
"conditionScope" : "Another string value",
"conditionsEachFailingInstance" : false,
"conditionsRulePass" : "Another string value",
"deviceProperty" : "Another string value",
"displayString" : "Another string value",
"doesNotMatchAction" : "Another string value",
"doesNotMatchConditionNumber" : "Another string value",
"doesNotMatchFix" : "Another string value",
"doesNotMatchViolationMessage" : "Another string value",
"doesNotMatchViolationMessageId" : "Another string value",
"doesNotMatchViolationMessageType" : "Another string value",
"doesNotMatchViolationSeverity" : "Another string value",
"matchAction" : "Another string value",
"matchConditionNumber" : "Another string value",
"matchFix" : "Another string value",
"matchViolationMessage" : "Another string value",
"matchViolationMessageId" : "Another string value",
"matchViolationMessageType" : "Another string value",
"matchViolationSeverity" : "Another string value",
"operator" : "Another string value",
"operatorFunction" : {
"functionName" : "Another string value",
"params" : {
"params" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : false,
"showCommand" : "Another string value",
"value" : "Another string value"
} ]
},
"ruleDescription" : "String value",
"ruleId" : "String value",
"ruleImpact" : "String value",
"ruleInputList" : {
"ruleInputList" : [ {
"cardinality" : true,
"customConstraint" : {
"accessMode" : "String value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another 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"
}, {
"id" : "Another string value",
"value" : "Another 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
}, {
"cardinality" : false,
"customConstraint" : {
"accessMode" : "Another string value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another string value" ]
},
"defaultvalue" : "Another string value",
"description" : "Another string value",
"inputScope" : "Another string value",
"isLov" : false,
"isRequired" : "Another string value",
"key" : "Another string value",
"mapOfLOVList" : {
"mapOfLOVList" : [ {
"id" : "String value",
"value" : "String value"
}, {
"id" : "Another string value",
"value" : "Another string value"
} ]
},
"maxInclusive" : "Another string value",
"maximumLength" : "Another string value",
"minInclusive" : "Another string value",
"regularExpression" : "Another string value"
},
"inputDataType" : "Another string value",
"inputId" : "Another string value",
"inputScope" : "Another string value",
"inputTitle" : "Another string value",
"isRequired" : false
} ]
},
"ruleSuggestedfix" : "String value",
"ruleTitle" : "String value"
}, {
"applicablePlatformList" : {
"applicablePlatformList" : [ {
"platformId" : "String value"
}, {
"platformId" : "Another 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"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : true,
"showCommand" : "String value",
"value" : "String value"
}, {
"blockEachFailingInstance" : false,
"blockEndExpression" : "Another string value",
"blockRulePass" : "Another string value",
"blockStartExpression" : "Another string value",
"conditionId" : "Another string value",
"conditionScope" : "Another string value",
"conditionsEachFailingInstance" : false,
"conditionsRulePass" : "Another string value",
"deviceProperty" : "Another string value",
"displayString" : "Another string value",
"doesNotMatchAction" : "Another string value",
"doesNotMatchConditionNumber" : "Another string value",
"doesNotMatchFix" : "Another string value",
"doesNotMatchViolationMessage" : "Another string value",
"doesNotMatchViolationMessageId" : "Another string value",
"doesNotMatchViolationMessageType" : "Another string value",
"doesNotMatchViolationSeverity" : "Another string value",
"matchAction" : "Another string value",
"matchConditionNumber" : "Another string value",
"matchFix" : "Another string value",
"matchViolationMessage" : "Another string value",
"matchViolationMessageId" : "Another string value",
"matchViolationMessageType" : "Another string value",
"matchViolationSeverity" : "Another string value",
"operator" : "Another string value",
"operatorFunction" : {
"functionName" : "Another string value",
"params" : {
"params" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : false,
"showCommand" : "Another string value",
"value" : "Another string value"
} ]
},
"ruleDescription" : "Another string value",
"ruleId" : "Another string value",
"ruleImpact" : "Another string value",
"ruleInputList" : {
"ruleInputList" : [ {
"cardinality" : true,
"customConstraint" : {
"accessMode" : "String value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another 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"
}, {
"id" : "Another string value",
"value" : "Another 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
}, {
"cardinality" : false,
"customConstraint" : {
"accessMode" : "Another string value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another string value" ]
},
"defaultvalue" : "Another string value",
"description" : "Another string value",
"inputScope" : "Another string value",
"isLov" : false,
"isRequired" : "Another string value",
"key" : "Another string value",
"mapOfLOVList" : {
"mapOfLOVList" : [ {
"id" : "String value",
"value" : "String value"
}, {
"id" : "Another string value",
"value" : "Another string value"
} ]
},
"maxInclusive" : "Another string value",
"maximumLength" : "Another string value",
"minInclusive" : "Another string value",
"regularExpression" : "Another string value"
},
"inputDataType" : "Another string value",
"inputId" : "Another string value",
"inputScope" : "Another string value",
"inputTitle" : "Another string value",
"isRequired" : false
} ]
},
"ruleSuggestedfix" : "Another string value",
"ruleTitle" : "Another string value"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v3/op/compliance/policy
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v3/op/compliance/policy" rootUrl="https://localhost/webacs/api/v3/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v3/op/compliance/policy.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v3/op/compliance/policy",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v3/op",
"complianceResult" : [ {
"isSuccess" : true,
"message" : "String value"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v4/op/compliance/policy UnmodifiedThis resource has not been modified since the previous API version.
Request Payload Parameters
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
policyDescription String |
Description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyId String |
Policy ID. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
policyTitle String |
Policy title. Required. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
At least one should be provided. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Response Parameters
Attribute | Description |
---|---|
isSuccess boolean |
If true, the action was successfully performed. If false, it ended in some failure condition. |
message String |
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://localhost/webacs/api/v4/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>
<platformId>Another 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>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>true</parseAsBlocks>
<showCommand>String value</showCommand>
<value>String value</value>
</conditionsList>
<conditionsList>
<blockEachFailingInstance>false</blockEachFailingInstance>
<blockEndExpression>Another string value</blockEndExpression>
<blockRulePass>Another string value</blockRulePass>
<blockStartExpression>Another string value</blockStartExpression>
<conditionId>Another string value</conditionId>
<conditionScope>Another string value</conditionScope>
<conditionsEachFailingInstance>false</conditionsEachFailingInstance>
<conditionsRulePass>Another string value</conditionsRulePass>
<deviceProperty>Another string value</deviceProperty>
<displayString>Another string value</displayString>
<doesNotMatchAction>Another string value</doesNotMatchAction>
<doesNotMatchConditionNumber>Another string value</doesNotMatchConditionNumber>
<doesNotMatchFix>Another string value</doesNotMatchFix>
<doesNotMatchViolationMessage>Another string value</doesNotMatchViolationMessage>
<doesNotMatchViolationMessageId>Another string value</doesNotMatchViolationMessageId>
<doesNotMatchViolationMessageType>Another string value</doesNotMatchViolationMessageType>
<doesNotMatchViolationSeverity>Another string value</doesNotMatchViolationSeverity>
<matchAction>Another string value</matchAction>
<matchConditionNumber>Another string value</matchConditionNumber>
<matchFix>Another string value</matchFix>
<matchViolationMessage>Another string value</matchViolationMessage>
<matchViolationMessageId>Another string value</matchViolationMessageId>
<matchViolationMessageType>Another string value</matchViolationMessageType>
<matchViolationSeverity>Another string value</matchViolationSeverity>
<operator>Another string value</operator>
<operatorFunction>
<functionName>Another string value</functionName>
<params>
<params>
<name>String value</name>
<value>String value</value>
</params>
<params>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>false</parseAsBlocks>
<showCommand>Another string value</showCommand>
<value>Another 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>Another 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>
<id>Another string value</id>
<value>Another 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>
<cardinality>false</cardinality>
<customConstraint>
<accessMode>Another string value</accessMode>
<defaultValues>
<defaultValues>String value</defaultValues>
<defaultValues>Another string value</defaultValues>
</defaultValues>
<defaultvalue>Another string value</defaultvalue>
<description>Another string value</description>
<inputScope>Another string value</inputScope>
<isLov>false</isLov>
<isRequired>Another string value</isRequired>
<key>Another string value</key>
<mapOfLOVList>
<mapOfLOVList>
<id>String value</id>
<value>String value</value>
</mapOfLOVList>
<mapOfLOVList>
<id>Another string value</id>
<value>Another string value</value>
</mapOfLOVList>
</mapOfLOVList>
<maxInclusive>Another string value</maxInclusive>
<maximumLength>Another string value</maximumLength>
<minInclusive>Another string value</minInclusive>
<regularExpression>Another string value</regularExpression>
</customConstraint>
<inputDataType>Another string value</inputDataType>
<inputId>Another string value</inputId>
<inputScope>Another string value</inputScope>
<inputTitle>Another string value</inputTitle>
<isRequired>false</isRequired>
</ruleInputList>
</ruleInputList>
<ruleSuggestedfix>String value</ruleSuggestedfix>
<ruleTitle>String value</ruleTitle>
</ruleList>
<ruleList>
<applicablePlatformList>
<applicablePlatformList>
<platformId>String value</platformId>
</applicablePlatformList>
<applicablePlatformList>
<platformId>Another 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>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>true</parseAsBlocks>
<showCommand>String value</showCommand>
<value>String value</value>
</conditionsList>
<conditionsList>
<blockEachFailingInstance>false</blockEachFailingInstance>
<blockEndExpression>Another string value</blockEndExpression>
<blockRulePass>Another string value</blockRulePass>
<blockStartExpression>Another string value</blockStartExpression>
<conditionId>Another string value</conditionId>
<conditionScope>Another string value</conditionScope>
<conditionsEachFailingInstance>false</conditionsEachFailingInstance>
<conditionsRulePass>Another string value</conditionsRulePass>
<deviceProperty>Another string value</deviceProperty>
<displayString>Another string value</displayString>
<doesNotMatchAction>Another string value</doesNotMatchAction>
<doesNotMatchConditionNumber>Another string value</doesNotMatchConditionNumber>
<doesNotMatchFix>Another string value</doesNotMatchFix>
<doesNotMatchViolationMessage>Another string value</doesNotMatchViolationMessage>
<doesNotMatchViolationMessageId>Another string value</doesNotMatchViolationMessageId>
<doesNotMatchViolationMessageType>Another string value</doesNotMatchViolationMessageType>
<doesNotMatchViolationSeverity>Another string value</doesNotMatchViolationSeverity>
<matchAction>Another string value</matchAction>
<matchConditionNumber>Another string value</matchConditionNumber>
<matchFix>Another string value</matchFix>
<matchViolationMessage>Another string value</matchViolationMessage>
<matchViolationMessageId>Another string value</matchViolationMessageId>
<matchViolationMessageType>Another string value</matchViolationMessageType>
<matchViolationSeverity>Another string value</matchViolationSeverity>
<operator>Another string value</operator>
<operatorFunction>
<functionName>Another string value</functionName>
<params>
<params>
<name>String value</name>
<value>String value</value>
</params>
<params>
<name>Another string value</name>
<value>Another string value</value>
</params>
</params>
</operatorFunction>
<parseAsBlocks>false</parseAsBlocks>
<showCommand>Another string value</showCommand>
<value>Another string value</value>
</conditionsList>
</conditionsList>
<ruleDescription>Another string value</ruleDescription>
<ruleId>Another string value</ruleId>
<ruleImpact>Another string value</ruleImpact>
<ruleInputList>
<ruleInputList>
<cardinality>true</cardinality>
<customConstraint>
<accessMode>String value</accessMode>
<defaultValues>
<defaultValues>String value</defaultValues>
<defaultValues>Another 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>
<id>Another string value</id>
<value>Another 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>
<cardinality>false</cardinality>
<customConstraint>
<accessMode>Another string value</accessMode>
<defaultValues>
<defaultValues>String value</defaultValues>
<defaultValues>Another string value</defaultValues>
</defaultValues>
<defaultvalue>Another string value</defaultvalue>
<description>Another string value</description>
<inputScope>Another string value</inputScope>
<isLov>false</isLov>
<isRequired>Another string value</isRequired>
<key>Another string value</key>
<mapOfLOVList>
<mapOfLOVList>
<id>String value</id>
<value>String value</value>
</mapOfLOVList>
<mapOfLOVList>
<id>Another string value</id>
<value>Another string value</value>
</mapOfLOVList>
</mapOfLOVList>
<maxInclusive>Another string value</maxInclusive>
<maximumLength>Another string value</maximumLength>
<minInclusive>Another string value</minInclusive>
<regularExpression>Another string value</regularExpression>
</customConstraint>
<inputDataType>Another string value</inputDataType>
<inputId>Another string value</inputId>
<inputScope>Another string value</inputScope>
<inputTitle>Another string value</inputTitle>
<isRequired>false</isRequired>
</ruleInputList>
</ruleInputList>
<ruleSuggestedfix>Another string value</ruleSuggestedfix>
<ruleTitle>Another string value</ruleTitle>
</ruleList>
</ruleList>
</compliancePolicy>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/compliance/policy.json
{
"compliancePolicy" : {
"policyDescription" : "String value",
"policyId" : "String value",
"policyTitle" : "String value",
"ruleList" : {
"ruleList" : [ {
"applicablePlatformList" : {
"applicablePlatformList" : [ {
"platformId" : "String value"
}, {
"platformId" : "Another 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"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : true,
"showCommand" : "String value",
"value" : "String value"
}, {
"blockEachFailingInstance" : false,
"blockEndExpression" : "Another string value",
"blockRulePass" : "Another string value",
"blockStartExpression" : "Another string value",
"conditionId" : "Another string value",
"conditionScope" : "Another string value",
"conditionsEachFailingInstance" : false,
"conditionsRulePass" : "Another string value",
"deviceProperty" : "Another string value",
"displayString" : "Another string value",
"doesNotMatchAction" : "Another string value",
"doesNotMatchConditionNumber" : "Another string value",
"doesNotMatchFix" : "Another string value",
"doesNotMatchViolationMessage" : "Another string value",
"doesNotMatchViolationMessageId" : "Another string value",
"doesNotMatchViolationMessageType" : "Another string value",
"doesNotMatchViolationSeverity" : "Another string value",
"matchAction" : "Another string value",
"matchConditionNumber" : "Another string value",
"matchFix" : "Another string value",
"matchViolationMessage" : "Another string value",
"matchViolationMessageId" : "Another string value",
"matchViolationMessageType" : "Another string value",
"matchViolationSeverity" : "Another string value",
"operator" : "Another string value",
"operatorFunction" : {
"functionName" : "Another string value",
"params" : {
"params" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : false,
"showCommand" : "Another string value",
"value" : "Another string value"
} ]
},
"ruleDescription" : "String value",
"ruleId" : "String value",
"ruleImpact" : "String value",
"ruleInputList" : {
"ruleInputList" : [ {
"cardinality" : true,
"customConstraint" : {
"accessMode" : "String value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another 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"
}, {
"id" : "Another string value",
"value" : "Another 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
}, {
"cardinality" : false,
"customConstraint" : {
"accessMode" : "Another string value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another string value" ]
},
"defaultvalue" : "Another string value",
"description" : "Another string value",
"inputScope" : "Another string value",
"isLov" : false,
"isRequired" : "Another string value",
"key" : "Another string value",
"mapOfLOVList" : {
"mapOfLOVList" : [ {
"id" : "String value",
"value" : "String value"
}, {
"id" : "Another string value",
"value" : "Another string value"
} ]
},
"maxInclusive" : "Another string value",
"maximumLength" : "Another string value",
"minInclusive" : "Another string value",
"regularExpression" : "Another string value"
},
"inputDataType" : "Another string value",
"inputId" : "Another string value",
"inputScope" : "Another string value",
"inputTitle" : "Another string value",
"isRequired" : false
} ]
},
"ruleSuggestedfix" : "String value",
"ruleTitle" : "String value"
}, {
"applicablePlatformList" : {
"applicablePlatformList" : [ {
"platformId" : "String value"
}, {
"platformId" : "Another 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"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : true,
"showCommand" : "String value",
"value" : "String value"
}, {
"blockEachFailingInstance" : false,
"blockEndExpression" : "Another string value",
"blockRulePass" : "Another string value",
"blockStartExpression" : "Another string value",
"conditionId" : "Another string value",
"conditionScope" : "Another string value",
"conditionsEachFailingInstance" : false,
"conditionsRulePass" : "Another string value",
"deviceProperty" : "Another string value",
"displayString" : "Another string value",
"doesNotMatchAction" : "Another string value",
"doesNotMatchConditionNumber" : "Another string value",
"doesNotMatchFix" : "Another string value",
"doesNotMatchViolationMessage" : "Another string value",
"doesNotMatchViolationMessageId" : "Another string value",
"doesNotMatchViolationMessageType" : "Another string value",
"doesNotMatchViolationSeverity" : "Another string value",
"matchAction" : "Another string value",
"matchConditionNumber" : "Another string value",
"matchFix" : "Another string value",
"matchViolationMessage" : "Another string value",
"matchViolationMessageId" : "Another string value",
"matchViolationMessageType" : "Another string value",
"matchViolationSeverity" : "Another string value",
"operator" : "Another string value",
"operatorFunction" : {
"functionName" : "Another string value",
"params" : {
"params" : [ {
"name" : "String value",
"value" : "String value"
}, {
"name" : "Another string value",
"value" : "Another string value"
} ]
}
},
"parseAsBlocks" : false,
"showCommand" : "Another string value",
"value" : "Another string value"
} ]
},
"ruleDescription" : "Another string value",
"ruleId" : "Another string value",
"ruleImpact" : "Another string value",
"ruleInputList" : {
"ruleInputList" : [ {
"cardinality" : true,
"customConstraint" : {
"accessMode" : "String value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another 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"
}, {
"id" : "Another string value",
"value" : "Another 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
}, {
"cardinality" : false,
"customConstraint" : {
"accessMode" : "Another string value",
"defaultValues" : {
"defaultValues" : [ "String value", "Another string value" ]
},
"defaultvalue" : "Another string value",
"description" : "Another string value",
"inputScope" : "Another string value",
"isLov" : false,
"isRequired" : "Another string value",
"key" : "Another string value",
"mapOfLOVList" : {
"mapOfLOVList" : [ {
"id" : "String value",
"value" : "String value"
}, {
"id" : "Another string value",
"value" : "Another string value"
} ]
},
"maxInclusive" : "Another string value",
"maximumLength" : "Another string value",
"minInclusive" : "Another string value",
"regularExpression" : "Another string value"
},
"inputDataType" : "Another string value",
"inputId" : "Another string value",
"inputScope" : "Another string value",
"inputTitle" : "Another string value",
"isRequired" : false
} ]
},
"ruleSuggestedfix" : "Another string value",
"ruleTitle" : "Another string value"
} ]
}
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/compliance/policy
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/compliance/policy" rootUrl="https://localhost/webacs/api/v4/op">
<complianceResult>
<isSuccess>true</isSuccess>
<message>String value</message>
</complianceResult>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/compliance/policy.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/compliance/policy",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"complianceResult" : [ {
"isSuccess" : true,
"message" : "String value"
} ]
}
}