Workflows

Retrieve Workflow Revision

Changed on
post/workflows/revisions/retrieve

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/workflows/revisions/retrieve
  • Auth
    API key in header Authorization

Request body

keystring nullable

Key into the environment revision's reference map. Required when retrieving via environment refs.

resolveboolean nullable

When true, resolve @ag.references tokens embedded in the revision configuration before returning it.

include_archivedboolean nullable

When false, an archived workflow, variant, or revision resolves to nothing.

Response

Successful Response

countinteger

1 when a revision is returned, 0 when none matched.

status'committed' | 'no_change' nullable

Commit outcome. no_change means the change produced the stored configuration, so no revision was created and workflow_revision is the current head. Absent on paths that do not run the checked commit; a reader must treat absent as committed.

Changes

  • a28f1d059149Revision changes
    • info

      added the new optional request property

  • 139f8db295daRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status