Create a new Scenario

Creates a new scenario under a specified scenario configuration. You must provide a name, description, and specification in the request body.

Path Params
uuid
required

Scenario Configuration Identifier under which the new scenario will be created

Body Params

Payload containing details for the draft scenario (name, description, specification)

string
required

A free-text description of what the scenario detects.

string
required

The name of the scenario.

specification
object
required

Wrapper object for a Specification. The full scenario logic is nested under the 'value' key. Segments are pre-defined — choose from the available list when building a scenario. An empty segments list is valid when no segments apply. Drives the outcome (HOLD/ALLOW) and alert priority for each evaluation.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json