workflows

Preview a workflow run

External credential scope: read:records. Minimum farm role: EDITOR. Resolves literal and today defaults once, returns a non-committable preview with structured issues for field/domain problems, and creates no livestock records.

post/v1/farm/{farm_id}/workflows/preview

Request

  • Base URL: https://api.ranch.bot
  • URL: https://api.ranch.bot/v1/farm/{farm_id}/workflows/preview
  • Auth: HTTP bearer

Path parameters

farm_idstring uuid required

Request body

request_idstring uuid required
template_idstring uuid required
template_versioninteger
timezonestring
replaces_preview_idstring uuid

Response

Success

preview_idstring uuid required
template_idstring uuid required
template_versioninteger required
resolved_valuesobject
default_sourcesobject
reviewobject nullable

The stored, authorized review snapshot: dam identity/metadata, dam history, resolved group names, identifier warnings, unresolved facts, and remaining birth-review fields. Null when preparation produced no review. Duplicate identifiers are advisory warnings here, never blocking errors or merges.

preview_hashstring required
expires_atstring date-time
status'pending' | 'invalid' | 'replaced' | 'committed' | 'discarded' required
committed_atstring date-time
saved_entity_idsobject
outcomeobject

Changes

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