Pega Platform provides data view endpoints to query data pages or to retrieve specific parameters from a data page. You use the data view endpoints to get the data that is required to develop your application, for example, when you build a custom UI.

Note: In the Pega API, you refer to "data pages" as "data views".

To use different endpoints to obtain the right data, review the information about each data view endpoint. For more information, see Data view endpoints.

Data view endpoints belong to the V2 DX API service package. For more information, see DX API Version 2 and Accessing and testing Pega DX API Version 2.

You can use the following data pages to retrieve data with the data view API:

• D_MyTaskFilters
• D_MyTasks
• D_GetCases

D_MyTaskFilters

Use the D_MyTaskFilters data page to retrieve a list of work queues that are associated with the current user. The data page also returns a list of active registrations in Pega Process Fabric Hub.

The data that the D_MyTaskFilters data page returns can also be used for applying more filters on the D_MyTasks data page.

The following table presents the structure of the D_MyTaskFilters data page:

D_MyTasks

Use the D_MyTasks data page to retrieve tasks from the current user's worklist along with tasks from all the work queues that are associated with the user. The work queues can belong to multiple applications.

The following table presents the structure of the D_MyTasks data page:

D_GetCases

Use the D_GetCases data page to retrieve cases that the current user follows or cases of which the current user is a work party in all the active applications.

You can retrieve a subset of the data by passing the following parameters to the D_GetCases data page:

CaseStatus

The parameter that retrieves the status of cases that the API returns.

EndDate

The parameter that retrieves cases that are updated after a given date.

For more information about using parameters with data pages, see Data pages and parameters and Use case: Referencing data in a data page by using parameters.

The following table presents the structure of the D_GetCases data page:

A sample use of DX API to retrieve task and case data

You can retrieve task and case data from Pega Process Fabric Hub by using data pages and data view endpoints. For more information, see Data view endpoints.

The data that you retrieve is associated with the user that is defined by the OAuth configuration.

The D_MyTasks and D_GetCases data pages return data for a given user.

If you want to apply additional filters, pass the filter criteria as part of the request body of the REST call. For example, to retrieve a list of tasks from a user’s worklist, use the following sample request body:

{
  "dataViewParameters": {}, 
  "paging": {
    "pageNumber": 1,
    "pageSize": 41
  },
  "query": {
    "select": [
      {
        "field": "Priority"
      },
      {
        "field": "DeadlineTime"
      },
      {
        "field": "RegistrationID"
      },
      {
        "field": "ID"
      },
      {
        "field": "pyLabel"
      },
      {
        "field": "AssignToType"
      },
      {
        "field": "AssignTo"
      }
    ],
    "filter": {
      "logic": "T1",
      "filterConditions": {
        "T1": {
          "comparator": "CONTAINS",
          "lhs": {
            "field": "AssignTo"
          },
          "rhs": {
            "value": "<OperatorID>"
          },
          "ignoreCase": true
        }
      }
    }
  }
}

In a similar way, you can retrieve tasks for a specific work queue and application by passing the work queue ID or the registration ID, respectively, in the filter condition.

You can obtain the list of work queues and registration IDs by calling the D_MyTaskFilters data page.

Properties that belong to joined classes cannot be retrieved by specifying a selected JSON object in the request body. For more information, see Associations. You need to add such properties to the MyTasksPost and GetCasesPost post-processing activities, which you then reference on the Definition tabs of the D_MyTasks and D_GetCases data pages respectively.

For example, the following D_MyTasks data page references the MyTasksPost activity in the Post load processing section, on the Definition tab of the data page:

For more information, see Creating a data page.

Security while connecting to DX API

To retrieve data from Pega Process Fabric Hub, you need to configure the OAuth authentication between Pega Process Fabric Hub and the remote system that receives the data. As specified by the JWT token or OAuth Client registration configuration, the retrieved data is specific to the user that makes the DX API call.

For more information about OAuth configuration, see Security Settings for DX API and Configuring an OAuth 2.0 authentication profile.