plannedChanges
Add a planned change definition
Creates a new planned change ruleset definition with the specified name, display name, and filter rules. Optionally set DisallowRules to create a container for manually added events without automatic rule matching. Returns the created definition.
Add a planned change definition
Submits a request to create a new planned change ruleset definition. Provide the name, display name, rules, and rule combination operator in the request body.
Upload a planned change ruleset json file
Uploads a planned change ruleset as a JSON file, creating or replacing the corresponding definition on the hub. Use this endpoint to import exported planned change configurations.
Download a planned change ruleset json file
Downloads the specified planned change ruleset as a JSON file. Use the IncludeAttributeRuleList and IncludeAttributeRuleText parameters to control whether list-based attribute rule data is included in the export.
Download a planned change ruleset json file
Submits a request to download a planned change ruleset as a JSON file. Provide the ruleset ID and export options in the request body.
Update a planned change definition
Updates the specified planned change ruleset definition, including its display name, description, rules, and rule combination operator. The internal Name cannot be changed. Returns the updated definition.
Update a planned change definition
Submits a request to update a planned change ruleset definition. Provide the Name identifying the ruleset and any fields to change in the request body.
Clone a planned change definition
Creates a copy of the specified planned change ruleset definition, identified by its internal Name. Returns the new cloned definition with a system-generated name.
Clone a planned change definition
Submits a request to clone a planned change ruleset definition. Provide the Name of the definition to copy in the request body.
Create planned change rule reduction
Analyzes the specified planned change ruleset and generates rule reduction plans that can simplify the associated rules. For example, two exact filename matches within the same directory may be combined into a single wildcard rule. Returns reduction plan suggestions without applying them.
Create planned change rule reduction
Submits an analysis request to generate rule reduction plans for the specified planned change. Provide the planned change Name and the rule IDs to evaluate in the request body.
Apply planned change rule reduction
Applies a previously generated rule reduction plan to the specified planned change, removing redundant rules and replacing them with the simplified alternatives. Returns no content on success.
Apply planned change rule reduction
Submits a request to apply a rule reduction plan to the specified planned change. Provide the planned change Name, rule IDs to remove, and the reduction plan details in the request body.
Update planned change rule
Updates a single filter rule within an existing planned change definition. Use this endpoint to modify individual rule attributes without replacing the entire ruleset.
Update planned change rule
Submits a request to update a single filter rule in an existing planned change definition. Provide the rule update details in the request body.
Update planned change rule set
Replaces the entire rule set in the specified planned change definition with the provided rules. This endpoint is deprecated; use the individual rule update endpoints for new integrations.
Update planned change rule set
Submits a request to replace the entire rule set in the specified planned change definition. This endpoint is deprecated; use the individual rule update endpoints for new integrations.
Remove rule from planned change
Removes a specific filter rule, identified by its ID, from the specified planned change definition. Returns no content on success.
Remove rule from planned change
Submits a request to remove a filter rule from a planned change definition. Provide the planned change name and the rule ID in the request body.
Delete a planned change ruleset
Permanently deletes the specified planned change ruleset definition from the system, identified by Name. This action cannot be undone; consider cloning the definition before deleting if you may need it later.
Delete a planned change ruleset
Submits a request to permanently delete a planned change ruleset definition. Provide the Name of the definition to remove in the request body.
Get planned change ruleset definitions
Returns a paged list of planned change ruleset definitions, optionally filtered by name or display name. Use the DisallowRules filter to find definitions that act as manual event containers only.
Get planned change ruleset definitions
Submits a request to retrieve planned change ruleset definitions. Provide name filters and pagination options in the request body.