View Workflow Instances

get

/api/restapi/workflowInstance

Send a request to this endpoint to view workflow instances under a workspace.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : List<ApiEntityWorkflowInstance>
Type: array
Title: List<ApiEntityWorkflowInstance>
Show Source
Nested Schema : ApiEntityWorkflowInstance
Type: object
Title: ApiEntityWorkflowInstance
Show Source
  • Actual Duration in days taken by the Workflow Instance to reach state of termination i.e status which is completed/stopped/failed.
  • Version of the workflow configuration that was used to create the workflow instance.
  • Maximum Length: 0
    The specific object that the workflow runs against.
  • Allowed Values: [ "APPLICATION_USER", "CAPITAL_PLAN", "CAPITAL_PLAN_PROJECT", "CAPITAL_PORTFOLIO", "COLUMN_DEFINTION", "NONE", "PROJECT", "PROJECT_CATEGORY_VALUE", "SEC_ROLE", "WORKFLOW_CONFIG", "WORKSPACE", "CONTRACT", "COMMITMENT", "RISK", "RISK_PROG", "SUBMITTAL", "CHANGEORDER", "BUDGET", "BUDGET_CHANGE", "BUDGET_TRANSFER", "PROGRAM_BUDGET", "PROGRAM_BUDGET_CHANGE", "PROGRAM_BUDGET_TRANSFER", "RFI", "IDEA", "PROGRAM", "POTENTIAL_CHANGE_ORDER", "CHANGE_EVENTS" ]
    The kind of object that the workflow runs against or displays information about.
  • The date by which the workflow should be completed. If a workflow is not completed by its due date, then the system notifies the workflow manager and marks the workflow as overdue
  • managers
    User/s who were assigned to manage the workflow instance.
  • Duration in days that was planned for the workflow instance to be completed. Post this duration the workflow instance will be marked as overdue.
  • Maximum Length: 0
    The user who started the workflow instance.
  • The date and time the workflow instance started.
  • Allowed Values: [ "EXECUTING", "FINISHED", "HALTED", "PENDING", "STOPPED" ]
    The status of the workflow instance. A workflow instance can have a status of In Progress, Finished, Overdue, Failed, Pending, or Stopped.
  • Maximum Length: 255
    The name of the workflow configuration. Task performers and workflow managers identify running workflows by the names of their configurations.
  • System generated unique identifier of the workflow instance.
  • Maximum Length: 255
    Name of the workflow instance within which the task is configured.
  • Maximum Length: 60
    The user-specified identifier of a workspace.
  • The unique identifier of a workspace.
  • Maximum Length: 255
    Name of a workspace.
Nested Schema : managers
Type: array
User/s who were assigned to manage the workflow instance.
Show Source

204 Response

Successful operation with no content.

400 Response

Invalid Input.

404 Response

The requested object does not exist, or you do not have access to it.
Back to Top