Provided Methods

Method documentation

All the examples expect that there is already a OneDataApi object initialized and assigned to a variable called "onedata_api".

### Creation of the ONE DATA Api ###
onedata_api = OneDataApi(base_url=base_url, username=user,
                         password=pw, verify=False, timeout=999)

paginated

Description:

Lists all projects matching the specified search parameters (group_id, domain_id, page, limit, sort_by, ordering, search).

Optional request options (request_transformers, response_transformers, timeout, verify, sleep_after_response_millis, deserializer) can be specified.

Returns: Paginated

Parameters

PropertyTypeRequiredDefaultDescription
domain_idUnion[str, uuid.UUID]falseNoneID of the domain the projects fetched should be located in.
group_idUnion[str, uuid.UUID]falseNoneID of the group the projects fetched should be located in.
project_types[OneDataModule]falseNoneTypes of the fetched projects
pageintfalseNoneResult page
limitintfalseNoneItems per page
sort_byResourceSortPropertyfalseNoneSort property
orderingSortOrderfalseNoneOrder direction
searchstrfalseNoneString to search for desired project. Search is case insensitive. Name and tags are considered.

Usage

### Get list of projects with parameters ###
projects = onedata_api.projects.paginated(domain_id="00000000-0000-0000-0000-000000000001", page=0, limit=5, sort_by=ResourceSortProperty.NAME, ordering=SortOrder.ASC, search="Test")