flywheel.api.resolve_api
ResolveApi
Bases: object
lookup_path(body, **kwargs)
Perform path based lookup of a single node in the Flywheel hierarchy
This will perform a deep lookup of a node. See /resolve for more details. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ResolveInput | | required |
full_tree | (bool, optional) | , defaults to false | required |
exhaustive | (bool, optional) | , defaults to false | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
lookup_path_with_http_info(body, **kwargs)
Perform path based lookup of a single node in the Flywheel hierarchy
This will perform a deep lookup of a node. See /resolve for more details. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ResolveInput | | required |
full_tree | (bool, optional) | , defaults to false | required |
exhaustive | (bool, optional) | , defaults to false | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
resolve_path(body, **kwargs)
Perform path based lookup of nodes in the Flywheel hierarchy
This will perform a deep lookup of a node (i.e. group/project/session/acquisition) and its children, including any files. The query path is an array of strings in the following order (by default): * group id * project label * session label * acquisition label Additionally, analyses for project/session/acquisition nodes can be resolved by inserting the literal string "analyses". e.g. ['scitran', 'MyProject', 'analyses']. Files for projects, sessions, acquisitions and analyses can be resolved by inserting the literal string "files". e.g. ['scitran', 'MyProject', 'files']. An ID can be used instead of a label by formatting the string as <id:project_id>. The full path to the node, and the node's children will be included in the response. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ResolveInput | | required |
full_tree | (bool, optional) | Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...), defaults to false | required |
minattr | (bool, optional) | Return only minimal attributes, defaults to false | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions, defaults to false | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |
resolve_path_with_http_info(body, **kwargs)
Perform path based lookup of nodes in the Flywheel hierarchy
This will perform a deep lookup of a node (i.e. group/project/session/acquisition) and its children, including any files. The query path is an array of strings in the following order (by default): * group id * project label * session label * acquisition label Additionally, analyses for project/session/acquisition nodes can be resolved by inserting the literal string "analyses". e.g. ['scitran', 'MyProject', 'analyses']. Files for projects, sessions, acquisitions and analyses can be resolved by inserting the literal string "files". e.g. ['scitran', 'MyProject', 'files']. An ID can be used instead of a label by formatting the string as <id:project_id>. The full path to the node, and the node's children will be included in the response. This method makes a synchronous HTTP request by default.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
body | ResolveInput | | required |
full_tree | (bool, optional) | Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/...), defaults to false | required |
minattr | (bool, optional) | Return only minimal attributes, defaults to false | required |
exhaustive | (bool, optional) | Set to return a complete list regardless of permissions, defaults to false | required |
include_all_info | (bool, optional) | Include all info in returned objects, defaults to false | required |
async_ | (bool, optional) | Perform the request asynchronously | required |