Get package workflow info

GET

/api/workflow/{repo}/{packageName}

const url = 'https://example.com/api/workflow/example/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/api/workflow/example/example \
  --header 'Authorization: Bearer <token>'

Retrieves the current workflow state for a package

Authorizations

bearerAuth

Parameters

Path Parameters

repo

required

Repository CACHE_ROOT

string

packageName

required

Package name

string

Responses

200

Workflow info retrieved successfully

application/json

object

workflowInfo

required

object

workflowName

required

Name of the workflow definition

string

workflowInstanceId

External workflow engine instance ID

string

currentStep

required

Current step in the workflow

string

status

Current workflow status

string

default: active

Allowed values: active completed cancelled error

nextActionUrl

URL for the next action in external engine

string format: uri

startedAt

required

Unix timestamp when workflow started

number

completedAt

Unix timestamp when workflow completed

number

assignee

object

userName

required

User’s username/login

string

displayName

required

User’s display name

string

email

required

User’s email address

string

metadata

Additional metadata from external engine

object

key

additional properties

steps

Ordered list of workflow steps

Array<object>

default:

object

name

required

Step key

string

label

required

Display label

string

allowedActions

Actions allowed from this step

Array<string>

default:

Allowed values: start approve reject route cancel

assignedGroups

Security group IDs whose members can be assigned to this step

Array<string>

default:

history

History of workflow actions

Array<object>

default:

object

timestamp

required

Unix timestamp in milliseconds

number

action

required

The action that occurred

string

Allowed values: start approve reject route cancel assign status_update

fromStep

The step before this action (null for start)

string | null

toStep

required

The step after this action

string

user

object

userName

required

User’s username/login

string

displayName

required

User’s display name

string

email

required

User’s email address

string

comment

Optional comment for this action

string

externalReference

External system reference ID

string

Example

{
  "workflowInfo": {
    "workflowName": "content-approval",
    "workflowInstanceId": "wf-123",
    "currentStep": "review",
    "status": "active",
    "nextActionUrl": "https://engine/api/tasks/123/complete",
    "startedAt": 1706025600000,
    "completedAt": 1706112000000,
    "assignee": {
      "userName": "user@example.com",
      "displayName": "John Doe",
      "email": "user@example.com"
    },
    "steps": [],
    "history": []
  }
}

500

Internal server error

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}