Rules

Preview an atomic rule-configuration change set

Check a complete proposed rule configuration and return its changes, warnings, and the preview_token and request_hash to apply it.

post/v1/programs/{program_id}/rule-configuration/preview

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/programs/{program_id}/rule-configuration/preview
  • Auth: HTTP bearer

Path parameters

program_idstring uuid required

The program's id.

Request body

PreviewRuleConfigurationRequest required(unresolved $ref)

Response

The planned changes, and the token and hash to apply them

base_rule_configuration_versioninteger

Configuration version the preview was planned from.

change_idstring uuid

The id of this change. The apply response and the revision history carry the same id.

expires_atstring date-time

When preview_token stops working.

local_referencesobject

Mapping from each client_ref to its preview-allocated stable UUID.

preview_tokenstring

The token to send to apply. Nobody else can use it, and it stops working at expires_at.

request_hashstring

The hash to send to apply with preview_token.

Changes

No recorded changes to this operation across all 1 revision of this API.