Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idDONE

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje18 MAY 20212021 SummerPage created.


...

As of Version

product version 2020 Autumn | component version 

Request MethodGET
Response FormatJSON
Description


Excerpt

Retrieves a list of tasks corresponding to the businessKey specified as query parameter.

Additional query parameters are

  • the boolean active with default value true,
  • the boolean includeProcessVariables with default value true and

  • the string processInstanceId

    The following query parameters can optionally be added to the request URL.

    ParameterTypeDescription
    businessKeystringOnly return process instances with the given businessKey.
    includeProcessVariablesbooleanInclude process variables in the result.
    pageinteger($int32)Results page you want to retrieve (0…N). Default is 0 which means the first page.
    processInstanceIdstringOnly return tasks which are part of the process instance with the given ID.
    sizeinteger($int32)Number of objects per page.
    sortstringSorting of results either ascending (asc) or descending (desc). Default sort order is ascending.

    Response HTTP status codes:

    HTTP Status CodeMeaning
    200The request was successful and the process instances are returned.
    400A parameter was passed in the wrong format. The status message contains additional information.



    Request Example

    https://<host>/api-web/api/bpm/tasks?active=true&businessKey=examplekey&includeProcessVariables=true

    no request body

    Response Example

    200 OK

    Code Block
    languageyml
    titleresponse body
    {
      "data": [],
      "total": 0,
      "start": 0,
      "sort": "id",
      "order": "asc",
      "size": 0
    }


    ...