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)

get

Description

Retrieves a workflow with the given ID XOR its name and project id. Other optional request options (request_transformers, response_transformers, timeout, verify, sleep_after_response_millis, deserializer) can be specified.

Returns: Workflow

Parameters

PropertyTypeRequiredDefaultDescription
base_urlstrTrue-base url of your ONEDATA instance
usernamestrFalseNonename of the user
passwordstrFalseNonepassword of the user
tokenstrFalseNoneauth token of the user

Usage

### Get Workflow ###
workflow_by_id: Workflow = onedata_api.workflows.get(id=<workflow_id>)

workflow_by_name: Workflow = onedata_api.workflows.get(name=<workflow_name>, project_id=<project_id>)

paginated

Description

Lists all workflows matching the specified search parameters (page, limit, sort_by, ordering, projects, project_types, search). Optional request options (request_transformers, response_transformers, timeout, verify, sleep_after_response_millis, deserializer) can be specified.

Returns: [Workflows]

Parameters

PropertyTypeRequiredDefaultDescription
base_urlstrTrue-base url of your ONEDATA instance
usernamestrFalseNonename of the user
passwordstrFalseNonepassword of the user
tokenstrFalseNoneauth token of the user

Usage

### Get paginated list of workflows ###
workflows_list: Paginated = onedata_api.workflows.paginated(page=<page>, limit=<limit>, sort_by=<sort_by>,
                                                            ordering=<ordering>, projects=<projects>,
                                                            project_types=<project_types>, search=<search>)