toloka.client.TolokaClient.find_user_restrictions | Source code
Finds Toloker restrictions that match certain criteria.
The number of returned restrictions is limited. To find remaining restrictions call find_user_restrictions with updated search criteria.
To iterate over all matching Toloker restrictions you may use the get_user_restrictions method.
| Parameters | Type | Description |
|---|---|---|
scope | Optional[UserRestriction.Scope] | The scope of a restriction. Refer to the UserRestriction.Scope page for more information on the available |
user_id | Optional[str] | The Toloker's ID. |
project_id | Optional[str] | The ID of a project with restricted access. |
pool_id | Optional[str] | The ID of a pool with restricted access. |
id_lt | Optional[str] | Restrictions with IDs less than the specified value. |
id_lte | Optional[str] | Restrictions with IDs less than or equal to the specified value. |
id_gt | Optional[str] | Restrictions with IDs greater than the specified value. |
id_gte | Optional[str] | Restrictions with IDs greater than or equal to the specified value. |
created_lt | Optional[datetime] | Restrictions created before the specified date. |
created_lte | Optional[datetime] | Restrictions created before or on the specified date. |
created_gt | Optional[datetime] | Restrictions created after the specified date. |
created_gte | Optional[datetime] | Restrictions created after or on the specified date. |
sort | Union[List[str], UserRestrictionSortItems, None] | Sorting options. Default: |
limit | Optional[int] | Returned Toloker restrictions limit. The maximum allowed value: 500. |
Returns:
Found Toloker restrictions and a flag showing whether there are more matching restrictions exceeding the limit.
Return type:
Examples:
find_result = toloka_client.find_user_restrictions(sort=['-created', '-id'], limit=10)restrictions = find_result.itemsIf there are restrictions exceeding the limit, then find_result.has_more is set to True.
Last updated: August 28, 2023