Name |
Type |
Required |
Description |
attachedMarkers |
marker[] |
![Optional](../dash_status.png) |
Set of marker elements associated with the entity. |
attachedReminders |
reminder[] |
![Optional](../dash_status.png) |
List of reminders attached to the entity |
attachedSubscriptions |
subscription[] |
![Optional](../dash_status.png) |
List of subscriptions attached to the entity |
attributes |
attributeApplication[] |
![Optional](../dash_status.png) |
the property values of the corresponding AttributeDefinition defined in the
PolicyTemplate and PolicySchema are returned. Attribute Application values
are not applicable if the policy is not created from PolicyTempate. |
auditEvents |
beeId<eventDefinition>[] |
![Optional](../dash_status.png) |
Returns the audit events associated with this policy. |
bonds |
bond[] |
![Optional](../dash_status.png) |
List of artifact bonds |
changeStatus |
changeStatus |
![Optional](../dash_status.png) |
The change status of the artifact |
collabId |
beeId |
![Optional](../dash_status.png) |
CollabId of the snapshot |
container |
beeId |
![Optional](../dash_status.png) |
Returns the handle of the container where this policy is applied. |
createdOn |
dateTime |
![Optional](../dash_status.png) |
Entity's creation date |
creator |
actor |
![Optional](../dash_status.png) |
The actor that created this entity |
deleted |
boolean |
![Required](../checkmark_qualifier.png) |
Deletion flag. If this property is set to true the entity is
deleted. |
description |
string |
![Optional](../dash_status.png) |
Description of the policy |
enabled |
boolean |
![Required](../checkmark_qualifier.png) |
returns true if the policy is enabled, otherwise false. Policy is applicable and enforced
only if the policy is enabled. |
extensible |
boolean |
![Required](../checkmark_qualifier.png) |
|
modifiedBy |
actor |
![Optional](../dash_status.png) |
The actor that last modified the entity |
modifiedOn |
dateTime |
![Optional](../dash_status.png) |
The date when entity was last modified |
name |
string |
![Optional](../dash_status.png) |
Name of the entity. |
parent |
entity |
![Optional](../dash_status.png) |
The parent for this entity. |
properties |
collabProperties |
![Optional](../dash_status.png) |
The properties of the artifact that are shared among all the actors |
rules |
rule[] |
![Optional](../dash_status.png) |
The rules of a policy are either created in the policy itself or copied from the
policy template |
scope |
anyType |
![Optional](../dash_status.png) |
The level at which the policy is defined. It could be Enterprise, Organisation,
Workspace |
snapshotId |
string |
![Optional](../dash_status.png) |
Contains the snapshot identifier for this snapshot. Snapshot identifiers
are used to implement optimistic locking on the server. |
template |
policyTemplate |
![Optional](../dash_status.png) |
Policy template can be option at the creation time of a policy |
type |
policyType |
![Optional](../dash_status.png) |
|
userCreatedOn |
dateTime |
![Optional](../dash_status.png) |
The user creation date (if created offline) |
userModifiedOn |
dateTime |
![Optional](../dash_status.png) |
The user last modified date (if modified offline) |
viewer |
actor |
![Optional](../dash_status.png) |
The actor for which this artifact snapshot was loaded. All the artifact
viewer properties in this snapshot are loaded for this actor. |
viewerProperties |
collabProperties |
![Optional](../dash_status.png) |
The viewer properties of the artifact that are private to loading actor |