RoleApi¶
- class RoleApi[source]¶
Bases:
supervisely.api.module_api.ModuleApiBase
API for working with Roles.
RoleApi
object is immutable.- Parameters
- api : Api
API connection to the server
- Usage example
import os from dotenv import load_dotenv import supervisely as sly # Load secrets and create API object from .env file (recommended) # Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication if sly.is_development(): load_dotenv(os.path.expanduser("~/supervisely.env")) api = sly.Api.from_env() # Pass values into the API constructor (optional, not recommended) # api = sly.Api(server_address="https://app.supervise.ly", token="4r47N...xaTatb") roles = api.role.get_list() # api usage example
Methods
Get information about an entity by its ID from the Supervisely server.
List of all roles that are available on private Supervisely instance.
Get list of all or limited quantity entities from the Supervisely server.
This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
NamedTuple RoleInfo information about Role.
NamedTuple name - RoleInfo.
Attributes
MAX_WAIT_ATTEMPTS
Maximum number of attempts that will be made to wait for a certain condition to be met.
WAIT_ATTEMPT_TIMEOUT_SEC
Number of seconds for intervals between attempts.
- class DefaultRole[source]¶
Bases:
enum.IntEnum
class DefaultRole
-
ADMIN =
1
¶
-
ANNOTATOR =
3
¶
-
DEVELOPER =
2
¶
-
VIEWER =
4
¶
-
ADMIN =
- InfoType¶
alias of
supervisely.api.module_api.RoleInfo
- get_info_by_id(id)¶
Get information about an entity by its ID from the Supervisely server.
- Parameters
- id : int
ID of the entity.
-
get_list(filters=
None
)[source]¶ List of all roles that are available on private Supervisely instance.
- Parameters
- filters : list
List of params to sort output Roles.
- Returns
List of all roles with information. See
info_sequence
- Return type
List[RoleInfo]
- Usage example
import supervisely as sly os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly' os.environ['API_TOKEN'] = 'Your Supervisely API Token' api = sly.Api.from_env() roles = api.role.get_list()
-
get_list_all_pages(method, data, progress_cb=
None
, convert_json_info_cb=None
, limit=None
, return_first_response=False
)¶ Get list of all or limited quantity entities from the Supervisely server.
- Parameters
- method : str
Request method name
- data : dict
Dictionary with request body info
- progress_cb : Progress, optional
Function for tracking download progress.
- convert_json_info_cb : Callable, optional
Function for convert json info
- limit : int, optional
Number of entity to retrieve
- return_first_response : bool, optional
Specify if return first response
-
get_list_all_pages_generator(method, data, progress_cb=
None
, convert_json_info_cb=None
, limit=None
, return_first_response=False
)¶ This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
- Parameters
- method : str
Request method name
- data : dict
Dictionary with request body info
- progress_cb : Progress, optional
Function for tracking download progress.
- convert_json_info_cb : Callable, optional
Function for convert json info
- limit : int, optional
Number of entity to retrieve
- return_first_response : bool, optional
Specify if return first response