Purpose

Creates a limit on a tenant.

URL

https://<myserver>:<port>/api/admin/limits/tenants/{tenantId}/{limitId}

Method

POST

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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
{tenantId} The ID of the tenant. The ID is auto-generated when the tenant is created and cannot be changed.
{limitId} The ID of the limit. MaxRowFetchSize (1) and ODataMaxConcurrentQueries (6) are the only limits that can be set on a user account.

Request Definition

    {
      "value": limit_value
    }
Property Description Valid Values
"value" The value of the limit. An integer that meets the requirements of the minimum and maximum values for the limit.

Sample Request Payload

    {
      "value": 400
    }

Sample Server Success Response 


      Status code: 201
      Successful response
            
    {
      "value": 400
    }

Sample Server Failure Response 

{
  "error": {
    "code": 222207929,
    "message": {
      "lang": "en-US",
      "value": "Limit value not in range({0}, {1})."
    }
  }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission, or the Limits (27) permission and administrative access on the tenant for which the limit is being set.