Jump to

• Request
• Response

View Workflow Instances

get

/api/restapi/workflowInstance

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

Request

Query Parameters

• workflowConfigurationName(required): string
  User defined identifier of a workflow configuration.
  This is a required field.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer(int64)
  The system-generated identifier of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityWorkflowInstance>

Type: array

Title: List<ApiEntityWorkflowInstance>

Show Source

• Array of: object ApiEntityWorkflowInstance
  Title: ApiEntityWorkflowInstance

{
    "title":"List<ApiEntityWorkflowInstance>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkflowInstance",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityWorkflowInstance

Type: object

Title: ApiEntityWorkflowInstance

Show Source

• actualDuration: number (double)
  Actual Duration in days taken by the Workflow Instance to reach state of termination i.e status which is completed/stopped/failed.
• configurationVersion: integer (int64)
  Version of the workflow configuration that was used to create the workflow instance.
• context: string
  Maximum Length: 0

  The specific object that the workflow runs against.
• contextType: string
  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.
• dueDate: string (date-time)
  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: array managers
  User/s who were assigned to manage the workflow instance.
• plannedDuration: number (double)
  Duration in days that was planned for the workflow instance to be completed. Post this duration the workflow instance will be marked as overdue.
• startedBy: string
  Maximum Length: 0

  The user who started the workflow instance.
• startedDate: string (date-time)
  The date and time the workflow instance started.
• status: string
  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.
• workflowConfigurationName: string
  Maximum Length: 255

  The name of the workflow configuration. Task performers and workflow managers identify running workflows by the names of their configurations.
• workflowInstanceId: integer (int64)
  System generated unique identifier of the workflow instance.
• workflowInstanceName: string
  Maximum Length: 255

  Name of the workflow instance within which the task is configured.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.
• workspaceName: string
  Maximum Length: 255

  Name of a workspace.

{
    "title":"ApiEntityWorkflowInstance",
    "type":"object",
    "properties":{
        "context":{
            "maxLength":"0",
            "type":"string",
            "description":"The specific object that the workflow runs against.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the workflow instance. A workflow instance can have a status of In Progress, Finished, Overdue, Failed, Pending, or Stopped.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EXECUTING",
                "FINISHED",
                "HALTED",
                "PENDING",
                "STOPPED"
            ]
        },
        "actualDuration":{
            "type":"number",
            "description":"Actual Duration in days taken by the Workflow Instance to reach state of termination i.e status which is completed/stopped/failed.",
            "format":"double",
            "exampleSetFlag":false
        },
        "plannedDuration":{
            "type":"number",
            "description":"Duration in days that was planned for the workflow instance to be completed. Post this duration the workflow instance will be marked as overdue.",
            "format":"double",
            "exampleSetFlag":false
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "contextType":{
            "type":"string",
            "description":"The kind of object that the workflow runs against or displays information about.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "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"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dueDate":{
            "type":"string",
            "description":"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",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workflowInstanceId":{
            "type":"integer",
            "description":"System generated unique identifier of the workflow instance.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "startedDate":{
            "type":"string",
            "description":"The date and time the workflow instance started.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startedBy":{
            "maxLength":"0",
            "type":"string",
            "description":"The user who started the workflow instance.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workflowConfigurationName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the workflow configuration. Task performers and workflow managers identify running workflows by the names of their configurations.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configurationVersion":{
            "type":"integer",
            "description":"Version of the workflow configuration that was used to create the workflow instance.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "managers":{
            "type":"array",
            "description":"User/s who were assigned to manage the workflow instance.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "workflowInstanceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the workflow instance within which the task is configured.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : managers

Type: array

User/s who were assigned to manage the workflow instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"User/s who were assigned to manage the workflow instance.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

204 Response

Successful operation with no content.

400 Response

Invalid Input.

Back to Top