Data API — Rights
2 min
rights_describe
sync(client: AuthenticatedClient | Client, sort: list[RightSort] | Unset = UNSET, name: str | Unset = UNSET, description: str | Unset = UNSET, category: list[str] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[RightListItemResponse] | NoneParameter | Type | Default |
|---|---|---|
client | AuthenticatedClient | Client | required |
sort | list[RightSort] | Unset | UNSET |
name | str | Unset | UNSET |
description | str | Unset | UNSET |
category | list[str] | Unset | UNSET |
page | int | Unset | UNSET |
page_size | int | Unset | UNSET |
Returns: ProblemDetails | list[ErrorResponse] | list[RightListItemResponse] | None
Raises:
Exception | Condition |
|---|---|
If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. | |
TimeoutException | If the request takes longer than Client.timeout. |