Get shared workflow status projection

GET

/workflow-status-projections/{workflowKind}/{workflowRequestId}

const url = 'https://example.com/workflow-status-projections/reservation_booking/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/workflow-status-projections/reservation_booking/example \
  --header 'Authorization: Bearer <token>'

Authorizations

supabaseBearerAuth

Parameters

Path Parameters

workflowKind

required

string

Allowed values: reservation_booking reservation_payment reservation_financial_lifecycle member_privacy_lifecycle branch_settlement_reconciliation_export

workflowRequestId

required

string

>= 1 characters

Responses

200

Portal-safe workflow status projection

application/json

WorkflowStatusProjection

object

workflowKind

required

string

Allowed values: reservation_booking reservation_payment reservation_financial_lifecycle member_privacy_lifecycle branch_settlement_reconciliation_export

workflowRequestId

required

string

>= 1 characters

workflowName

required

string

>= 1 characters

workflowKey

required

string

>= 1 characters

workflowStateEngine

required

string

Allowed value: restate

actorUserId

required

string | null

>= 1 characters

actorRole

required

string | null

>= 1 characters

sourcePortal

required

string

>= 1 characters

commandName

required

string

>= 1 characters

businessEntityId

required

string

>= 1 characters

durableStep

required

string

>= 1 characters

publicStatus

required

string

Allowed values: in_progress blocked completed failed cancelled

retryState

required

string

>= 1 characters

blockedReason

required

string | null

>= 1 characters

failureReason

required

string | null

>= 1 characters

startedAt

required

string format: date-time

lastTransitionAt

required

string | null format: date-time

completedAt

required

string | null format: date-time

updatedAt

required

string format: date-time

resultingReadModelIds

required

object

key

additional properties

string

>= 1 characters

key

additional properties

401

Supabase bearer token is required

403

Actor cannot view workflow status projection

404

Workflow status projection not found

503

Workflow status projection reader is unavailable