flywheel package

Subpackages

Submodules

flywheel.api_client module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.api_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None, context=None, request_timeout=None, connect_timeout=None)

Bases: object

Generic API client for Swagger client library builds.

Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.

Parameters

  • configuration – .Configuration object for this client

  • header_name – a header to pass when making calls to the API.

  • header_value – a header value to pass when making calls to the API.

  • cookie – a cookie to include in the header when making calls to the API

NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}
PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)
call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _request_out=None)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async request, set the async_ parameter.

Parameters

  • resource_path – Path to method endpoint.

  • method – Method to call.

  • path_params – Path parameters in the url.

  • query_params – Query parameters in the url.

  • header_params – Header parameters to be placed in the request header.

  • body – Request body.

  • dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

  • list (auth_settings) – Auth Settings names for the request.

  • response – Response data type.

  • dict – key -> filename, value -> filepath, for multipart/form-data.

  • bool (async) – execute request asynchronously

  • _return_http_data_only – response data without head status code and headers

  • collection_formats – dict of collection formats for path, query, header, and post parameters.

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns

If async_ parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_ is False or missing, then the method will return the response directly.

deserialize(response, response_type)

Deserializes response into an object.

Parameters

  • response – RESTResponse object to be deserialized.

  • response_type – class literal for deserialized object, or string of class name.

Returns

deserialized object.

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters

  • params – Parameters as dict or list of two-tuples

  • collection_formats (dict) – Parameter collection formats

Returns

Parameters as list of tuples, collections formatted

property pool
prepare_post_parameters(post_params=None, files=None)

Builds form parameters.

Parameters

  • post_params – Normal form parameters.

  • files – File parameters.

Returns

Form parameters with files.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.

Parameters

obj – The data to serialize.

Returns

The serialized form of data.

select_header_accept(accepts)

Returns Accept based on an array of accepts provided.

Parameters

accepts – List of headers.

Returns

Accept (e.g. application/json).

select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters

content_types – List of content-types.

Returns

Content-Type (e.g. application/json).

set_context(context)
set_default_header(header_name, header_value)
set_default_query_param(name, value)
set_version_check_fn(fn)
shutdown()
update_params_for_auth(headers, querys, auth_settings)

Updates header and query params based on authentication setting.

Parameters

  • headers – Header parameters dict to be updated.

  • querys – Query parameters tuple list to be updated.

  • auth_settings – Authentication setting identifiers list.

property user_agent

User agent for this API client

flywheel.api_client.is_file_obj(obj)

flywheel.client module

class flywheel.client.Client(api_key=None, **kwargs)

Bases: object

View(**kwargs)

Short-hand for flywheel.ViewBuilder(**kwargs).build()

Parameters

kwargs – The arguments to pass directly to ViewBuilder

Returns

The built data view

property acquisitions

Returns the acquisitions finder object

add_collection(*args, **kwargs)

Create a collection

add_gear(gear_name, body, **kwargs)

Create or update a gear.

If no existing gear is found, one will be created Otherwise, the specified gear will be updated

