Jump to

• Request
• Response

View Workflow Step Tasks

get

/api/restapi/workflowInstance/steps/tasks

Send a request to this endpoint to view tasks under the given steps.

Request

Query Parameters

• stepNames: string
  Comma separated user defined identifiers of workflow steps.
• workflowInstanceIds(required): string
  Comma separated system defined identifiers of workflow instances.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response will be in the format of Map<Long, Map<String, Map<DateTime, List<ApiEntityStepInstance>>>> which is a map of provided workflowInstanceId as key and value is a map of the step names as keys and their values are a map of start dates and list of their task instances as values.For example:
{
"1": [{
"completedDate": "2024-03-01T06:56:01",
"stepName": "Start",
"startedDate": "2024-03-01T06:56:00",
"workflowInstanceId": 1,
"tasksCompleted": 0,
"context": "P1",
"status": "FINISHED",
"workflowInstanceName": "Project Closeout"
},
{
"stepName": "Sponsor Decision",
"startedDate": "2024-03-01T06:56:33",
"workflowInstanceId": 1,
"tasksCompleted": 0,
"context": "P1",
"status": "EXECUTING",
"workflowInstanceName": "Project Closeout"
}],
"2": [{
"completedDate": "2024-03-01T07:18:49",
"stepName": "Start",
"startedDate": "2024-03-01T07:18:48",
"workflowInstanceId": 2,
"tasksCompleted": 1,
"context": "P1",
"status": "FINISHED",
"workflowInstanceName": "Project Closeout"
},
{
"stepName": "Sponsor Decision",
"startedDate": "2024-03-01T07:19:13",
"workflowInstanceId": 2,
"tasksCompleted": 1,
"context": "P1",
"status": "EXECUTING",
"workflowInstanceName": "Project Closeout"
}]
}
API fetches all the Task Instances records based on the given workflowInstanceIds, stepNames and the given OOTB (filtering, pagination, sorting, record count) query parameterss and then groups the results by workflowInstanceIds, stepNames & startDates at the end. OOTB feature is available on all the ApiEntityTaskInstance records and users can provide the ApiEntityTaskInstance fields (except for those mentioned in Unsupported Fields for Entity Filtering page) as OOTB query params. For example:
/api/restapi/workflowInstance/steps/tasks?workflowInstanceIds=1,2&stepNames=Complete Project Details and Checklist&filters=status=FINISHED&start=0,limit=5

Sorting will work inside the groups.

Since the response is in a form of a map, user need to follow the hierarchy for projection. In above response exmaple, to select 'status' for '1' workflowInstanceId, user should be to providing:/api/restapi/workflowInstance/steps/tasks?workflowInstanceIds=1,2&stepNames=Complete Project Details and Checklist&select=1.Complete Project Details and Checklist.2024-03-01T06:56:02.000Z.status

Body ()

Root Schema : List<ApiEntityTaskInstance>

Type: array

Title: List<ApiEntityTaskInstance>

Show Source

• Array of: object ApiEntityTaskInstance
  Title: ApiEntityTaskInstance

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

Nested Schema : ApiEntityTaskInstance

Type: object

Title: ApiEntityTaskInstance

Show Source

• completedDate: string (date-time)
  Date & Time of when the task was started.
• completionPolicy: string
  Allowed Values: [ "ALL", "ANY", "MAJORITY" ]

  Completion policy set for the task.
• context: string
  Maximum Length: 0

  Name of the context object on which the task is executed.
• formName: string
  Applicable only for form tasks. Name of the form which is associated with the task.
• formVersion: integer (int64)
  Applicable only for form tasks. Version of the form which is associated with the task.
• performers: array performers
  List of performers that have been assigned to the task.
• startedDate: string (date-time)
  Date & Time of when the task was started.
• status: string
  Allowed Values: [ "EXECUTING", "FINISHED", "FAILED", "SKIPPED" ]

  Current Status of the task.
• stepName: string
  Maximum Length: 255

  Name of the step within which the task is configured.
• taskName: string
  Maximum Length: 255

  Name of the task.
• taskType: string
  Maximum Length: 60

  Allowed Values: [ "Form", "Sub-workflow", "Portfolio Refresh", "Update Field", "Services", "Decision" ]

  Type of task.
• 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.

{
    "title":"ApiEntityTaskInstance",
    "type":"object",
    "properties":{
        "context":{
            "maxLength":"0",
            "type":"string",
            "description":"Name of the context object on which the task is executed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"Current Status of the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "EXECUTING",
                "FINISHED",
                "FAILED",
                "SKIPPED"
            ]
        },
        "taskName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "taskType":{
            "maxLength":"60",
            "type":"string",
            "description":"Type of task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "Form",
                "Sub-workflow",
                "Portfolio Refresh",
                "Update Field",
                "Services",
                "Decision"
            ]
        },
        "completedDate":{
            "type":"string",
            "description":"Date & Time of when the task was started.",
            "format":"date-time",
            "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":"Date & Time of when the task was started.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "completionPolicy":{
            "type":"string",
            "description":"Completion policy set for the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ALL",
                "ANY",
                "MAJORITY"
            ]
        },
        "formName":{
            "type":"string",
            "description":"Applicable only for form tasks. Name of the form which is associated with the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "formVersion":{
            "type":"integer",
            "description":"Applicable only for form tasks. Version of the form which is associated with the task.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "performers":{
            "type":"array",
            "description":"List of performers that have been assigned to the task.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityTaskPerformer",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "stepName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the step within which the task is configured.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 : performers

Type: array

List of performers that have been assigned to the task.

Show Source

• Array of: object ApiEntityTaskPerformer
  Title: ApiEntityTaskPerformer

{
    "type":"array",
    "description":"List of performers that have been assigned to the task.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityTaskPerformer",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityTaskPerformer

Type: object

Title: ApiEntityTaskPerformer

Show Source

• dateCompleted: string (date-time)
  The date and time when the performer completed the task.
• status: string
  Allowed Values: [ "STOPPED", "FINISHED", "FAILED", "EXECUTING", "SKIPPED" ]

  The status of the task assignment for the performer.
• userName: string
  Maximum Length: 0

  List of performers that have been assigned to the task.

{
    "title":"ApiEntityTaskPerformer",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The status of the task assignment for the performer.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "STOPPED",
                "FINISHED",
                "FAILED",
                "EXECUTING",
                "SKIPPED"
            ]
        },
        "userName":{
            "maxLength":"0",
            "type":"string",
            "description":"List of performers that have been assigned to the task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateCompleted":{
            "type":"string",
            "description":"The date and time when the performer completed the task.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

400 Response

Invalid Input.

Back to Top