Api Documentation Data Structures
Clause
This data structure has no properties.
DataElement
JSON Example
{
"description": "string",
"id": "string",
"name": "string"
}
string
description
Optional
description
string
id
Optional
id
string
name
Optional
name
Policy
A policy such as lease policy that will be enforced.
JSON Example
{
"createdAt": "string",
"createdBy": "string",
"criteria": {
"matchExpression": [
{}
]
},
"description": "string",
"enforcementType": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"statistics": {
"conflictCount": "integer",
"enforcedCount": "integer",
"notEnforcedCount": "integer"
},
"typeId": "string"
}
string As date-time As date-time
createdAt
Optional
createdAt
string
createdBy
Optional
createdBy
object
definition
Optional
definition
string
description
Optional
description
string
enforcementType
Optional
enforcementType
string As uuid As uuid
id
Optional
id
string As date-time As date-time
lastUpdatedAt
Optional
lastUpdatedAt
string
lastUpdatedBy
Optional
lastUpdatedBy
string
name
Optional
name
string
orgId
Optional
orgId
string
projectId
Optional
projectId
string
typeId
Optional
typeId
PolicyDecisionOfObjectNode
A decision made to enforce policies.
JSON Example
{
"description": "string",
"dryRunId": "string",
"enforcementTaskId": "string",
"id": "string",
"orgId": "string",
"policies": [
{
"enforcementType": "string",
"id": "string",
"name": "string",
"projectId": "string",
"rank": "integer",
"status": "string"
}
],
"projectId": "string",
"targetId": "string",
"targetName": "string",
"timestamp": "string",
"typeId": "string"
}
string
description
Optional
description
string As uuid As uuid
dryRunId
Optional
dryRunId
object
effectivePolicyDefinition
Optional
effectivePolicyDefinition
string As uuid As uuid
enforcementTaskId
Optional
enforcementTaskId
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
projectId
Optional
projectId
string
targetId
Optional
targetId
string
targetName
Optional
targetName
string As date-time As date-time
timestamp
Optional
timestamp
string
typeId
Optional
typeId
PolicyDecisionPolicy
Element of a decision.
JSON Example
{
"enforcementType": "string",
"id": "string",
"name": "string",
"projectId": "string",
"rank": "integer",
"status": "string"
}
string
enforcementType
Optional
enforcementType
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
projectId
Optional
projectId
integer As int32 As int32
rank
Optional
rank
string
status
Optional
status
PolicyStats
JSON Example
{
"conflictCount": "integer",
"enforcedCount": "integer",
"notEnforcedCount": "integer"
}
integer As int64 As int64
conflictCount
Optional
conflictCount
integer As int64 As int64
enforcedCount
Optional
enforcedCount
integer As int64 As int64
notEnforcedCount
Optional
notEnforcedCount
PolicyType
A type of policy that includes the schema of the policy itself and the schema of the objects affected by the policy
JSON Example
{
"displayName": "string",
"id": "string",
"name": "string"
}
object
definitionSchema
Required
Schema describing a policy object of this type
string
displayName
Required
Policy type display-name/label
string
id
Required
Policy type ID
string
name
Required
Policy type name
object
targetSchema
Required
Schema describing objects that can be affected by this policy
Node: apidepo-liferay-dxp-v1-be-w-0:8080: