Get limits set on data sources for a user account

Hybrid Data Pipeline API reference : Administrators API : Limits API : Get limits set on data sources for a user account

Try Now

Purpose

Retrieves limits that have been set on data sources which belong to a specified user account.

URL

https://<myserver>:<port>/api/admin/limits/users/{userId}/datasources

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The following parameters are also required.

Parameter	Description	Valid Values
{userId}	The ID of the user account to which the data sources belong.	The ID is auto-generated when the user account is created and cannot be changed.

Response Definition

The response takes the following format.

{
"dataSourceLimits": [
{
"dataSourceId": datasource_id,
"dataSourceName": "datasource_name",
"isGroup": true | false,
"limits": [
{
"id": limit_id,
"value": limit_value
},
...
]
},
...
]
}

Properties	Description	Valid Values
"dataSourceId"	The ID of the data source.	The data source ID is auto-generated when the data source is created and cannot be changed.
"dataSourceName"	The name of the data source.	The maximum length is 128 characters.
"isGroup"	Indicates whether the data source is a group data source.	true \| false true if the data source is a group data source. false if the data source is not a group data source.
"limits"	A list of limits that have been set on the data source. Includes the "id" and "value" properties where the "id" is the ID of the limit, and "value" is the value of the limit.	MaxRowFetchSize (1) and ODataMaxConcurrentQueries (6) are the only limits that can be set on a data source.

Sample Server Success Response

Status code: 204
Successful response

{
"datasourceLimits": [
{
"dataSourceId": 1,
"dataSourceName": "DataSource1",
"isGroup": false,
"limits": [
{
"id": 1,
"value": 1000
},
{
"id": 6,
"value": 100
}
]
},
{
"dataSourceId": 2,
"dataSourceName": "DataSource2",
"isGroup": false,
"limits": []
}
]
}

Sample Server Failure Response

{
"error": {
"code": 222207028,
"message": {
"lang": "en-US",
"value": "Missing 'userId' in payload."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) or the Limits (27) permission.