Skip to main content
Version: 2025 R2

Reading the data source

The Data Source tab allows you to configure the application data source, the contents of which will be available for download by the endpoint defined in the Get data from the data source mode.

Data Source

Specifying the data source and filtering data​

The application data source available for this endpoint should be indicated in the Data Source field. In the Filter field, you can define conditions that narrow the scope of returned data. By default, the endpoint returns a maximum of 1000 rows.

The filter can use parameters defined in the Parameters tab, which allows you to dynamically limit data based on values ​​passed when calling the endpoint. The parameter values ​​should be passed in the query string. The parameter names in the query string must match the names defined in the Parameters tab, e.g.:

https://webconbps.com/api/udef/db/1/MyEndpoint?Param1=value1

Retrieving data from a subsource​

If the shared data source has subsources defined for companies, the predefined businessEntity parameter should be used to retrieve data from a specific subsource. This parameter can take the value: ID, GUID or company code. This will allow you to retrieve data from the source assigned to the indicated company.

https://webconbps.com/api/udef/db/1/MyEndpoint?businessEntity=82

Range of returned data​

The range of returned data, i.e. columns sent in response after calling the endpoint, is specified in the Returned Columns field. The column names in the response correspond to the values ​​entered as Display Name in the returned columns configuration. The result of the call is returned in JSON format. The output data is placed in an array located in the Data node, e.g.:

{
    "Data":
    [
        {
            "Instance number": "744453",
            "Assigned to": "Tom Green",
            "Registration date": "2025-04-28"
        }
    ]
}

Permissions​

If the shared source is BPS Source, the scope of the returned data is additionally limited taking into account the permissions of the user in the context of which the endpoint was called, to individual elements in the source. If the Access to data in the context of the system account option is set in the source configuration or if the source is of a different type that does not take into account user permissions, access to data is not limited by permissions to elements.