Simulate skip check

Dry-run of the skip rules against the supplied ticket or recent real events; nothing is touched.

POST /v1/brands/{brand_id}/config/simulate-skip

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/config/simulate-skip' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {},
  "ticket": {},
  "recent_limit": 1
}'

200

{
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rule_count": 1,
  "evaluated": 1,
  "would_skip": 1,
  "would_process": 1,
  "results": [
    {
      "ticket": "string",
      "should_skip": true,
      "reason": "Two-person tent, green — replacement for damaged pole set.",
      "error": "string"
    }
  ]
}

Path parameters

brand_id · string (uuid) · required

Request body

object

config · object

Candidate config; defaults to the saved binding config

ticket · object

A single ticket to evaluate; defaults to recent real events

recent_limit · integer

1–25, default 10

Response

object

brand_id · string (uuid) · required

rule_count · integer · required

evaluated · integer · required

would_skip · integer · required

would_process · integer · required

results · object[] · required

Show results

ticket · string · required

‘supplied’ or the recent-event label

should_skip · boolean

reason · string

error · string

Present instead of should_skip when the rule evaluation itself failed

Status codes

Code	Meaning
200	Dry-run of the skip rules against the supplied ticket or recent real events; nothing is touched.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/config/simulate-skip' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {},
  "ticket": {},
  "recent_limit": 1
}'

200

{
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "rule_count": 1,
  "evaluated": 1,
  "would_skip": 1,
  "would_process": 1,
  "results": [
    {
      "ticket": "string",
      "should_skip": true,
      "reason": "Two-person tent, green — replacement for damaged pole set.",
      "error": "string"
    }
  ]
}