Developer Documentation

PolicyDraft

A draft which stores the system generated as well as user intended changes in a hierarchical body format.


Properties

Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _protection string

Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.

optional _revision integer

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional id string

Unique identifier of this resource

optional is_auto_draft boolean

Flag to indicate whether draft is auto created. True indicates that the draft is an auto draft. False indicates that the draft is a manual draft.

optional lock_comments string

Comments for a policy draft lock/unlock.

optional lock_modified_by string

ID of the user who last modified the lock for a policy draft.

optional lock_modified_time integer

Policy draft locked/unlocked time in epoch milliseconds.

optional locked boolean

Indicates whether a draft should be locked. If the draft is locked by an user, then no other user would be able to modify or publish this draft. Once the user releases the lock, other users can then modify or publish this draft.

optional marked_for_delete boolean

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.

optional parent_path string

Path of its parent

optional path string

Absolute path of this object

optional ref_draft_path string

When specified, a manual draft will be created w.r.t. the specified draft. If not specified, manual draft will be created w.r.t. the current published configuration. For an auto draft, this will always be null.

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional system_area Infra

Configuration changes against the current configuration, tracked by the system. The value is stored in a hierarchical body format.

optional tags array of Tag

Opaque identifiers meaningful to the API user

optional user_area Infra

These are user defined configuration changes, which are applicable only in case of manual drafts. During the publish of a draft, system_area changes gets applied first, and then these changes. The value must be in a hierarchical body format.

Feedback

Was this page helpful?