Parameters

  • gear_name (str) – Name of the gear to interact with (required)

  • body (GearDocumentLegacyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearDocument

add_group(*args, **kwargs)

Add a group

add_job(body, **kwargs)

Add a job

Parameters

body (Job) – (required)

Returns

CommonObjectCreated

add_user(*args, **kwargs)

Add a new user

property collections

Returns the collections finder object

property data_view_executions

Returns the data_view_executions finder object

download_tar(containers, dest_file, include_types=None, exclude_types=None)

Download the given set of containers as a tarball to dest_file.

Supports downloading Projects, Sessions, Acquisitions and/or Analyses.

Parameters

  • containers – (required) The container, or list of containers to download.

  • dest_file (str) – (required) The destination file on disk

  • include_types (list) – The optional list of types to include in the download (e.g. [‘nifti’])

  • exclude_types (list) – The optional list of types to exclude from the download (e.g. [‘dicom’])

Returns

A summary of the download

download_zip(containers, dest_file, include_types=None, exclude_types=None)

Download the given set of containers as a zip archive to dest_file.

Supports downloading Projects, Sessions, Acquisitions and/or Analyses.

Parameters

  • containers – (required) The container, or list of containers to download.

  • dest_file (str) – (required) The destination file on disk

  • include_types (list) – The optional list of types to include in the download (e.g. [‘nifti’])

  • exclude_types (list) – The optional list of types to exclude from the download (e.g. [‘dicom’])

Returns

A summary of the download

file_url(path)

Perform a path based lookup of a file in the Flywheel hierarchy, and return a single-use download URL.

Parameters

path (str) – (required) The path to resolve

Returns

The file URL if found, otherwise raises an error

property gears

Returns the gears finder object

get(id, **kwargs)

Retrieve the specified object by id.

Objects that can be retrieved in this way are:

group, project, session, subject, acquisition, analysis and collection

Parameters

id (str) – The id of the object to retrieve

Returns

ContainerOutput

get_config(**kwargs)

Return public Scitran configuration information

Returns

ConfigOut

get_current_user(**kwargs)

Get current logged-in user

Returns

User

get_gear(gear_id, **kwargs)

Return a gear referenced by gear_id

Parameters

gear_id (str) – (required) The id of the gear to lookup

Returns

Gear

get_modality(modality_id, **kwargs)

Get a modality’s classification specification

Parameters

modality_id (str) – (required)

Returns

Modality

get_version(**kwargs)

Get server and database schema version info

Returns

VersionOutput

property groups

Returns the groups finder object

property jobs

Returns the jobs finder object

lookup(path)

Perform a path based lookup of a single node in the Flywheel hierarchy.

Parameters

path (str) – (required) The path to resolve

Returns

ResolverOutput

print_view_columns(file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)

Print a list of column aliases that can be used in data views.

Parameters

file (file-like) – The file to print to

property projects

Returns the projects finder object

read_view_data(view, container_id, decode=True, **kwargs)

Execute a data view against container, and return a file-like object that can be streamed.

Parameters

  • view (str or DataView) – The view id or DataView object to execute.

  • container_id (str) – The id of the container to execute the view against

  • decode (bool) – Whether or not to decode the stream to utf-8 (default is true)

  • kwargs – Additional arguments to pass to the evaluate_view call. (e.g. format=’csv’)

Returns

A file-like object where the contents can be read

read_view_dataframe(view, container_id, opts=None, **kwargs)

Execute a data view against container, and return a DataFrame.

NOTE: This requires that the pandas module be installed on the system.

Parameters

  • view (str or DataView) – The view id or DataView object to execute.

  • container_id (str) – The id of the container to execute the view against

  • opts (object) – Additional options to pass to the pandas read_json function

  • kwargs – Additional arguments to pass to the evaluate_view call.

Returns

A pandas DataFrame

resolve(path)

Perform a path based lookup of nodes in the Flywheel hierarchy.

Parameters

path (str) – (required) The path to resolve

Returns

ResolverOutput

save_view_data(view, container_id, dest_file, **kwargs)

Execute a data view against container, and save the results to disk.

Parameters

  • view (str or DataView) – The view id or DataView object to execute.

  • container_id (str) – The id of the container to execute the view against

  • dest_file (str) – The destination file path

  • kwargs – Additional arguments to pass to the evaluate_view call. (e.g. format=’csv’)

property sessions

Returns the sessions finder object

shutdown()

Release any outstanding resources

property subjects

Returns the subjects finder object

property users

Returns the users finder object

flywheel.client.get_api_key_from_cli(path)

flywheel.configuration module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.configuration.Configuration

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.

auth_settings()

Gets Auth Settings dict for api client.

Returns

The Auth Settings information dict.

property debug

Debug status

Parameters

value – The debug status, True or False.

Type

bool

get_api_key_with_prefix(identifier)

Gets API key (with prefix if set).

Parameters

identifier – The identifier of apiKey.

Returns

The token for api key authentication.

get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns

The token for basic HTTP authentication.

property logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Parameters

value – The logger_file path.

Type

str

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters

value – The format string.

Type

str

to_debug_report()

Gets the essential information for debugging.

Returns

The report for debugging.

class flywheel.configuration.TypeWithDefault(name, bases, dct)

Bases: type

set_default(default)

flywheel.drone_login module

Provides Drone-based login credentials

flywheel.drone_login.create_drone_client(host, secret, method, name, port=443, **kwargs)

Create a Client instance using drone credentials.

Parameters

  • host (str) – The hostname of the flywheel instance

  • secret (str) – The drone secret

  • method (str) – The method (device type)

  • name (str) – The name of the device

  • port (int) – The optional port (if not 443)

  • kwargs – Additional arguments to pass to the created Client instance

Returns

The authorized Client instance

Return type

flywheel.Client

flywheel.file_spec module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.file_spec.FileSpec(name, contents=None, content_type=None)

Bases: object

to_file_tuple()

flywheel.finder module

Provides finder interface for collections

class flywheel.finder.Finder(context, method, *args)

Bases: object

Finder wrapper for finding objects in a collection

find(*args, **kwargs)

Find all items in the collection that match the provided filter

Parameters

  • args – The list of filters to apply (e.g. ‘label=my-label’ , ‘created>2018-09-22’)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

find_first(*args, **kwargs)

Find the first item matching the provided filter. Returns None if no items matched.

Parameters

  • args – The list of filters to apply (e.g. ‘label=my-label’ , ‘created>2018-09-22’)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

find_one(*args, **kwargs)

Find exactly one item matching the provided filter. Raises a ValueError if 0 or 2+ items matched.

Parameters

  • args – The list of filters to apply (e.g. ‘label=my-label’ , ‘created>2018-09-22’)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

iter(limit=250)

Iterate over all items in the collection, without limit.

Parameters

limit (int) – The number of entries to return per call (default is 250)

iter_find(*args, **kwargs)

Find all items in the collection that match the provided filter, without limit.

Parameters

  • args – The list of filters to apply (e.g. ‘label=my-label’ , ‘created>2018-09-22’)

  • limit (int) – The number of entries to return per call (default is 250)

flywheel.flywheel module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

class flywheel.flywheel.Flywheel(api_key, minimum_supported_major_version=0, root=False, skip_version_check=True, subjects_in_resolver=None, request_timeout=None, connect_timeout=None)

Bases: object

View(**kwargs)

Short-hand for flywheel.ViewBuilder(**kwargs).build()

Parameters

kwargs – The arguments to pass directly to ViewBuilder

Returns

The built data view

accept_failed_output(job_id, **kwargs)

Accept failed job output.

Remove the ‘from_failed_job’ flag from the files. Create any automatic jobs for the accepted files.

Parameters

  • job_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

add_acquisition(body, **kwargs)

Create a new acquisition

Create a new acquisition

Parameters

  • body (AcquisitionInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_acquisition_analysis(cid, body, **kwargs)

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

  • cid (str) – (required)

  • body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)

  • job (bool) – returns job_id instead of analysis.id

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_acquisition_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to acquisition analysis.

Parameters

  • container_id (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_acquisition_note(container_id, body, **kwargs)

Add a note to acquisition.

Parameters

  • container_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_acquisition_tag(cid, body, **kwargs)

Add a tag to acquisition.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_acquisitions_to_collection(collection_id, acquisition_ids, **kwargs)

Add a list of acquisitions to a collection.

Parameters

  • collection_id (str) – (required) The id of the collection to update

  • acquisition_ids (list[str]) – (required) The list of acquisition ids to add

Returns

None

add_analysis_note(container_id, body, **kwargs)

Add a note to analysis.

Add a note to analysis.

Parameters

  • container_id (str) – Container id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_analysis_tag(container_id, body, **kwargs)

Add a tag to analysis.

Propagates changes to projects, sessions and acquisitions

Parameters

  • container_id (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_collection(body, **kwargs)

Create a collection

Create a collection

Parameters

  • body (CollectionInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_collection_analysis(cid, body, **kwargs)

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

  • cid (str) – (required)

  • body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)

  • job (bool) – returns job_id instead of analysis.id

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_collection_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to collection analysis.

Parameters

  • container_id (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_collection_note(container_id, body, **kwargs)

Add a note to collection.

Parameters

  • container_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_collection_permission(collection_id, body, **kwargs)

Add a permission

Parameters

  • collection_id (str) – (required)

  • body (PermissionAccessPermission) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

add_collection_tag(cid, body, **kwargs)

Add a tag to collection.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_container_analysis(cid, body, **kwargs)

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

  • cid (str) – (required)

  • body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)

  • job (bool) – returns job_id instead of analysis.id

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_container_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to container analysis.

Parameters

  • container_id (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_container_note(container_id, body, **kwargs)

Add a note to container.

Parameters

  • container_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_container_tag(cid, body, **kwargs)

Add a tag to container.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_file_tags(file_id, body, **kwargs)

Add list of tags on a file.

Add the tags on a file to the list of tags

Parameters

  • file_id (str) – (required)

  • body (list[str]) – (required)

  • async (bool) – Perform the request asynchronously

Returns

list[str]

add_gear(gear_name, body, **kwargs)

Create or update a gear.

If no existing gear is found, one will be created Otherwise, the specified gear will be updated

Parameters

  • gear_name (str) – Name of the gear to interact with (required)

  • body (GearDocumentLegacyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearDocument

add_gear_permission(gear_name, permission_type, body, **kwargs)

Add an individual permission to the given gear

Parameters

  • gear_name (str) – Name of the gear to interact with (required)

  • permission_type (GearPermissionsType) – (required)

  • body (GearPermissionsInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearSeries

add_group(body, **kwargs)

Add a group

Create a new group.

Parameters

  • body (GroupInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_group_permission(group_id, body, **kwargs)

Add a permission

Parameters

  • group_id (str) – (required)

  • body (PermissionAccessPermission) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

add_group_permission_template(group_id, body, **kwargs)

Add a permission template

Parameters

  • group_id (str) – (required)

  • body (RolesRoleAssignment) – (required)

  • propagate (bool) –

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

add_group_tag(cid, body, **kwargs)

Add a tag to group.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_job(body, **kwargs)

Add a job

Parameters

  • body (Job) – (required)

  • async (bool) – Perform the request asynchronously

Returns

CommonObjectCreated

add_job_logs(job_id, body, **kwargs)

Add logs to a job.

Parameters

  • job_id (str) – (required)

  • body (list[JobLog]) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

add_modality(body, **kwargs)

Create a new modality.

handlers.modalityhandler.ModalityHandler.post

Parameters

  • body (ModalityInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModalityOutput

add_nodes_to_collection(collection_id, level, node_ids, **kwargs)

Generic method to add a list of nodes to a collection.

Parameters

  • collection_id (str) – (required) The id of the collection to update

  • level (str) – (required) The level of nodes to add (e.g. session or acquisition)

  • node_ids (list[str]) – (required) The list of node ids of type level to add

Returns

None

add_project(body, **kwargs)

Create a new project

Parameters

  • body (ProjectInput) – (required)

  • inherit (bool) – Inherit permissions from the group permission template

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_project_analysis(cid, body, **kwargs)

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

  • cid (str) – (required)

  • body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)

  • job (bool) – returns job_id instead of analysis.id

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_project_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to project analysis.

Parameters

  • container_id (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_project_note(container_id, body, **kwargs)

Add a note to project.

Parameters

  • container_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_project_permission(project_id, body, **kwargs)

Add a permission

Parameters

  • project_id (str) – (required)

  • body (RolesRoleAssignment) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

add_project_rule(project_id, body, **kwargs)

Create a new rule for a project.

Parameters

  • project_id (str) – (required)

  • body (GearRuleInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearRule

add_project_tag(cid, body, **kwargs)

Add a tag to project.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_provider(body, **kwargs)

Add a new provider

Parameters

  • body (IngressProvider) – (required)

  • async (bool) – Perform the request asynchronously

Returns

EgressProviderId

add_role(body, **kwargs)

Add a new role

Parameters

  • body (RolesRoleInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

RolesRole

add_role_to_group(group_id, body, **kwargs)

Add a role to the pool of roles in a group

Add a group role.

Parameters

  • group_id (str) – (required)

  • body (GroupRole) – (required)

  • async (bool) – Perform the request asynchronously

Returns

RoleOutput

add_session(body, **kwargs)

Create a new session

Create a session.

Parameters

  • body (SessionInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_session_analysis(cid, body, **kwargs)

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

  • cid (str) – (required)

  • body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)

  • job (bool) – returns job_id instead of analysis.id

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_session_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to session analysis.

Parameters

  • container_id (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_session_note(container_id, body, **kwargs)

Add a note to session.

Parameters

  • container_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_session_tag(cid, body, **kwargs)

Add a tag to session.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_sessions_to_collection(collection_id, session_ids, **kwargs)

Add a list of sessions to a collection.

Parameters

  • collection_id (str) – (required) The id of the collection to update

  • session_ids (list[str]) – (required) The list of session ids to add

Returns

None

add_site_rule(body, **kwargs)

Create a new site rule.

Parameters

  • body (Rule) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

add_subject(body, **kwargs)

Create a new subject

Create a new subject

Parameters

  • body (SubjectInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_subject_analysis(cid, body, **kwargs)

Create an analysis and upload files.

When query param “job” is “true”, send JSON to create an analysis and job. Otherwise, multipart/form-data to upload files and create an analysis.

Parameters

  • cid (str) – (required)

  • body (union[AdhocAnalysisInput,JobAnalysisInput]) – (required)

  • job (bool) – returns job_id instead of analysis.id

  • async (bool) – Perform the request asynchronously

Returns

InsertedId

add_subject_analysis_note(container_id, analysis_id, body, **kwargs)

Add a note to subject analysis.

Parameters

  • container_id (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_subject_note(container_id, body, **kwargs)

Add a note to subject.

Parameters

  • container_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

add_subject_tag(cid, body, **kwargs)

Add a tag to subject.

Propagates changes to projects, sessions and acquisitions

Parameters

  • cid (str) – (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

add_user(body, **kwargs)

Add a new user

Parameters

  • body (UserInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

UserOutput

add_view(container_id, body, **kwargs)

Add a new data view

Create container view

Parameters

  • container_id (str) – (required)

  • body (ContainerIdViewInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ViewIdOutput

ask_jobs(body, **kwargs)

Ask the queue a question

Ask the queue a question, receiving work or statistics in return.

Parameters

  • body (JobAsk) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobAskResponse

ask_jobs_state(job_state, body, **kwargs)

Ask job count by state

Ask the queue for the number of jobs for a given state and query.

Parameters

  • job_state (str) – (required)

  • body (JobAskState) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobAskStateResponse

bulk_copy(body, **kwargs)

Perform a bulk copy operation

Parameters

  • body (BulkMoveSessions) – (required)

  • async (bool) – Perform the request asynchronously

Returns

object

bulk_delete(body, **kwargs)

Perform a bulk delete operation

Parameters

  • body (BulkMoveSessions) – (required)

  • async (bool) – Perform the request asynchronously

Returns

object

bulk_move_sessions(body, **kwargs)

Perform a bulk move of sessions to either a subject or project

Parameters

  • body (BulkMoveSessions) – (required)

  • async (bool) – Perform the request asynchronously

Returns

object

callback_virus_scan(container_type, container_id, file_name, body, **kwargs)

Callback url to send the virus scan result of a file.

This endpoint accepts the result from the anti-virus service. NOTE: this endpoint only can be used via a signed url.

Parameters

  • container_type (str) – (required)

  • container_id (str) – (required)

  • file_name (str) – (required)

  • body (CallbacksVirusScanInput) – (required)

  • signature (str) – Url’s signature (signed callback url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

None

cancel_batch(batch_id, **kwargs)

Cancel a Job

Cancels jobs that are still pending, returns number of jobs cancelled. Moves a ‘running’ batch job to ‘cancelled’.

Parameters

  • batch_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

BatchCancelOutput

catalog_list(**kwargs)

Catalog List

Parameters

  • search_string (str) – Include only results containing the search string

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order.(e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return

  • skip (int) – The number of entries to skip

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[CatalogListOutput],Page]

change_job_state(job_id, state)

Change a job state.

Parameters

  • job_id (str) – (required) The id of the job to modify

  • state (str) – (required) The new job state

Returns

None

check_uids_exist(body, **kwargs)

Check for existence of UIDs system-wide

Parameters

  • body (ContainerUidcheck) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ContainerUidcheck

clean_packfiles(**kwargs)

Clean up expired upload tokens and invalid token directories.

Parameters

async (bool) – Perform the request asynchronously

Returns

object

collect_usage(**kwargs)

Collect daily usage statistics.

Collects usage statistics for the selected day (or yesterday if no day is given)

Parameters

  • year (int) – The year portion of the date

  • month (int) – The month portion of the date

  • day (int) – The day portion of the date

  • async (bool) – Perform the request asynchronously

Returns

None

complete_job(job_id, body, **kwargs)

Complete a job, with information

Parameters

  • job_id (str) – (required)

  • body (JobCompletionInput) – (required)

  • job_ticket_id (str) –

  • async (bool) – Perform the request asynchronously

Returns

None

complete_s3_multipart_upload(body, **kwargs)

Complete S3 multipart signed url upload

Complete S3 uploads exceeding 5GB and create the final object in the bucket. Expected an upload id returned previously by the POST /upload/signed-url endpoint and the e-tags returned by S3 after uploaded each file part.

Parameters
Returns

UploadCompleteS3MultipartOutput

create_batch_job_from_jobs(body, **kwargs)

Create a batch job proposal from preconstructed jobs and insert it as &#x27;pending&#x27;.

Parameters

  • body (BatchJobsProposalInput) – Set of jobs to be run as a batch (required)

  • async (bool) – Perform the request asynchronously

Returns

BatchProposal

create_device(body, **kwargs)

Create a new device.

Will create a new device record together with an api key. Request must be an admin request.

Parameters

  • body (DeviceCreate) – (required)

  • async (bool) – Perform the request asynchronously

Returns

EgressDevice

create_download_ticket(body, **kwargs)

Create a download ticket

Use filters in the payload to exclude/include files. To pass a single filter, each of its conditions should be satisfied. If a file pass at least one filter, it is included in the targets.

Parameters

  • body (Download) – Download files with tag ‘incomplete’ OR type ‘dicom’ (required)

  • type (str) – The download type, one of: bulk, classic or full. Default is classic.

  • analyses (bool) – For “full” download, whether or not to include analyses. Default is false.

  • metadata (bool) – For “full” download, whether or not to include metadata sidecars. Default is false.

  • prefix (str) – A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to “scitran”.

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicketWithSummary

create_master_subject_code(body, **kwargs)

Request a master subject code for the given patient

The workflow is the following. - send patient_id (e.g., MRN) and/or first_name, last_name, date_of_birth - indicate whether to use patient_id for identification or first_name, last_name, date_of_birth by the use_patient_id field - the response will contain a master subject code - if you send the same identifying information again, you will receive the same code Note that if you received a MSC code for example by just providing the patient_id, you can save more information for that MSC in a second request (first_name, last_name, date_of_birth). Only the missing fields will be set, so you can’t update any existing field (e.g. changing the name). Since you can create multiple MSC codes with the same name and date of birth using different patient ids, you will get HTTP 400 error if you request an MSC code by name and date of birth and there are multiple matches. In this case you need to use patient id.

Parameters

  • body (Body) – (required)

  • async (bool) – Perform the request asynchronously

Returns

MasterSubjectCodeCodeOutput

create_project_aet(body, **kwargs)

Create a new DIMSE project AET

Will create a new DIMSE AET that refers to a Flywheel project. AETs can only be created by admins and use drone access via DIMSE.

Parameters

  • body (DimseProjectInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

object

create_service_aet(body, **kwargs)

Create a new DIMSE service AET

Will create a new DIMSE AET that refers to an external DICOM node. Service AETs can be used to issue C-MOVEs to from project AETs. Requires login. AETs can only be created by admins.

Parameters

  • body (DimseServiceInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

object

create_signed_upload_url(body, **kwargs)

Create new signed upload URL

Return a signed upload URL for the requested storage provider_id. Multiple URLs are returned for S3 uploads exceeding 5GB.

Parameters
Returns

UploadSignedUploadUrlOutput

data_view_columns(**kwargs)

Return a list of all known column aliases for use in data views

Parameters

async (bool) – Perform the request asynchronously

Returns

list[DataViewColumnAlias]

delete_acquisition(acquisition_id, **kwargs)

Delete a acquisition

Read-write project permissions are required to delete an acquisition. </br>Admin project permissions are required if the acquisition contains data uploaded by sources other than users and jobs.

Parameters

  • acquisition_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_acquisition_analysis(cid, analysis_id, **kwargs)

Delete an anaylsis

Delete an analysis for a container.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_acquisition_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from acquisition analysis.

Remove a note from acquisition analysis.

Parameters

  • cid (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_acquisition_file(cid, filename, **kwargs)

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_acquisition_file_classification_fields(cid, filename, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

ModifiedResult

delete_acquisition_file_info_fields(acquisition_id, file_name, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

delete_acquisition_info_fields(acquisition_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • acquisition_id (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

None

delete_acquisition_note(cid, note_id, **kwargs)

Remove a note from acquisition

Remove a note from acquisition

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_acquisition_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_analysis(analysis_id, **kwargs)

Delete an analysis

Delete an analysis by its id Args: analysis_id: The id of the analysis auth_session: The auth session delete_reason: The reason for deletion (required when change-logging is enabled)

Parameters

  • analysis_id (str) – 24-char hex analysis id (required)

  • delete_reason (ContainerDeleteReason) –

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_analysis_info_fields(analysis_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

None

delete_analysis_note(container_id, note_id, **kwargs)

Remove a note from analysis

Remove a note from analysis

Parameters

  • container_id (str) – Container id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_analysis_tag(container_id, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • container_id (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_collection(collection_id, **kwargs)

Delete a collection

Delete Collections.

Parameters

  • collection_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_collection_analysis(cid, analysis_id, **kwargs)

Delete an anaylsis

Delete an analysis for a container.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_collection_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from collection analysis.

Remove a note from collection analysis.

Parameters

  • cid (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_collection_file(cid, filename, **kwargs)

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_collection_file_classification_fields(cid, filename, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

ModifiedResult

delete_collection_file_info_fields(collection_id, file_name, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

delete_collection_info_fields(collection_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

None

delete_collection_note(cid, note_id, **kwargs)

Remove a note from collection

Remove a note from collection

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_collection_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_collection_user_permission(collection_id, user_id, **kwargs)

Delete a permission

Parameters

  • collection_id (str) – (required)

  • user_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

delete_container(container_id, **kwargs)

Delete a container

Delete Container

Parameters

  • container_id (str) – (required)

  • delete_reason (ContainerDeleteReason) –

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_container_analysis(cid, analysis_id, **kwargs)

Delete an anaylsis

Delete an analysis for a container.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_container_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from container analysis.

Remove a note from container analysis.

Parameters

  • cid (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_container_file(cid, filename, **kwargs)

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_container_file_classification_fields(cid, filename, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

ModifiedResult

delete_container_file_info_fields(container_id, file_name, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

delete_container_info_fields(container_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

None

delete_container_note(cid, note_id, **kwargs)

Remove a note from container

Remove a note from container

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_container_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_device(device_id, **kwargs)

Delete

(post handlers.devicehandler.DeviceHandler.post)

Parameters

  • device_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_device_key(device_id, key_id, **kwargs)

Delete Device Key

Parameters

  • device_id (str) – (required)

  • key_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_file(file_id, **kwargs)

Delete a File

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • file_id (str) – (required)

  • version (int) –

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_gear(gear_id, **kwargs)

Delete a gear (not recommended)

Parameters

  • gear_id (str) – Id of the gear to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_gear_permission(gear_name, permission_type, permission_id, **kwargs)

Delete an individual permission of the given gear

Parameters

  • gear_name (str) – (required)

  • permission_type (GearPermissionsType) – (required)

  • permission_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_gear_permissions(gear_name, **kwargs)

Delete permissions of the given gear

Parameters

  • gear_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_group(group_id, **kwargs)

Delete group

Delete a group.

Parameters

  • group_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_group_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_group_user_permission(group_id, user_id, **kwargs)

Delete a permission

Deletes a permission from the group Args: group_id: the id of the group user_id: The id of the user auth_session: The auth session of the user

Parameters

  • group_id (str) – (required)

  • user_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

delete_group_user_permission_template(group_id, user_id, **kwargs)

Delete a permission

Parameters

  • group_id (str) – (required)

  • user_id (str) – (required)

  • propagate (bool) –

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

delete_modality(modality_id, **kwargs)

Delete a modality

Parameters

  • modality_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project(project_id, **kwargs)

Delete a project

Only site admins and users with “admin” project permissions may delete a project

Parameters

  • project_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project_aet(project_aet, **kwargs)

Delete a DIMSE project AET

Delete DIMSE project by AET. AETs can only be deleted by admins.

Parameters

  • project_aet (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_project_analysis(cid, analysis_id, **kwargs)

Delete an anaylsis

Delete an analysis for a container.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from project analysis.

Remove a note from project analysis.

Parameters

  • cid (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project_file(cid, filename, **kwargs)

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project_file_classification_fields(cid, filename, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

ModifiedResult

delete_project_file_info_fields(project_id, file_name, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

delete_project_info_fields(project_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

None

delete_project_note(cid, note_id, **kwargs)

Remove a note from project

Remove a note from project

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_project_user_permission(project_id, uid, **kwargs)

Delete a permission

Parameters

  • project_id (str) – (required)

  • uid (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_role(role_id, **kwargs)

Delete the role

Parameters

  • role_id (str) – The ID of the role (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_service_aet(service_aet, **kwargs)

Delete a DIMSE service AET

Delete DIMSE service by AET. AETs can only be deleted by admins.

Parameters

  • service_aet (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_session(session_id, **kwargs)

Delete a session

Read-write project permissions are required to delete a session. Admin project permissions are required if the session or it’s acquisitions contain data uploaded by sources other than users and jobs.

Parameters

  • session_id (str) – (required)

  • delete_reason (ContainerDeleteReason) –

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_session_analysis(cid, analysis_id, **kwargs)

Delete an anaylsis

Delete an analysis for a container.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_session_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from session analysis.

Remove a note from session analysis.

Parameters

  • cid (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_session_file(cid, filename, **kwargs)

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_session_file_classification_fields(cid, filename, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

ModifiedResult

delete_session_file_info_fields(session_id, file_name, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

delete_session_info_fields(session_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

None

delete_session_note(cid, note_id, **kwargs)

Remove a note from session

Remove a note from session

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_session_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_subject(subject_id, **kwargs)

Delete a subject

Read-write project permissions are required to delete a subject. Admin project permissions are required if the subject or it’s acquisitions contain data uploaded by sources other than users and jobs.

Parameters

  • subject_id (str) – 24-char hex subject id (required)

  • delete_reason (ContainerDeleteReason) –

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_subject_analysis(cid, analysis_id, **kwargs)

Delete an anaylsis

Delete an analysis for a container.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • delete_reason (ContainerDeleteReason) – Provide a reason for the deletion

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_subject_analysis_note(cid, analysis_id, note_id, **kwargs)

Remove a note from subject analysis.

Remove a note from subject analysis.

Parameters

  • cid (str) – 24-char hex id (required)

  • analysis_id (str) – 24-char hex analysis id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_subject_file(cid, filename, **kwargs)

Delete a file

A user with read-write or higher permissions on the container may delete files that were uploaded by users or were the output of jobs. (Specifically, files whose origin.type is either job or user.) <br/> A user with admin permissions on the container may delete any file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • delete_reason (ContainerDeleteReason) – A reason for deletion when change-logging is enabled

  • force (bool) – Force deletion of the file even if some checks fail

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_subject_file_classification_fields(cid, filename, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

ModifiedResult

delete_subject_file_info_fields(subject_id, file_name, body, **kwargs)

Delete the specified fields from + name + .

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

delete_subject_info_fields(subject_id, body, **kwargs)

Delete the specified fields from + name + .

Parameters
Returns

None

delete_subject_note(cid, note_id, **kwargs)

Remove a note from subject

Remove a note from subject

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_subject_tag(cid, value, **kwargs)

Delete a tag

Delete a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_user(user_id, **kwargs)

Delete a user

Parameters

  • user_id (str) – (required)

  • include_deleted (str) –

  • async (bool) – Perform the request asynchronously

Returns

None

delete_user_key(id_, **kwargs)

Delete User Api Key

Parameters

  • id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

delete_view(view_id, **kwargs)

Delete a data view

Soft deletes data view in database

Parameters

  • view_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

delete_view_execution(data_view_execution_id, **kwargs)

Delete a data_view_execution

Parameters

  • data_view_execution_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DeletedResult

determine_provider_for_job(body, **kwargs)

Determine the effective compute provider for a proposed job.

Parameters

  • body (Job) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Provider

download_acquisition_analysis_inputs(acquisition_id, analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_acquisition_analysis_outputs(acquisition_id, analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_analysis_inputs(analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_analysis_outputs(analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_collection_analysis_inputs(collection_id, analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_collection_analysis_outputs(collection_id, analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_container_analysis_inputs(container_id, analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_container_analysis_outputs(container_id, analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_file_from_acquisition(acquisition_id, file_name, dest_file, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

download_file_from_acquisition_as_data(acquisition_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

Returns

The binary file data

download_file_from_collection(collection_id, file_name, dest_file, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

download_file_from_collection_as_data(collection_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

Returns

The binary file data

download_file_from_container(container_id, file_name, dest_file, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

download_file_from_container_as_data(container_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

Returns

The binary file data

download_file_from_project(project_id, file_name, dest_file, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

download_file_from_project_as_data(project_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

Returns

The binary file data

download_file_from_session(session_id, file_name, dest_file, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

download_file_from_session_as_data(session_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

Returns

The binary file data

download_file_from_subject(subject_id, file_name, dest_file, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

download_file_from_subject_as_data(subject_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

Returns

The binary file data

download_input_from_acquisition_analysis(acquisition_id, analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_acquisition_analysis_as_data(acquisition_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_input_from_analysis(analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_analysis_as_data(analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_input_from_collection_analysis(collection_id, analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_collection_analysis_as_data(collection_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_input_from_container_analysis(container_id, analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_container_analysis_as_data(container_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_input_from_project_analysis(project_id, analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_project_analysis_as_data(project_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_input_from_session_analysis(session_id, analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_session_analysis_as_data(session_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_input_from_subject_analysis(subject_id, analysis_id, filename, dest_file, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_input_from_subject_analysis_as_data(subject_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_acquisition_analysis(acquisition_id, analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_acquisition_analysis_as_data(acquisition_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_analysis(analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_analysis_as_data(analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_collection_analysis(collection_id, analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_collection_analysis_as_data(collection_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_container_analysis(container_id, analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_container_analysis_as_data(container_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_project_analysis(project_id, analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_project_analysis_as_data(project_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_session_analysis(session_id, analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_session_analysis_as_data(session_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_output_from_subject_analysis(subject_id, analysis_id, filename, dest_file, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_output_from_subject_analysis_as_data(subject_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

Returns

The binary file data

download_project_analysis_inputs(project_id, analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_project_analysis_outputs(project_id, analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_session_analysis_inputs(session_id, analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_session_analysis_outputs(session_id, analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_subject_analysis_inputs(subject_id, analysis_id, **kwargs)

Download analysis inputs.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for all inputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the inputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_subject_analysis_outputs(subject_id, analysis_id, **kwargs)

Download analysis outputs.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for all outputs in the anlaysis If no “ticket” query param is included, server error 500

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • ticket (str) – ticket id of the outputs to download

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

download_tar(containers, dest_file, include_types=None, exclude_types=None)

Download the given set of containers as a tarball to dest_file.

Supports downloading Projects, Sessions, Acquisitions and/or Analyses.

Parameters

  • containers – (required) The container, or list of containers to download.

  • dest_file (str) – (required) The destination file on disk

  • include_types (list) – The optional list of types to include in the download (e.g. [‘nifti’])

  • exclude_types (list) – The optional list of types to exclude from the download (e.g. [‘dicom’])

Returns

A summary of the download

download_ticket(ticket, dest_file, **kwargs)

Download files listed in the given ticket.

You can use POST to create a download ticket The files listed in the ticket are put into a tar archive

Parameters

  • ticket (str) – ID of the download ticket (required)

  • format (str) – Archive format the download will be wrapped in

  • dest_file (str) – Destination file path

  • async (bool) – Perform the request asynchronously

Returns

None

download_ticket_as_data(ticket, **kwargs)

Download files listed in the given ticket.

You can use POST to create a download ticket The files listed in the ticket are put into a tar archive

Parameters

  • ticket (str) – ID of the download ticket (required)

  • format (str) – Archive format the download will be wrapped in

Returns

The binary file data

download_zip(containers, dest_file, include_types=None, exclude_types=None)

Download the given set of containers as a zip archive to dest_file.

Supports downloading Projects, Sessions, Acquisitions and/or Analyses.

Parameters

  • containers – (required) The container, or list of containers to download.

  • dest_file (str) – (required) The destination file on disk

  • include_types (list) – The optional list of types to include in the download (e.g. [‘nifti’])

  • exclude_types (list) – The optional list of types to exclude from the download (e.g. [‘dicom’])

Returns

A summary of the download

enable_feature(value)

Enable feature named value, via the X-Accept-Feature header

end_project_packfile_upload(token, metadata, file_count, project_id, **kwargs)

End a packfile upload

Parameters

  • token (str) – (required)

  • metadata (str) – string-encoded metadata json object. (required)

  • file_count (int) – Number of files uploaded into this packfile. (required)

  • project_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

engine_upload(level, id, job, **kwargs)

Upload a list of file fields.

### Default behavior: > Uploads a list of file fields sent as file1, file2, etc to an existing container and updates fields of the files, the container and it’s parents as specified in the metadata fileformfield using the engine placer class > A non-file form field called “metadata” is also required, which must be a string containing JSON. > See api/schemas/input/enginemetadata.json for the format of this metadata. ### When level is analysis: > Uploads a list of files to an existing analysis object, marking all files as output=true using the job-based analyses placer class. > A non-file form field called “metadata” is also required, which must be a string containing JSON. > See api/schemas/input/analysis.json for the format of this metadata. ### Signed URL upload with upload_ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?upload_ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

  • level (str) – Which level to store files in (required)

  • id (str) – The ID of the container to place files in (required)

  • job (str) – Required if level is analysis (required)

  • upload_ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload

  • body (str) – Object encoded as a JSON string. It is required and used only when the upload_ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

  • form_data (str) –

  • async (bool) – Perform the request asynchronously

Returns

object

evaluate_view(view_id, container_id, **kwargs)

Execute a view, returning data in the preferred format.

Parameters

  • view_id (str) – The ID of the view (required)

  • container_id (str) – The target container for view execution (required)

  • format (str) –

  • filter (str) – An optional filter expression

  • skip (int) – The optional number of rows to skip

  • limit (int) – The optional max number of rows to return

  • async (bool) – Perform the request asynchronously

Returns

None

evaluate_view_adhoc(container_id, body, **kwargs)

Execute an ad-hoc view, returning data in the preferred format.

Parameters

  • container_id (str) – The target container for view execution (required)

  • body (DataView) – (required)

  • format (str) –

  • filter (str) – An optional filter expression

  • skip (int) – The optional number of rows to skip

  • limit (int) – The optional max number of rows to return

  • async (bool) – Perform the request asynchronously

Returns

None

fetch_tree(body, **kwargs)

Query a portion of the flywheel hierarchy, returning only the requested fields.

This is a build-your-own request endpoint that can fetch from anywhere in the hierarchy, returning just the fields that you care about. # Fields Each fetch-level described must include a list of fields to return. These fields can be anything on the container (except info), and will be included in the response if they are present in the container. # Joins Children or parents can be joined as part of this request, by specifying an additional subdocument of the given name. Check /tree/graph for a list of containers and their connections. # Filter Joined documents can be further filtered (with the exception of inputs & files) by passing a filter in the subdocument. Filtering follows the same convention as top-level pagination. # Sort Joined documents can be sorted as well, following the convention as top-level pagination. # Limit Joins can be limited to a the first N documents by specifying a limit in the subdocument. # Join-origin Passing true for the join-origin flag in the files subdocument will populates the join-origin map for each container with files.

Parameters

  • body (TreeRequest) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • async (bool) – Perform the request asynchronously

Returns

list[TreeResponseItem]

file_url(path)

Perform a path based lookup of a file in the Flywheel hierarchy, and return a single-use download URL.

Parameters

path (str) – (required) The path to resolve

Returns

The file URL if found, otherwise raises an error

generate_user_key(body, **kwargs)

Generates user api key

Generate user api key for the current user.

Parameters
Returns

ApiKeyOutput

get(id, **kwargs)

Retrieve the specified object by id.

Objects that can be retrieved in this way are:

group, project, session, subject, acquisition, analysis and collection

Parameters

id (str) – The id of the object to retrieve

Returns

ContainerOutput

get_access_log_report(**kwargs)

Get a report of access log entries for the given parameters

Parameters

  • start_date (str) – An ISO formatted timestamp for the start time of the report

  • end_date (str) – An ISO formatted timestamp for the end time of the report

  • uid (str) – User id of the target user

  • limit (int) – Maximum number of records to return

  • subject (str) – Limit the report to the subject code of subject accessed

  • project (str) – Limit the report to the project id

  • access_type (list[str]) – The list of access_types to filter logs

  • csv (bool) – Set to download a csv file instead of json

  • async (bool) – Perform the request asynchronously

Returns

list[ReportAccessLogEntry]

get_access_log_types(**kwargs)

Get the list of types of access log entries

Parameters

async (bool) – Perform the request asynchronously

Returns

list[str]

get_acquisition(acquisition_id, **kwargs)

Get a single acquisition

Get a single acquisition

Parameters

  • acquisition_id (str) – (required)

  • join (JoinType) –

  • join_avatars (bool) – add name and avatar to notes

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

AcquisitionOutput

get_acquisition_analyses(cid, **kwargs)

Get analyses for acquisition.

Returns analyses that directly belong to this resource.

Parameters

  • cid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • inflate_job (bool) –

  • join_avatars (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_acquisition_analysis(cid, analysis_id, **kwargs)

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • inflate_job (bool) – Return job as an object instead of an id

  • join_avatars (bool) –

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_acquisition_analysis_input_download_url(acquisition_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_acquisition_analysis_input_zip_info(acquisition_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_acquisition_analysis_output_download_url(acquisition_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_acquisition_analysis_output_zip_info(acquisition_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_acquisition_download_url(acquisition_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

get_acquisition_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileOutput

get_acquisition_file_zip_info(acquisition_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_acquisition_note(cid, note_id, **kwargs)

Get a note on acquisition.

Get a note on acquisition

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_acquisition_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_all_acquisitions(**kwargs)

Get a list of acquisitions

Get a list of acquisitions.

Parameters

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • join (JoinType) –

  • join_avatars (bool) – add name and avatar to notes

  • collection_id (str) –

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[AcquisitionListOutput],Page]

get_all_batches(**kwargs)

Get a list of batch jobs the user has created.

Requires login.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[Batch]

get_all_collections(**kwargs)

List all collections.

List all collections.

Parameters

  • exhaustive (bool) –

  • join_avatars (bool) – add name and avatar to notes

  • join_files (bool) –

  • join (JoinType) –

  • stats (bool) –

  • user_id (str) –

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[CollectionWithStats],list[CollectionOutput]]

get_all_collections_curators(**kwargs)

List all curators of collections

Parameters

async (bool) – Perform the request asynchronously

Returns

list[object]

get_all_data_view_executions(**kwargs)

Get a list of data_view_executions

Parameters

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

list[DataViewExecution]

get_all_devices(**kwargs)

List all devices.

Requires login.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[Device]

get_all_devices_status(**kwargs)

Get status for all known devices.

ok - missing - error - unknown

Parameters

async (bool) – Perform the request asynchronously

Returns

DeviceStatus

get_all_gears(**kwargs)

List all gears

Parameters

  • all_versions (bool) – return all versions of each gear

  • include_invalid (bool) – return gears with the ‘invalid’ flag set

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • async (bool) – Perform the request asynchronously

Returns

list[GearDoc]

get_all_group_roles(group_id, **kwargs)

Get list of group roles

Parameters

  • group_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

list[RolesRole]

get_all_groups(**kwargs)

List all groups

Find all groups.

Parameters

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[GroupOutput]]

get_all_jobs(**kwargs)

Return all jobs

Parameters

  • states (str) – filter results by job state

  • tags (str) – filter results by job tags

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • async (bool) – Perform the request asynchronously

Returns

list[JobListEntry]

get_all_modalities(**kwargs)

List all modalities.

Requires login.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[Modality]

get_all_project_aets(**kwargs)

List all DIMSE project AETs

Will list all DIMSE AETs referring to a Flywheel project. Project AETs can be used to issue C-FIND and C-MOVE on Flywheel projects. Requires login and admin privilege.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[DimseProjectOutput]

get_all_projects(**kwargs)

Get a list of projects

Parameters

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • counts (bool) – Append the count of subjects in each project

  • stats (bool) – Return the status of subjects and sessions in each project

  • join_avatars (bool) – Return the joined avatars of the permissions

  • join (JoinType) –

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[ProjectListOutput],Page]

get_all_projects_groups(**kwargs)

List all groups which have a project in them

Parameters

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order.(e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return

  • skip (int) – The number of entries to skip

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • exhaustive (bool) – returns exhaustive list if correct permissions

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

list[GroupOutput]

get_all_roles(**kwargs)

Get list of all roles

Parameters

async (bool) – Perform the request asynchronously

Returns

list[RolesRole]

get_all_service_aets(**kwargs)

List all DIMSE services AETs

Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[DimseServiceOutput]

get_all_sessions(**kwargs)

Get a list of sessions

Finds all sessions.

Parameters

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • join_avatars (bool) – add name and avatar to notes

  • join (JoinType) – join file origins

  • user_id (str) –

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[SessionListOutput]]

get_all_subjects(**kwargs)

Get a list of subjects

Get a list of subjects

Parameters

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • join (JoinType) – join file origins

  • join_avatars (bool) – add name and avatar to notes

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[SubjectOutputForList]]

get_all_users(**kwargs)

Return a list of all users

Parameters

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • async (bool) – Perform the request asynchronously

Returns

list[User]

get_analyses(container_name, container_id, subcontainer_name, **kwargs)

Get nested analyses for a container

Returns analyses that belong to containers of the specified type that belong to ContainerId. Ex: projects/{ProjectId}/acquisitions/analyses will return any analyses that have an acquisition that is under that project as a parent. The all keyword is also supported, for example: projects/{ProjectId}/all/analyses will return any analyses that have any session or acquisition or the project itself as a parent.

Parameters

  • container_name (str) – The parent container type (required)

  • container_id (str) – The parent container id (required)

  • subcontainer_name (str) – The sub container type (required)

  • async (bool) – Perform the request asynchronously

Returns

list[AnalysisListOutput]

get_analysis(analysis_id, **kwargs)

Get an analysis.

Get an analysis by its id

Parameters

  • analysis_id (str) – 24-char hex analysis id (required)

  • inflate_job (bool) – expand job info

  • join_avatars (bool) – add name and avatar to notes

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutput,AnalysisOutputInflatedJob]

get_analysis_file_info(container_id, filename, **kwargs)

Get info for a particular file.

Get info for a particular file.

Parameters

  • container_id (str) – Container id (required)

  • filename (str) – The name of the file (required)

  • async (bool) – Perform the request asynchronously

Returns

FileOutput

get_analysis_input_download_url(analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_analysis_input_zip_info(analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_analysis_note(container_id, note_id, **kwargs)

Get a note on analysis.

Get a note on analysis

Parameters

  • container_id (str) – Container id (required)

  • note_id (str) – 24-char hex note id (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_analysis_output_download_url(analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_analysis_output_zip_info(analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_analysis_tag(container_id, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • container_id (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_auth_status(**kwargs)

Get Login status

Get the current login status of the requestor

Parameters

async (bool) – Perform the request asynchronously

Returns

AuthLoginStatus

get_batch(batch_id, **kwargs)

Get batch job details.

Parameters

  • batch_id (str) – (required)

  • jobs (bool) – If true, return job objects instead of job ids

  • async (bool) – Perform the request asynchronously

Returns

Batch

get_catalog_list_filter_options(**kwargs)

Get all filter options for sharing a project

Parameters

async (bool) – Perform the request asynchronously

Returns

SharingFilterOptions

get_collection(collection_id, **kwargs)

Retrieve a single collection

Retrieve a single collection

Parameters

  • collection_id (str) – (required)

  • join_avatars (bool) – add name and avatar to notes

  • join (JoinType) –

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

CollectionOutput

get_collection_acquisitions(collection_id, **kwargs)

List acquisitions in a collection

List acquisitions in a collection

Parameters

  • collection_id (str) – (required)

  • session (str) – The id of a session, to which the acquisitions returned will be restricted

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[AcquisitionListOutput],Page]

get_collection_analyses(cid, **kwargs)

Get analyses for collection.

Returns analyses that directly belong to this resource.

Parameters

  • cid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • inflate_job (bool) –

  • join_avatars (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_collection_analysis(cid, analysis_id, **kwargs)

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • inflate_job (bool) – Return job as an object instead of an id

  • join_avatars (bool) –

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_collection_analysis_input_download_url(collection_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_collection_analysis_input_zip_info(collection_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_collection_analysis_output_download_url(collection_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_collection_analysis_output_zip_info(collection_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_collection_download_url(collection_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

get_collection_file_info(cid, filename, **kwargs)

Get info for a particular file.

Get info for a particular file.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileOutput

get_collection_file_zip_info(collection_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_collection_note(cid, note_id, **kwargs)

Get a note on collection.

Get a note on collection

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_collection_sessions(collection_id, **kwargs)

List sessions in a collection

List sessions in a collection.

Parameters

  • collection_id (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[SessionListOutput],Page]

get_collection_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_collection_user_permission(collection_id, user_id, **kwargs)

List a user&#x27;s permissions for this group.

Parameters

  • collection_id (str) – (required)

  • user_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

PermissionAccessPermission

get_config(**kwargs)

Get public configuration

return config dict

Parameters

async (bool) – Perform the request asynchronously

Returns

ConfigOut

get_config_js(**kwargs)

Return public Scitran configuration information in javascript format.

Parameters

async (bool) – Perform the request asynchronously

Returns

None

get_container(container_id, **kwargs)

Retrieve a single container

Parameters

  • container_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ContainerOutput

get_container_analyses(cid, **kwargs)

Get analyses for container.

Returns analyses that directly belong to this resource.

Parameters

  • cid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • inflate_job (bool) –

  • join_avatars (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_container_analysis(cid, analysis_id, **kwargs)

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • inflate_job (bool) – Return job as an object instead of an id

  • join_avatars (bool) –

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_container_analysis_input_download_url(container_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_container_analysis_input_zip_info(container_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_container_analysis_output_download_url(container_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_container_analysis_output_zip_info(container_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_container_download_url(container_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

get_container_file_info(container_id, file_name, **kwargs)

Get info for a particular file.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

get_container_file_zip_info(container_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_container_note(cid, note_id, **kwargs)

Get a note on container.

Get a note on container

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_container_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_current_device(**kwargs)

Get Self

(get handlers.devicehandler.DeviceHandler.get_self)

Parameters

async (bool) – Perform the request asynchronously

Returns

EgressDevice

get_current_user(**kwargs)

Get information about the current user

Parameters

async (bool) – Perform the request asynchronously

Returns

User

get_current_user_avatar(**kwargs)

Get the avatar of the current user

Parameters

async (bool) – Perform the request asynchronously

Returns

None

get_current_user_info(**kwargs)

Get info of the current user

Parameters

  • fields (str) – Get only the specified fields from user’s info. Accept multiple fields separated by comma.

  • async (bool) – Perform the request asynchronously

Returns

None

get_current_user_jobs(**kwargs)

Return list of jobs created by the current user

Parameters

  • gear (str) – Gear name. Get only the jobs which are related to a specific gear.

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • async (bool) – Perform the request asynchronously

Returns

UserJobsOutput

get_daily_usage_report(**kwargs)

Get a daily usage report for the given month.

If no year/month pair is given, the current month will be used.

Parameters

  • year (int) – The year portion of the date

  • month (int) – The month portion of the date

  • group (str) – Limit the report to the given group id

  • project (str) – Limit the report to the given project id

  • csv (bool) – Download the report as a CSV file

  • async (bool) – Perform the request asynchronously

Returns

list[ReportDailyUsageEntry]

get_data_view_execution(data_view_execution_id, **kwargs)

Get a single data_view_execution

Parameters

  • data_view_execution_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DataViewExecution

get_data_view_execution_data(data_view_execution_id, **kwargs)

Get the data from a data_view_execution

Parameters

  • data_view_execution_id (str) – (required)

  • ticket (str) – download ticket id

  • file_format (str) –

  • file_name (str) – download ticket filename

  • async (bool) – Perform the request asynchronously

Returns

None

get_device(device_id, **kwargs)

Get device details

Parameters

  • device_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

EgressDevice

get_file(file_id, **kwargs)

Get File

Get file details

Parameters

  • file_id (str) – (required)

  • version (int) –

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

get_file_versions(file_id, **kwargs)

Get Versions

Get file version details

Parameters

  • file_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

list[FileVersionOutput]

get_gear(gear_id_or_name, **kwargs)

Retrieve details about a specific gear

Parameters

  • gear_id_or_name (str) – Id of the gear to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

GearDoc

get_gear_context(gear_id, container_type, container_id, **kwargs)

Get context values for the given gear and container.

Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values

Parameters

  • gear_id (str) – Id of the gear to interact with (required)

  • container_type (str) – Type of the container to interact with (required)

  • container_id (str) – Id of the container to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

GearContextLookup

get_gear_invocation(gear_id, **kwargs)

Get a schema for invoking a gear.

Parameters

  • gear_id (str) – Id of the gear to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

object

get_gear_series(gear_name, **kwargs)

Get gear series.

Gets the series for the gear by its name

Parameters

  • gear_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearSeries

get_gear_suggest(gear_id, container_type, container_id, **kwargs)

Get files with input suggestions, parent containers, and child containers for the given container.

Parameters

  • gear_id (str) – Id of the gear to interact with (required)

  • container_type (str) – Type of the container to interact with (required)

  • container_id (str) – Id of the container to interact with (required)

  • collection_id (str) – Get suggestions for a collection

  • include (str) – Include only “children” or “files”

  • async (bool) – Perform the request asynchronously

Returns

object

get_gear_ticket(gear_ticket_id, **kwargs)

Retrieve a specific gear ticket

Parameters

  • gear_ticket_id (str) – The ID of the the gear ticket to retrieve (required)

  • async (bool) – Perform the request asynchronously

Returns

object

get_group(group_id, **kwargs)

Get group info

Get a group by ID.

Parameters

  • group_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GroupOutput

get_group_projects(group_id, **kwargs)

Get all projects in a group

Get projects for a group

Parameters

  • group_id (str) – (required)

  • exhaustive (bool) –

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[ProjectListOutput]]

get_group_role(group_id, role_id, **kwargs)

Return the role identified by the RoleId

Parameters

  • group_id (str) – (required)

  • role_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

RolesRole

get_group_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_group_user_permission(group_id, user_id, **kwargs)

List a user&#x27;s permissions for this group.

Parameters

  • group_id (str) – (required)

  • user_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

PermissionAccessPermission

get_group_user_permission_template(group_id, user_id, **kwargs)

List a user&#x27;s permissions for this {{resource}}.

Parameters

  • group_id (str) – (required)

  • user_id (str) – (required)

  • propagate (bool) –

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse2003

get_job(job_id, **kwargs)

Get job details

Parameters

  • job_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobOutput

get_job_config(job_id, **kwargs)

Get a job&#x27;s config

Parameters

  • job_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobConfigOutput

get_job_detail(job_id, **kwargs)

Get job container details

Parameters

  • job_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobDetail

get_job_logs(job_id, **kwargs)

Get job logs

Parameters

  • job_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobLogRecord

get_jobs_stats(**kwargs)

Get stats about all current jobs

Parameters

async (bool) – Perform the request asynchronously

Returns

object

get_legacy_usage_report(type, **kwargs)

Get a usage report for the site grouped by month or project

This report is DEPRECATED and will be removed in a future release

Parameters

  • type (str) – The type of usage report to generate (required)

  • start_date (str) – An ISO formatted timestamp for the start time of the report

  • end_date (str) – An ISO formatted timestamp for the end time of the report

  • async (bool) – Perform the request asynchronously

Returns

list[ReportLegacyUsageEntry]

get_modality(modality_id, **kwargs)

Get a modality&#x27;s classification specification

Parameters

  • modality_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Modality

get_my_gear_tickets(**kwargs)

Retrieve all gear tickets for the current user

Parameters

  • gear_names_only (bool) – If set, returns a string array of ticket IDs instead of the tickets themselves.

  • async (bool) – Perform the request asynchronously

Returns

object

get_next_job(**kwargs)

Get the next job in the queue

Used by the engine.

Parameters

  • tags (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

Job

get_project(project_id, **kwargs)

Get a single project

Parameters

  • project_id (str) – (required)

  • join (JoinType) –

  • join_avatars (bool) – add name and avatar to notes

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

ProjectOutput

get_project_acquisitions(project_id, **kwargs)

List all acquisitions for the given project.

Parameters

  • project_id (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • collection_id (str) –

  • exhaustive (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

None

get_project_aet(project_aet, **kwargs)

Get DIMSE project AET

Get DIMSE project by AET, id or project id. Requires admin privilege.

Parameters

  • project_aet (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DimseProjectOutput

get_project_analyses(cid, **kwargs)

Get analyses for project.

Returns analyses that directly belong to this resource.

Parameters

  • cid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • inflate_job (bool) –

  • join_avatars (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_project_analysis(cid, analysis_id, **kwargs)

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • inflate_job (bool) – Return job as an object instead of an id

  • join_avatars (bool) –

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_project_analysis_input_download_url(project_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_project_analysis_input_zip_info(project_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_project_analysis_output_download_url(project_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_project_analysis_output_zip_info(project_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_project_download_url(project_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

get_project_file_info(project_id, file_name, **kwargs)

Get info for a particular file.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

get_project_file_zip_info(project_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_project_note(cid, note_id, **kwargs)

Get a note on project.

Get a note on project

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_project_report(**kwargs)
Parameters

  • projects (str) – Specify multiple times to include projects in the report

  • start_date (str) – Report start date

  • end_date (str) – Report end date

  • async (bool) – Perform the request asynchronously

Returns

ReportProject

get_project_rule(project_id, rule_id, **kwargs)

Get a project rule.

Parameters

  • project_id (str) – (required)

  • rule_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Rule

get_project_rules(project_id, **kwargs)

List all rules for a project.

Parameters

  • project_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

list[GearRule]

get_project_sessions(project_id, **kwargs)

List all sessions for the given project.

Returns a page of sessions by their parent

Parameters

  • project_id (str) – 24-char hex subject id (required)

  • join (JoinType) – join file origins

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[SessionListOutput]]

get_project_settings(project_id, **kwargs)

Get settings on project

Parameters

  • project_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ProjectSettingsOutput

get_project_subjects(project_id, **kwargs)

List all subjects for the given project.

List all subjects for the given project.

Parameters

  • project_id (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[SubjectOutputForList]]

get_project_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_project_user_permission(project_id, user_id, **kwargs)

List a user&#x27;s permissions for this project.

Parameters

  • project_id (str) – (required)

  • user_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse2003

get_provider(provider_id, **kwargs)

Return the provider identified by ProviderId

Parameters

  • provider_id (str) – The ID of the provider (required)

  • async (bool) – Perform the request asynchronously

Returns

Provider

get_provider_config(provider_id, **kwargs)

Return the configuration for provider identified by ProviderId

The returned configuration will be redacted, with any privileged values replaced with null.

Parameters

  • provider_id (str) – The ID of the provider (required)

  • async (bool) – Perform the request asynchronously

Returns

object

get_providers(**kwargs)

Return a list of all providers on the site

Parameters

  • _class (str) – Limit the response to the given provider class

  • async (bool) – Perform the request asynchronously

Returns

list[Provider]

get_role(role_id, **kwargs)

Return the role identified by the RoleId

Parameters

  • role_id (str) – The ID of the role (required)

  • async (bool) – Perform the request asynchronously

Returns

RolesRole

get_search_query_suggestions(body, **kwargs)

Get suggestions for a structured search query

Send the search query from the start of the string, and get a set of suggested replacements back. When utilizing a suggestion, the caller should replace the contents from the “from” field to the end of the string with the provided “value”.

Parameters
Returns

SearchQuerySuggestions

get_search_status(**kwargs)

Get the status of search (Mongo Connector)

Parameters

async (bool) – Perform the request asynchronously

Returns

SearchStatus

get_service_aet(service_aet, **kwargs)

Get DIMSE service by AET or id

Get a DIMSE service. Requires login and admin privilege.

Parameters

  • service_aet (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

DimseServiceOutput

get_session(session_id, **kwargs)

Get a single session

Get a single session

Parameters

  • session_id (str) – (required)

  • join_avatars (bool) – add name and avatar to notes

  • join (JoinType) –

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

SessionOutput

get_session_acquisitions(session_id, **kwargs)

List acquisitions in a session

Get acquisitions.

Parameters

  • session_id (str) – (required)

  • collection_id (str) –

  • exhaustive (bool) –

  • join (JoinType) –

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[AcquisitionListOutput],Page]

get_session_analyses(cid, **kwargs)

Get analyses for session.

Returns analyses that directly belong to this resource.

Parameters

  • cid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • inflate_job (bool) –

  • join_avatars (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_session_analysis(cid, analysis_id, **kwargs)

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • inflate_job (bool) – Return job as an object instead of an id

  • join_avatars (bool) –

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_session_analysis_input_download_url(session_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_session_analysis_input_zip_info(session_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_session_analysis_output_download_url(session_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_session_analysis_output_zip_info(session_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_session_download_url(session_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

get_session_file_info(session_id, file_name, **kwargs)

Get info for a particular file.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

get_session_file_zip_info(session_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_session_jobs(session_id, **kwargs)

Return any jobs that use inputs from this session

Gets session jobs.

Parameters

  • session_id (str) – (required)

  • states (list[str]) – filter results by job state

  • tags (list[str]) – filter results by job tags

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[JobsList,Page]

get_session_note(cid, note_id, **kwargs)

Get a note on session.

Get a note on session

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_session_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_site_report(**kwargs)
Parameters

async (bool) – Perform the request asynchronously

Returns

ReportSite

get_site_rule(rule_id, **kwargs)

Get a site rule.

Parameters

  • rule_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Rule

get_site_rules(**kwargs)

List all site rules.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[Rule]

get_site_settings(**kwargs)

Return administrative site settings

Returns the site settings, which includes center-pays gear list. If the site settings have never been created, then center_gears will be null, rather than an empty list.

Parameters

async (bool) – Perform the request asynchronously

Returns

SiteSettings

get_subject(subject_id, **kwargs)

Get a single subject

Get an subject by its id Args: subject_id: The id of the subject join: Attribute to join on join_avatars: Join the user avatars for permissions auth_session: The auth session Returns: SubjectOutput

Parameters

  • subject_id (str) – 24-char hex subject id (required)

  • join (JoinType) – join file origins

  • join_avatars (bool) – add name and avatar to notes

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

SubjectOutput

get_subject_analyses(cid, **kwargs)

Get analyses for subject.

Returns analyses that directly belong to this resource.

Parameters

  • cid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • inflate_job (bool) –

  • join_avatars (bool) –

  • join (JoinType) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[union[AnalysisListOutput,AnalysisListOutputInflatedJob]]]

get_subject_analysis(cid, analysis_id, **kwargs)

Get an analysis.

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • inflate_job (bool) – Return job as an object instead of an id

  • join_avatars (bool) –

  • join (JoinType) –

  • async (bool) – Perform the request asynchronously

Returns

union[AnalysisOutputInflatedJob,AnalysisOutput]

get_subject_analysis_input_download_url(subject_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_subject_analysis_input_zip_info(subject_id, analysis_id, filename, **kwargs)

Download analysis inputs with filter.

If “ticket” query param is included and not empty, download inputs. If “ticket” query param is included and empty, create a ticket for matching inputs in the analysis. If no “ticket” query param is included, inputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the inputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_subject_analysis_output_download_url(subject_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

AnalysisFilesCreateTicketOutput

get_subject_analysis_output_zip_info(subject_id, analysis_id, filename, **kwargs)

Download analysis outputs with filter.

If “ticket” query param is included and not empty, download outputs. If “ticket” query param is included and empty, create a ticket for matching outputs in the analysis. If no “ticket” query param is included, outputs will be downloaded directly.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • filename (str) – filename to download (get tar of all if empty) (required)

  • ticket (str) – ticket id of the outputs to download

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_subject_download_url(subject_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

DownloadTicket

get_subject_file_info(subject_id, file_name, **kwargs)

Get info for a particular file.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

get_subject_file_zip_info(subject_id, file_name, **kwargs)

Download a file.

Files can be downloaded directly from this endpoint with a valid “Authorization” header or via a ticket id. To generate a ticket: - Make a request with an empty “ticket” parameter and a valid “Authorization” header. The server will respond with a generated ticket id. - Make another request with the received ticket id in the “ticket” parameter. A valid “Authorization” header is no longer required. When “view” is true, [RFC7233](https://tools.ietf.org/html/rfc7233) range request headers are supported. When virus_scan feature is enabled the quarantined files only can be downloaded using signed urls otherwise it will return with a HTTP 400 response.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • ticket (str) – The generated ticket id for the download, or present but empty to generate a ticket id

  • view (bool) – If true, the proper “Content-Type” header based on the file’s mimetype is set on response If false, the “Content-Type” header is set to “application/octet-stream”

  • info (bool) – If the file is a zipfile, return a json response of zipfile member information

  • member (str) – The filename of a zipfile member to download rather than the entire file

  • signature (str) – Url’s signature (signed download url)

  • expires (str) – Signed url expiration time (epoch time)

  • async (bool) – Perform the request asynchronously

Returns

FileZipInfo

get_subject_note(cid, note_id, **kwargs)

Get a note on subject.

Get a note on subject

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Note

get_subject_sessions(subject_id, **kwargs)

List sessions of a subject

List sessions of a subject

Parameters

  • subject_id (str) – 24-char hex subject id (required)

  • join (JoinType) – join file origins

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[union[HeaderFeature,string]]) –

  • async (bool) – Perform the request asynchronously

Returns

union[Page,list[SessionListOutput]]

get_subject_tag(cid, value, **kwargs)

Get the value of a tag, by name.

Get the value of a tag, by name

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • async (bool) – Perform the request asynchronously

Returns

str

get_tree_graph(**kwargs)

Get a description of the flywheel hiearchy

Parameters

async (bool) – Perform the request asynchronously

Returns

TreeGraph

get_usage_availability(**kwargs)

Get year/month combinations where report data is available.

Parameters

async (bool) – Perform the request asynchronously

Returns

list[ReportTimePeriod]

get_usage_report(**kwargs)

Get a usage report for the given month.

If no year/month pair is given, the current month will be used.

Parameters

  • year (int) – The year portion of the date

  • month (int) – The month portion of the date

  • async (bool) – Perform the request asynchronously

Returns

list[ReportUsageEntry]

get_user(user_id, **kwargs)

Get information about the specified user

Parameters

  • user_id (str) – (required)

  • include_deleted (str) –

  • async (bool) – Perform the request asynchronously

Returns

User

get_user_acquisitions(uid, **kwargs)

Get all acquisitions that belong to the given user.

Parameters

  • uid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • async (bool) – Perform the request asynchronously

Returns

list[AcquisitionListOutput]

get_user_avatar(user_id, **kwargs)

Get the avatar of the specified user

Parameters

  • user_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

get_user_collections(user_id, **kwargs)

Get all collections that belong to the given user.

Parameters

  • user_id (str) – (required)

  • filter (str) –

  • sort (str) –

  • limit (int) –

  • skip (int) –

  • page (int) –

  • after_id (str) –

  • x_accept_feature (list[str]) –

  • async (bool) – Perform the request asynchronously

Returns

union[list[CollectionWithStats],list[CollectionOutput],Page]

get_user_groups(uid, **kwargs)

List all groups the specified user is a member of

Parameters

  • uid (str) – (required)

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

list[GroupOutput]

get_user_projects(uid, **kwargs)

Get all projects that belong to the given user.

Parameters

  • uid (str) – (required)

  • filter (str) – The filter to apply. (e.g. label=my-label,created>2018-09-22)

  • sort (str) – The sort fields and order. (e.g. label:asc,created:desc)

  • limit (int) – The maximum number of entries to return.

  • skip (int) – The number of entries to skip.

  • page (int) – The page number (i.e. skip limit*page entries)

  • after_id (str) – Paginate after the given id. (Cannot be used with sort, page or skip)

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • async (bool) – Perform the request asynchronously

Returns

list[ProjectListOutput]

get_user_sessions(uid, **kwargs)

Get all sessions that belong to the given user.

Get all sessions that belong to the given user.

Parameters

  • uid (str) – (required)

  • filter (str) –

  • sort (str) –

  • limit (int) –

  • skip (int) –

  • page (int) –

  • after_id (str) –

  • exhaustive (bool) –

  • async (bool) – Perform the request asynchronously

Returns

list[SessionListOutput]

get_version(**kwargs)

Get server and database schema version info

Parameters

async (bool) – Perform the request asynchronously

Returns

VersionOutput

get_view(view_id, **kwargs)

Return the view identified by ViewId

Parameters

  • view_id (str) – The ID of the view (required)

  • async (bool) – Perform the request asynchronously

Returns

DataView

get_views(container_id, **kwargs)

Return a list of all views belonging to container

Parameters

  • container_id (str) – The ID of the container, one of user, group or project. Use “site” as containerId to save or get a site data view. (required)

  • async (bool) – Perform the request asynchronously

Returns

list[DataView]

login(**kwargs)

Login

Scitran Authentication

Parameters

async (bool) – Perform the request asynchronously

Returns

AuthLoginOutput

logout(**kwargs)

Log Out

Remove authtokens for user

Parameters

async (bool) – Perform the request asynchronously

Returns

AuthLogoutOutput

lookup(path)

Perform a path based lookup of a single node in the Flywheel hierarchy.

Parameters

path (str) – (required) The path to resolve

Returns

ResolverOutput

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.

Parameters

  • body (ResolverInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ResolverNode

modify_acquisition(acquisition_id, body, **kwargs)

Update an acquisition

Update an acquisition

Parameters

  • acquisition_id (str) – (required)

  • body (AcquisitionModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_acquisition_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_acquisition_file(cid, filename, body, **kwargs)

Modify a file&#x27;s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_acquisition_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileClassificationDelta) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_acquisition_file_info(acquisition_id, file_name, body, **kwargs)

Update info for a particular file.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_acquisition_info(acquisition_id, body, **kwargs)

Update or replace info for a acquisition.

Parameters

  • acquisition_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_acquisition_note(cid, note_id, body, **kwargs)

Update a note on acquisition.

Update a note on acquisition

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

int

modify_analysis(analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis by its id Args: analysis_id: The id of the analysis analysis_modify: The modifications to make auth_session: The auth session

Parameters

  • analysis_id (str) – 24-char hex analysis id (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_analysis_info(analysis_id, body, **kwargs)

Update or replace info for a analysis.

Parameters

  • analysis_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_analysis_note(container_id, note_id, body, **kwargs)

Update a note on analysis.

Update a note on analysis

Parameters

  • container_id (str) – Container id (required)

  • note_id (str) – 24-char hex note id (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

int

modify_collection(collection_id, body, **kwargs)

Update a collection and its contents

Update a collection and its contents

Parameters

  • collection_id (str) – (required)

  • body (CollectionInputWithContents) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_collection_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_collection_file(cid, filename, body, **kwargs)

Modify a file&#x27;s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_collection_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileClassificationDelta) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_collection_file_info(collection_id, file_name, body, **kwargs)

Update info for a particular file.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_collection_info(collection_id, body, **kwargs)

Update or replace info for a collection.

Parameters

  • collection_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_collection_note(cid, note_id, body, **kwargs)

Update a note on collection.

Update a note on collection

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

int

modify_collection_user_permission(collection_id, user_id, body, **kwargs)

Update a user&#x27;s permission for this group.

Parameters

  • collection_id (str) – (required)

  • user_id (str) – (required)

  • body (PermissionAccessPermission) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_container(container_id, body, **kwargs)

Update a container and its contents

Parameters

  • container_id (str) – (required)

  • body (ContainerUpdate) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_container_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_container_file(cid, filename, body, **kwargs)

Modify a file&#x27;s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_container_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileClassificationDelta) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_container_file_info(container_id, file_name, body, **kwargs)

Update info for a particular file.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_container_info(container_id, body, **kwargs)

Update or replace info for a container.

Parameters

  • container_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_container_note(cid, note_id, body, **kwargs)

Update a note on container.

Update a note on container

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

int

modify_current_user_info(body, **kwargs)

Update or replace info for the current user.

Parameters

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_device(device_id, body, **kwargs)

Update a device

Parameters

  • device_id (str) – (required)

  • body (Device) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_gear_series(gear_name, body, **kwargs)

Update a gear series

Parameters

  • gear_name (str) – Name of the gear series to modify (required)

  • body (GearSeriesUpdate) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearSeries

modify_group(group_id, body, **kwargs)

Update group

Modify a group.

Parameters

  • group_id (str) – (required)

  • body (GroupUpdate) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_group_user_permission(group_id, user_id, body, **kwargs)

Update a user&#x27;s permission for this group.

Parameters

  • group_id (str) – (required)

  • user_id (str) – (required)

  • body (PermissionAccessPermission) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_group_user_permission_template(group_id, user_id, body, **kwargs)

Update a user&#x27;s permission for this {{resource}}.

Parameters

  • group_id (str) – (required)

  • user_id (str) – (required)

  • body (RolesRoleAssignment) – (required)

  • propagate (bool) –

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_job(job_id, body, **kwargs)

Update a job.

Updates timestamp. Enforces a valid state machine transition, if any. Rejects any change to a job that is not currently in ‘pending’ or ‘running’ state. Accepts the same body as /api/jobs/add, except all fields are optional.

Parameters

  • job_id (str) – (required)

  • body (JobModify) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_project(project_id, body, **kwargs)

Update a project

Parameters

  • project_id (str) – (required)

  • body (ProjectModify) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_project_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_project_file(cid, filename, body, **kwargs)

Modify a file&#x27;s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_project_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileClassificationDelta) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_project_file_info(project_id, file_name, body, **kwargs)

Update info for a particular file.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_project_info(project_id, body, **kwargs)

Update or replace info for a project.

Parameters

  • project_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_project_note(cid, note_id, body, **kwargs)

Update a note on project.

Update a note on project

Parameters

  • cid (str) – (required)

  • note_id (str) – (required)

  • body (NoteInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

int

modify_project_rule(project_id, rule_id, body, **kwargs)

Update a rule on a project.

Parameters

  • project_id (str) – (required)

  • rule_id (str) – (required)

  • body (Rule) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_project_settings(project_id, body, **kwargs)

Modify project settings

Parameters
Returns

ProjectSharingSettingsProjectSettingsOutput

modify_project_user_permission(project_id, user_id, body, **kwargs)

Update a user&#x27;s permission for this project.

Parameters

  • project_id (str) – (required)

  • user_id (str) – (required)

  • body (RolesRoleAssignment) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_provider(provider_id, body, **kwargs)

Update the provider identified by ProviderId

Parameters

  • provider_id (str) – The ID of the provider (required)

  • body (ProviderInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_role(role_id, body, **kwargs)

Update the role identified by RoleId

Parameters

  • role_id (str) – The ID of the role (required)

  • body (RolesRoleInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_session(session_id, body, **kwargs)

Update a session

Modify a session.

Parameters

  • session_id (str) – (required)

  • body (SessionModify) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_session_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_session_file(cid, filename, body, **kwargs)

Modify a file&#x27;s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_session_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileClassificationDelta) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_session_file_info(session_id, file_name, body, **kwargs)

Update info for a particular file.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_session_info(session_id, body, **kwargs)

Update or replace info for a session.

Parameters

  • session_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_session_note(session_id, note_id, body, **kwargs)

Update a note on session.

Parameters

  • session_id (str) – (required)

  • note_id (str) – (required)

  • body (Note) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_site_rule(rule_id, body, **kwargs)

Update a site rule.

Parameters

  • rule_id (str) – (required)

  • body (Rule) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_site_settings(body, **kwargs)

Update administrative site settings

Parameters
Returns

None

modify_subject(subject_id, body, **kwargs)

Update a subject

Update a subject

Parameters

  • subject_id (str) – 24-char hex subject id (required)

  • body (SubjectModify) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_subject_analysis(cid, analysis_id, body, **kwargs)

Modify an analysis.

Modify an analysis.

Parameters

  • cid (str) – (required)

  • analysis_id (str) – (required)

  • body (AnalysisModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_subject_file(cid, filename, body, **kwargs)

Modify a file&#x27;s attributes

Note: If modifying a file’s modality, the current classification will be cleared (except for items in the “Custom” list)

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileModifyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_subject_file_classification(cid, filename, body, **kwargs)

Update classification for a particular file.

If replacing a file’s classification, the modality can optionally be modified as well.

Parameters

  • cid (str) – (required)

  • filename (str) – (required)

  • body (FileClassificationDelta) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_subject_file_info(subject_id, file_name, body, **kwargs)

Update info for a particular file.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_subject_info(subject_id, body, **kwargs)

Update or replace info for a subject.

Parameters

  • subject_id (str) – (required)

  • body (InfoUpdateInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

modify_subject_note(subject_id, note_id, body, **kwargs)

Update a note on subject.

Parameters

  • subject_id (str) – (required)

  • note_id (str) – (required)

  • body (Note) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

modify_user(uid, body, **kwargs)

Update the specified user

Parameters

  • uid (str) – (required)

  • body (ModifyUserInput) – (required)

  • clear_permissions (bool) –

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

modify_view(view_id, body, **kwargs)

Update the view identified by ViewId

Parameters

  • view_id (str) – The ID of the view (required)

  • body (DataView) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

move_file(file_id, body, **kwargs)

Move and/or rename a file

Move a file to a new container and/or give it a new name

Parameters

  • file_id (str) – (required)

  • body (FileMoveInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

parse_search_query(body, **kwargs)

Parse a structured search query

Validates a search query, returning any parse errors that were encountered. In the future, this endpoint may return the abstract syntax tree or evaluated query.

Parameters
Returns

SearchParseSearchQueryResult

perform_version_check()
prepare_add_gear(body, **kwargs)

Prepare a gear upload

Parameters

  • body (GearDoc) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearReturnTicket

prepare_complete_job(job_id, **kwargs)

Create a ticket for completing a job, with id and status.

Parameters

  • job_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

JobCompletionTicket

print_view_columns(filter=None, limit=25, file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)

Print a list of column aliases that can be used in data views.

Parameters

  • filter (str) – The filter for available columns

  • limit (int) – The limit for the number of columns to return

  • file (file-like) – The file to print to

project_copy(project_id, body, **kwargs)

Copy By Reference

Copy a project and its descendants to a new project tree

Parameters

  • project_id (str) – (required)

  • body (ProjectCopyInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ProjectCopyOutput

project_packfile_upload(project_id, token, file, **kwargs)

Add files to an in-progress packfile

Parameters

  • project_id (str) – (required)

  • token (str) – (required)

  • file (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

list[FileEntry]

propose_batch(body, **kwargs)

Create a batch job proposal and insert it as &#x27;pending&#x27;.

Parameters

  • body (BatchProposalInput) – The batch proposal (required)

  • async (bool) – Perform the request asynchronously

Returns

BatchProposal

queue_adhoc(container_id, body, **kwargs)

Execute an ad-hoc view, returning a reference to the created data view execution.

Parameters

  • container_id (str) – The target container for view execution (required)

  • body (DataView) – (required)

  • filter (str) – An optional filter expression

  • skip (int) – The optional number of rows to skip

  • limit (int) – The optional max number of rows to return

  • async (bool) – Perform the request asynchronously

Returns

DataViewExecution

queue_saved(view_id, container_id, **kwargs)

Execute a view, returning a reference to the created data view execution.

Parameters

  • view_id (str) – The ID of the view (required)

  • container_id (str) – The target container for view execution (required)

  • filter (str) – An optional filter expression

  • skip (int) – The optional number of rows to skip

  • limit (int) – The optional max number of rows to return

  • async (bool) – Perform the request asynchronously

Returns

DataViewExecution

read_view_data(view, container_id, decode=True, **kwargs)

Execute a data view against container, and return a file-like object that can be streamed.

Parameters

  • view (str or DataView) – The view id or DataView object to execute.

  • container_id (str) – The id of the container to execute the view against

  • decode (bool) – Whether or not to decode the stream to utf-8 (default is true)

  • kwargs – Additional arguments to pass to the evaluate_view call. (e.g. format=’csv’)

Returns

A file-like object where the contents can be read

read_view_dataframe(view, container_id, opts=None, **kwargs)

Execute a data view against container, and return a DataFrame.

NOTE: This requires that the pandas module be installed on the system.

Parameters

  • view (str or DataView) – The view id or DataView object to execute.

  • container_id (str) – The id of the container to execute the view against

  • opts (object) – Additional options to pass to the pandas read_json function

  • kwargs – Additional arguments to pass to the evaluate_view call.

Returns

A pandas DataFrame

reap_jobs(**kwargs)

Reap stale jobs

Parameters

async (bool) – Perform the request asynchronously

Returns

object

recalc_all_projects(**kwargs)

Recalculate all sessions against their project templates.

Iterates all projects that have a session template. Recalculate if projects’ sessions satisfy the template. Returns list of modified session ids.

Parameters

async (bool) – Perform the request asynchronously

Returns

SessionTemplateRecalcOutput

recalc_project(project_id, **kwargs)

Recalculate if sessions in the project satisfy the template.

Returns list of modified session ids.

Parameters

  • project_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

SessionTemplateRecalcOutput

regenerate_key(device_id, **kwargs)

Regenerate device API key

Parameters

  • device_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse2001

remove_project_rule(project_id, rule_id, **kwargs)

Remove a project rule.

Parameters

  • project_id (str) – (required)

  • rule_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse2002

remove_project_template(project_id, **kwargs)

Remove the session template for a project.

Parameters

  • project_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse2002

remove_role_from_group(group_id, role_id, **kwargs)

Remove the role from the group

Parameters

  • group_id (str) – (required)

  • role_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

remove_site_rule(rule_id, **kwargs)

Remove a site rule.

Parameters

  • rule_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse2002

rename_acquisition_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_analysis_tag(container_id, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • container_id (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_collection_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_container_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_group_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_project_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_session_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

rename_subject_tag(cid, value, body, **kwargs)

Rename a tag.

Rename a tag

Parameters

  • cid (str) – (required)

  • value (str) – The tag to interact with (required)

  • body (Tag) – (required)

  • async (bool) – Perform the request asynchronously

Returns

str

replace_acquisition_file(acquisition_id, file_name, **kwargs)

Replace a file

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

replace_acquisition_file_classification(cid, filename, body, **kwargs)

Entirely replace classification with the provided fields.

Parameters
Returns

ModifiedResult

replace_acquisition_file_info(acquisition_id, file_name, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

replace_acquisition_info(acquisition_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • acquisition_id (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

None

replace_analysis_info(analysis_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters
Returns

None

replace_collection_file(collection_id, file_name, **kwargs)

Replace a file

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

replace_collection_file_classification(cid, filename, body, **kwargs)

Entirely replace classification with the provided fields.

Parameters
Returns

ModifiedResult

replace_collection_file_info(collection_id, file_name, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

replace_collection_info(collection_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters
Returns

None

replace_container_file(container_id, file_name, **kwargs)

Replace a file

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

replace_container_file_classification(cid, filename, body, **kwargs)

Entirely replace classification with the provided fields.

Parameters
Returns

ModifiedResult

replace_container_file_info(container_id, file_name, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

replace_container_info(container_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters
Returns

None

replace_gear_permissions(gear_name, body, **kwargs)

Replace permissions for the given gear

Parameters

  • gear_name (str) – Name of the gear to interact with (required)

  • body (GearPermissions) – (required)

  • async (bool) – Perform the request asynchronously

Returns

GearSeries

replace_modality(modality_id, body, **kwargs)

Replace modality

Parameters

  • modality_id (str) – (required)

  • body (ModalityModify) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModalityOutput

replace_project_file(project_id, file_name, **kwargs)

Replace a file

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

replace_project_file_classification(cid, filename, body, **kwargs)

Entirely replace classification with the provided fields.

Parameters
Returns

ModifiedResult

replace_project_file_info(project_id, file_name, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

replace_project_info(project_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters
Returns

None

replace_session_file(session_id, file_name, **kwargs)

Replace a file

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

replace_session_file_classification(cid, filename, body, **kwargs)

Entirely replace classification with the provided fields.

Parameters
Returns

ModifiedResult

replace_session_file_info(session_id, file_name, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

replace_session_info(session_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters
Returns

None

replace_subject_file(subject_id, file_name, **kwargs)

Replace a file

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

replace_subject_file_classification(cid, filename, body, **kwargs)

Entirely replace classification with the provided fields.

Parameters
Returns

ModifiedResult

replace_subject_file_info(subject_id, file_name, body, **kwargs)

Entirely replace info with the provided fields.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

replace_subject_info(subject_id, body, **kwargs)

Entirely replace info with the provided fields.

Parameters
Returns

None

resolve(path, **kwargs)

Perform a path based lookup of nodes in the Flywheel hierarchy.

Parameters

path (str) – (required) The path to resolve

Returns

ResolverOutput

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.

Parameters

  • body (ResolverInput) – (required)

  • exhaustive (bool) – Set to return a complete list regardless of permissions

  • full_tree (bool) – Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/…)

  • minattr (bool) – Return only minimal attributes

  • async (bool) – Perform the request asynchronously

Returns

ResolverOutput

restore_file(file_id, version, evaluate_gear_rules, **kwargs)

Restore a File

Restore a specific version of a file as the active version. This will create a new version which will be identical to the restored version.

Parameters

  • file_id (str) – (required)

  • version (int) – (required)

  • evaluate_gear_rules (bool) – Specify if gear rules should be reevaluated on the newly created file version (required)

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

retry_job(job_id, **kwargs)

Retry a job.

The job must have a state of ‘failed’, and must not have already been retried. The failed jobs config is copied to a new job. The ID of the new job is returned

Parameters

  • job_id (str) – (required)

  • compute_provider_id (str) –

  • ignore_state (bool) –

  • async (bool) – Perform the request asynchronously

Returns

object

save_data_view_execution(data_view_execution_id, **kwargs)

Save a data_view_execution to a project

Parameters

  • data_view_execution_id (str) – (required)

  • file_format (str) –

  • async (bool) – Perform the request asynchronously

Returns

FileEntry

save_gear(body, **kwargs)

Report the result of a gear upload and save the ticket

Parameters

  • body (GearSaveSubmission) – The ticket, repo and pointer (required)

  • async (bool) – Perform the request asynchronously

Returns

object

save_view_data(view, container_id, dest_file, **kwargs)

Execute a data view against container, and save the results to disk.

Parameters

  • view (str or DataView) – The view id or DataView object to execute.

  • container_id (str) – The id of the container to execute the view against

  • dest_file (str) – The destination file path

  • kwargs – Additional arguments to pass to the evaluate_view call. (e.g. format=’csv’)

save_view_data_task_manager(view, container_id, dest_file, **kwargs)
save_view_data_to_container(container_id, body, **kwargs)

Execute a view, saving data to the target container / file

Parameters

  • container_id (str) – The target container for view execution (required)

  • body (DataViewSaveDataViewInput) – (required)

  • format (str) –

  • filter (str) – An optional filter expression

  • skip (int) – The optional number of rows to skip

  • limit (int) – The optional max number of rows to return

  • async (bool) – Perform the request asynchronously

Returns

None

search(body, **kwargs)

Perform a search query

Parameters

  • body (SearchQuery) – (required)

  • simple (bool) – Unwrap result documents into a list.

  • size (int) – The maximum number of results to return.

  • facets (bool) – Include additional statistics about the search results. Internal use only.

  • csv (bool) – Format the response as a CSV file

  • async (bool) – Perform the request asynchronously

Returns

union[list[SearchResponse],object]

set_acquisition_file_classification(cid, filename, body, **kwargs)

Update classification with the provided fields.

Parameters
Returns

ModifiedResult

set_acquisition_file_info(acquisition_id, file_name, body, **kwargs)

Update info with the provided fields.

Parameters

  • acquisition_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

set_acquisition_info(acquisition_id, body, **kwargs)

Update info with the provided fields.

Parameters

  • acquisition_id (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

None

set_analysis_info(analysis_id, body, **kwargs)

Update info with the provided fields.

Parameters
Returns

None

set_collection_file_classification(cid, filename, body, **kwargs)

Update classification with the provided fields.

Parameters
Returns

ModifiedResult

set_collection_file_info(collection_id, file_name, body, **kwargs)

Update info with the provided fields.

Parameters

  • collection_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

set_collection_info(collection_id, body, **kwargs)

Update info with the provided fields.

Parameters
Returns

None

set_container_file_classification(cid, filename, body, **kwargs)

Update classification with the provided fields.

Parameters
Returns

ModifiedResult

set_container_file_info(container_id, file_name, body, **kwargs)

Update info with the provided fields.

Parameters

  • container_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

set_container_info(container_id, body, **kwargs)

Update info with the provided fields.

Parameters
Returns

None

set_file_tags(file_id, body, **kwargs)

Set list of tags on a file.

Set the tags on a file to the list of tags provided

Parameters

  • file_id (str) – (required)

  • body (list[str]) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ModifiedResult

set_project_file_classification(cid, filename, body, **kwargs)

Update classification with the provided fields.

Parameters
Returns

ModifiedResult

set_project_file_info(project_id, file_name, body, **kwargs)

Update info with the provided fields.

Parameters

  • project_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

set_project_info(project_id, body, **kwargs)

Update info with the provided fields.

Parameters
Returns

None

set_project_template(project_id, body, **kwargs)

Set the session template for a project.

Parameters
Returns

InlineResponse200

set_session_file_classification(cid, filename, body, **kwargs)

Update classification with the provided fields.

Parameters
Returns

ModifiedResult

set_session_file_info(session_id, file_name, body, **kwargs)

Update info with the provided fields.

Parameters

  • session_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

set_session_info(session_id, body, **kwargs)

Update info with the provided fields.

Parameters
Returns

None

set_subject_file_classification(cid, filename, body, **kwargs)

Update classification with the provided fields.

Parameters
Returns

ModifiedResult

set_subject_file_info(subject_id, file_name, body, **kwargs)

Update info with the provided fields.

Parameters

  • subject_id (str) – (required)

  • file_name (str) – (required)

  • body (InfoUpdateInput) – (required)

Returns

InlineResponse200

set_subject_info(subject_id, body, **kwargs)

Update info with the provided fields.

Parameters
Returns

None

shutdown()

Release any outstanding resources

start_batch(batch_id, **kwargs)

Launch a job.

Creates jobs from proposed inputs, returns jobs enqueued. Moves ‘pending’ batch job to ‘running’.

Parameters

  • batch_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

list[JobOutput]

start_project_packfile_upload(project_id, **kwargs)

Start a packfile upload to project

Parameters

  • project_id (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

UploadTokenOutput

update_device(body, **kwargs)

Modify a device&#x27;s type, name, interval, info or set errors.

Will modify the device record of the device making the request. Type may only be set once if not already specified at creation. Request must be a drone request.

Parameters

  • body (Device) – (required)

  • async (bool) – Perform the request asynchronously

Returns

Device

update_job_profile(job_id, body, **kwargs)

Update profile information on a job. (e.g. machine type, etc)

Parameters

  • job_id (str) – (required)

  • body (JobProfileInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

InlineResponse200

upload_by_label(**kwargs)

Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > For technical reasons, no form field names can be repeated. Instead, use (file1, file2) and so forth. > A non-file form field called “metadata” is also required, which must be a string containing JSON. > See api/schemas/input/labelupload.json for the format of this metadata. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

  • ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload

  • body (str) – Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

  • form_data (str) –

  • async (bool) – Perform the request asynchronously

Returns

object

upload_by_reaper(**kwargs)

Bottom-up UID matching of Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > Upload data, allowing users to move sessions during scans without causing new data to be created in referenced project/group. ### Evaluation Order: * If a matching acquisition UID is found anywhere on the system, the related files will be placed under that acquisition. * OR If a matching session UID is found, a new acquistion is created with the specified UID under that Session UID. * OR If a matching group ID and project label are found, a new session and acquisition will be created within that project * OR If a matching group ID is found, a new project and session and acquisition will be created within that group. * OR A new session and acquisition will be created within a special “Unknown” group and project, which is only visible to system administrators. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

  • ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload

  • body (str) – Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

  • form_data (str) –

  • async (bool) – Perform the request asynchronously

Returns

list[FileEntry]

upload_by_uid(**kwargs)

Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > Same behavior as /api/upload/label, except the metadata field must be uid format See api/schemas/input/uidupload.json for the format of this metadata. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

  • ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload

  • body (str) – Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

  • form_data (str) –

  • async (bool) – Perform the request asynchronously

Returns

object

upload_file_to_acquisition(cid, file, **kwargs)

Upload a file to acquisition.

Parameters

  • cid (str) – (required)

  • file (str) – The file to upload (required)

  • preserve_metadata (bool) –

  • ticket (str) –

  • metadata (str) – File metadata

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

union[list[FileOutput],UploadTicketOutput]

upload_file_to_collection(cid, file, **kwargs)

Upload a file to collection.

Parameters

  • cid (str) – (required)

  • file (str) – The file to upload (required)

  • preserve_metadata (bool) –

  • ticket (str) –

  • metadata (str) – File metadata

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

union[list[FileOutput],UploadTicketOutput]

upload_file_to_container(cid, file, **kwargs)

Upload a file to container.

Parameters

  • cid (str) – (required)

  • file (str) – The file to upload (required)

  • preserve_metadata (bool) –

  • ticket (str) –

  • metadata (str) – File metadata

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

union[list[FileOutput],UploadTicketOutput]

upload_file_to_project(cid, file, **kwargs)

Upload a file to project.

Parameters

  • cid (str) – (required)

  • file (str) – The file to upload (required)

  • preserve_metadata (bool) –

  • ticket (str) –

  • metadata (str) – File metadata

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

union[list[FileOutput],UploadTicketOutput]

upload_file_to_session(cid, file, **kwargs)

Upload a file to session.

Parameters

  • cid (str) – (required)

  • file (str) – The file to upload (required)

  • preserve_metadata (bool) –

  • ticket (str) –

  • metadata (str) – File metadata

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

union[list[FileOutput],UploadTicketOutput]

upload_file_to_subject(cid, file, **kwargs)

Upload a file to subject.

Parameters

  • cid (str) – (required)

  • file (str) – The file to upload (required)

  • preserve_metadata (bool) –

  • ticket (str) –

  • metadata (str) – File metadata

  • x_accept_feature (list[str]) – redirect header

  • async (bool) – Perform the request asynchronously

Returns

union[list[FileOutput],UploadTicketOutput]

upload_match_uid(**kwargs)

Multipart form upload with N file fields, each with their desired filename.

### Default behavior: > Accepts uploads to an existing data hierarchy, matched via Session and Acquisition UID See api/schemas/input/uidmatchupload.json for the format of this metadata. ### Signed URL upload with ticket > Upload a single file directly to the storage backend. The workflow is the following: - Send a request with an empty ?ticket= query parameter to get an upload ticket and URL - Upload the file using a PUT request to the upload URL - Once done, send a POST request to this endpoint with the upload ticket to finalize the upload. The file will be placed into the DB via this POST request.

Parameters

  • ticket (str) – Use empty value to get a ticket, and provide the ticket id to finalize the upload

  • body (str) – Object encoded as a JSON string. It is required and used only when the ticket parameter is used. See schemas/input/signedurlmetadata.json for the format of the json payload.

  • form_data (str) –

  • async (bool) – Perform the request asynchronously

Returns

object

upload_output_to_acquisition_analysis(acquisition_id, analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • acquisition_id (str) – (required)

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_output_to_analysis(analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_output_to_collection_analysis(collection_id, analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • collection_id (str) – (required)

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_output_to_container_analysis(container_id, analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • container_id (str) – (required)

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_output_to_project_analysis(project_id, analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • project_id (str) – (required)

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_output_to_session_analysis(session_id, analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • session_id (str) – (required)

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_output_to_subject_analysis(subject_id, analysis_id, file, **kwargs)

Upload an output file to analysis.

Parameters

  • subject_id (str) – (required)

  • analysis_id (str) – (required)

  • file (str) – The file to upload (required)

  • async (bool) – Perform the request asynchronously

Returns

None

upload_signed_fs_file(token, body, **kwargs)

Upload file to local filesystem storage provider

The POST /api/upload/signed-url endpoint returns a url with a jwt token pointing to this endpoint if the storage provider is a local filesystem then the file can be uploaded simply by sending the file content in the body of the payload. The destination storage provider and the file path are encoded in the jwt token.

Parameters

  • token (str) – Upload token (required)

  • body (Object) – (required)

  • async (bool) – Perform the request asynchronously

Returns

UploadSignedFsFileUploadOutput

upsert_file(body, **kwargs)

Upsert a File

Create or update a file

Parameters

  • body (FileUpsertInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

FileUpsertOutput

upsert_project_hierarchy(project_id, body, **kwargs)

Create or update subject, session and acquisition containers in the project.

Create, update or just return an existing container sub-hierarchy as-is for the given project. Useful for efficient and highly parallel automated imports using device authN, based on common routing fields such as id, uid and label.

Parameters

  • project_id (str) – (required)

  • body (ProjectHierarchyUpsertInput) – (required)

  • async (bool) – Perform the request asynchronously

Returns

ProjectHierarchyUpsertOutput

verify_master_subject_code(code, **kwargs)

Verify that the given master subject code exists or not

Parameters

  • code (str) – (required)

  • async (bool) – Perform the request asynchronously

Returns

None

flywheel.flywheel.config_from_api_key(api_key)

flywheel.gear_context module

Provides gear helper functions

class flywheel.gear_context.GearContext(gear_path=None)

Bases: object

Provides helper functions for gear development

property client

Get the SDK client, if an api key input exists.

Raises a ValueError if there is no api-key input.

Returns

The SDK client

Return type

Client

property config

Get the config dictionary.

Returns

The configuration dictionary.

Return type

dict

property destination

Get the destination reference.

Returns

The destination dictionary.

Return type

dict

download_project_bids(target_dir='work/bids', src_data=False, subjects=None, sessions=None, folders=None, **kwargs)

Download the project in bids format to target_dir.

Parameters

  • target_dir (str) – The destination directory (otherwise work/bids will be used)

  • src_data (bool) – Whether or not to include src data (e.g. dicoms)

  • subjects (list) – The list of subjects to include (via subject code) otherwise all subjects

  • sessions (list) – The list of sessions to include (via session label) otherwise all sessions

  • folders (list) – The list of folders to include (otherwise all folders) e.g. [‘anat’, ‘func’]

  • **kwargs –

    Additional arguments to pass to download_bids_dir

Returns

The absolute path to the downloaded bids directory

Return type

str

download_session_bids(target_dir='work/bids', src_data=False, folders=None, **kwargs)

Download the session in bids format to target_dir.

Parameters

  • target_dir (str) – The destination directory (otherwise work/bids will be used)

  • src_data (bool) – Whether or not to include src data (e.g. dicoms)

  • folders (list) – The list of folders to include (otherwise all folders) e.g. [‘anat’, ‘func’]

  • **kwargs –

    Additional arguments to pass to download_bids_dir

Returns

The absolute path to the downloaded bids directory

Return type

str

get_context_value(name)

Get the context input for name.

Parameters

name (str) – The name of the input

Returns

The input context value, or None if not found.

Return type

dict

get_input(name)

Get the input for name.

Parameters

name (str) – The name of the input

Returns

The input dictionary, or None if not found.

Return type

dict

get_input_path(name)

Get the full path to the given input file.

Raises an exception if the input exists, but is not a file.

Parameters

name (str) – The name of the input

Returns

The path to the input file if it exists, otherwise None

Return type

str

init_logging(level='INFO')

Initializes logging to the given level

log_config()

Print the configuration and input files to the logger

open_input(name, mode='r', **kwargs)

Open the named input file.

Raises an exception if the input does not exist or is not a file.

Parameters

  • name (str) – The name of the input

  • mode (str) – The open mode (default is ‘r’)

  • **kwargs –

    Additional args to pass to open

Returns

The file object

Return type

file

open_output(name, mode='w', **kwargs)

Open the named output file.

Parameters

  • name (str) – The name of the output

  • mode (str) – The open mode (default is ‘w’)

  • **kwargs –

    Additional args to pass to open

Returns

The file object

Return type

file

property output_dir

Get the absolute path to the output directory.

Returns

The absolute path to outputs.

Return type

str

update_container_metadata(container_type, *args, **kwargs)

Update metadata for the given container name in the hierarchy.

A dictionary and/or a set of key=value args can be passed to this function.

The metadata will be written when write_metadata() is called, or if using this as a context manager, when the context is exited.

Parameters

  • container_type (str) – The container type (e.g. session or acquisition)

  • *args –

    The optional update dictionary

  • **kwargs –

    The optional update key-value pairs

update_destination_metadata(*args, **kwargs)

Update metadata for the destination container.

A dictionary and/or a set of key=value args can be passed to this function.

The metadata will be written when write_metadata() is called, or if using this as a context manager, when the context is exited.

Parameters

  • *args –

    The optional update dictionary

  • **kwargs –

    The optional update key-value pairs

update_file_metadata(file_name, *args, **kwargs)

Update metadata for the given file on the destination.

A dictionary and/or a set of key=value args can be passed to this function.

The metadata will be written when write_metadata() is called, or if using this as a context manager, when the context is exited.

Parameters

  • file_name (str) – The name of the file

  • *args –

    The optional update dictionary

  • **kwargs –

    The optional update key-value pairs

property work_dir

Get the absolute path to a work directory

Returns

The absolute path to work.

Return type

str

write_metadata()

Write the metadata json file to the output folder

flywheel.rest module

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git

exception flywheel.rest.ApiException(status=None, reason=None, http_resp=None)

Bases: Exception

class flywheel.rest.RESTClientObject(configuration, pools_size=4, maxsize=None, request_timeout=None, connect_timeout=None)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)
GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

Perform requests.

Parameters

  • method – http request method

  • url – http request url

  • query_params – query parameters in the url

  • headers – http request headers

  • body – request json body, for application/json

  • post_params – request post parameters, application/x-www-form-urlencoded and multipart/form-data

  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

response_hook(resp, *args, **kwargs)
class flywheel.rest.RESTResponse(resp)

Bases: io.IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

flywheel.util module

Provides utility functions

flywheel.util.days_to_seconds(days)

Convert days to seconds

flywheel.util.months_to_seconds(months)

Convert months to seconds

flywheel.util.params_to_dict(method_name, args, kwargs)

Given args and kwargs, return a dictionary object

flywheel.util.params_to_list(args)

Convert a list of arguments (some of which may be lists) to a flat list

flywheel.util.seconds_to_days(seconds)

Convert seconds to days

flywheel.util.seconds_to_months(seconds)

Convert seconds to months

flywheel.util.seconds_to_weeks(seconds)

Convert seconds to weeks

flywheel.util.seconds_to_years(seconds)

Convert seconds to years

flywheel.util.set_verify_ssl(session)

Create a session that verifies against correct certs

flywheel.util.to_ref(obj)

Convert a file or container to a reference

flywheel.util.weeks_to_seconds(weeks)

Convert weeks to seconds

flywheel.util.years_to_seconds(years)

Convert years to seconds

flywheel.view_builder module

class flywheel.view_builder.ViewBuilder(label=None, match=None, zip_files=None, columns=None, process_files=True, include_ids=True, include_labels=True, error_column=None, group_by=None, filter=None, container=None, filename=None, analysis_label=None, analysis_gear_name=None, analysis_gear_version=None, sort=True)

Bases: object

Builder class that assists in constructing a DataView object.

Parameters

  • label (str) – The optional label, if saving this data view.

  • public (bool) – Whether or not to make this data view public when saving it.

  • match (str) – The file match type, one of: first, last, newest, oldest, all

  • zip_files (str) – The zip file filter, see the zip_member_filter function

  • columns (list) – The columns or column groups to add

  • process_files (bool) – Whether or not to process files, default is true

  • include_ids (bool) – Whether or not to include id columns, default is true

  • include_labels (bool) – Whether or not to include label columns, default is true

  • error_column (bool) – Whether or not to include errors column, default is true

  • list, DataViewGroupBy] group_by (Union[str,) – The Columns or column to group by

  • filter (str) – The dataview pagination filter to save on the spec

  • container (str) – When matching files, the container to match on

  • filename (str) – When matching files, the filename pattern to match

  • analysis_label (str) – When matching analysis files, the label match string

  • analysis_gear_name (str) – When matching analysis files, the gear name match string

  • analysis_gear_version (str) – When matching analysis files, the gear version match string

  • sort (bool) – Option to sort results

analysis_filter(label=None, gear_name=None, gear_version=None, regex=False)

Set the filter to use for matching analyses. If this is set, then analyses files will be matched instead of container.

Parameters

  • label (str) – The label match string, wildcards (*, ?) are supported.

  • gear_name (str) – The gear name match string, wildcards (*, ?) are supported.

  • gear_version (str) – The gear version match string, wildcards (*, ?) are supported.

  • regex (bool) – Whether to treat the match string as a regular expression (default is False)

Returns

self

build()

Build the DataView constructed with this builder.

Returns

The constructed DataView

column(src, dst=None, type=None, accumulator=None, expr=None)

Define a column for this data view.

Parameters

  • src (str) – The source field, or column alias name.

  • dst (str) – The optional destination field (defaults to source)

  • type (str) – The optional type for this column, one of: int, float, string bool.

  • accumulator (str) – The optional accumulation operation for group by aggregation.

  • expr (str) – The optional expression to apply

Returns

self

error_column(value=True)

Set whether or not to include error column by default.

Parameters

value (bool) – Whether or not to include errors (default is true)

Returns

self

file_column(src, dst=None, type=None)

Define a column to extract from a file.

Parameters

  • src (str) – The source field.

  • dst (str) – The optional destination field (defaults to source)

  • type (str) – The optional type for this column, one of: int, float, string bool.

Returns

self

file_container(container)

Set the container where files should be matched.

Parameters

container (str) – The container name, one of: project, subject, session, acquisition

Returns

self

file_filter(value=None, regex=False)

Set the filter to use for matching files.

Parameters

  • value (str) – The filename match string, wildcards (*, ?) are supported.

  • regex (bool) – Whether to treat the match string as a regular expression (default is False)

Returns

self

file_format(format_name)

Set the expected format of files to read.

NOTE: This shouldn’t be needed very often. If not specified, autodetect will be used for processing files.

Parameters

format_name (str) – The expected file format, one of: csv, tsv, json.

Returns

self

file_format_options(**kwargs)

Set additional options for the file format. (e.g. arguments to be passed to csv reader function)

Parameters

kwargs (dict) – Arguments to pass to the file reader

Returns

self

file_match(match_value)

Set the resolution strategy if multiple matching files or analyses are encountered.

Parameters

match_value (str) – The file match type, one of: first, last, newest, oldest, all

Returns

self

files(container, filename, analysis_label=None, analysis_gear_name=None, analysis_gear_version=None)

Set filter for matching files

Container is one of project, subject, session, acquisition Filename filters can use the (*, ?) wildcards Analysis filters also support wildcards

Parameters

  • container (str) – When matching files, the container to match on: one of project, subject, session, acquisition

  • filename (str) – When matching files, the filename pattern to match

  • analysis_label (str) – When matching analysis files, the label match string

  • analysis_gear_name (str) – When matching analysis files, the gear name match string

  • analysis_gear_version (str) – When matching analysis files, the gear version match string

Returns

self

filter(filter)

Set the filter for this data view.

Parameters

filter (str) – The dataview pagination filter to save on the spec.

Returns

self

group_by(src, dst=None)

Define a column for this data view.

Parameters

  • src (str) – The source field, or column alias name.

  • dst (str) – The optional destination field (defaults to source)

Returns

self

include_ids(value=True)

Set whether or not to include the id columns by default.

Parameters

value (bool) – Whether or not to include ids (default is true)

Returns

self

include_labels(value=True)

Set whether or not to include the label columns by default.

Parameters

value (bool) – Whether or not to include labels (default is true)

Returns

self

label(label)

Set the label for this data view.

Parameters

label (str) – The new label for the data view.

Returns

self

missing_data_strategy(value)

Set the resolution strategy if rows are missing data for a column. The default is to replace the column value with None.

Parameters

value (str) – The strategy to use for missing data, one of: none, drop-row

Returns

self

process_files(value)

Set whether or not to process files (default is True)

By default, files will be read and return a row for each row in the file. If you just want file attributes or info instead, you can set this to False.

Parameters

value (bool) – Whether or not to process files

Returns

self

public(value=True)

Set whether or not this data view should be made public.

Parameters

value (bool) – True if the data view should be public. (default)

Returns

self

sort(value=True)

Set the option to opt out of sorting the rows by setting false

Parameters

value (bool) – Opt out of sorting

Returns

self

zip_member_filter(value=None, regex=False, match=None)

Set the filter to use for matching members of a zip file.

Parameters

  • value (str) – The filename match string, wildcards (*, ?) are supported.

  • regex (bool) – Whether to treat the match string as a regular expression (default is False)

  • match (str) – The file match type, one of: first, last, newest, oldest, all

Returns

self

Module contents

Flywheel

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 0.0.1

Generated by: https://github.com/swagger-api/swagger-codegen.git