Endpoints for working with policy management
With the policy management API service, you can create, list, update, and delete the policies.
A policy API consists of the following elements:
- pol_id
- The name of the policy.
- action_id
- The action to perform.
- action_params
- The action contains the following elements:
- tags
- The type of actions. Currently, the only type of action is the AUTOTAG action. For information about using the AUTOTAG action, see the topic Adding fields with the AUTOTAG action.
- pol_filter
- A search filter to select a set of documents to work on.
- schedule
- The schedule for processing the operation:
- NOW
- The action is done immediately.
- dayOfWeek, hour, month, timezone, minute, dayOfMonth
- The action is done at the specified time.Note: The API supports the creation of a schedule by using a timezone parameter. Internally, this information is converted to Coordinated Universal Time (UTC). It is recommended that the timezone parameter is not used or that the default of Coordinated Universal Time (UTC) is used in the API, because the policy schedule time is not displayed in the GUI. The GUI assumes that all times are in Coordinated Universal Time (UTC).
The policy engine runs the specified policy based on the schedule and the action ID that are specified in the API. The policy operations are applied to the documents that are specified by the filter.