GET /config/resource_restrictions/{resource_restriction_id}

Retrieves a resource restriction consumer by ID.

Retrieves a resource restriction consumer by ID.

Table 1. GET /config/resource_restrictions/{resource_restriction_id} resource details
MIME Type

application/json

Table 2. GET /config/resource_restrictions/{resource_restriction_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

resource_restriction_id

path

Required

String

text/plain

Required - The resource restriction ID of the resource restriction to be retrieved. Must be of the format [1-3]-\d+

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/resource_restrictions/{resource_restriction_id} response codes
HTTP Response Code Unique Code Description

200

The resource restriction consumer was successfully retrieved.

404

1003

No such resource restriction consumer (user, tenant, or role) exists for the given ID.

422

1002

Provided ID is not a valid format. must be [1-3]-\d+

500

1004

An error occurred during the retrtieval resource restrictions.

Response Description

The associated restriction object.

Response Sample


{
    "data_window": 42,
    "execution_time": 42,
    "id": "String",
    "record_limit": 42,
    "role_id": 42,
    "tenant_id": 42,
    "user_id": 42
}