flywheel.api package
AcquisitionsApi Class
AcquisitionsApi API Provider
- class AcquisitionsApi
- addAcquisition()
Create a new acquisition
Create a new acquisition
- Parameters:
body (
flywheel.model.AcquisitionInput
) – (required)- Returns:
[
InsertedId
, resp]
- addAcquisitionAnalysis()
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 (
char
) – (required)body (
flywheel.model.Object
) – (required)job (
logical
) – (optional) returns job_id instead of analysis.idjob – (optional) returns job_id instead of analysis.id
- Returns:
[
InsertedId
, resp]
- addAcquisitionAnalysisNote()
Add a note to a(n) acquisition analysis.
Add a note to a(n) acquisition analysis.
- Parameters:
containerId (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idbody (
flywheel.model.Object
) – (required) note content
- Returns:
[
Note
, resp]
- addAcquisitionNote()
Add a note to a(n) acquisition.
Add a note to a(n) acquisition.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addAcquisitionTag()
Add a tag to a(n) acquisition.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addAcquisitionTags()
Add multiple tags to a(n) acquisition
Add multiple tags to a(n) acquisition
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteAcquisition()
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:
acquisitionId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) Provide a reason for the deletion
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionAnalysis()
Delete an analysis
Delete an analysis for a container.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) Provide a reason for the deletion
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionAnalysisNote()
Remove a note from a(n) acquisition analysis.
Remove a note from a(n) acquisition analysis.
- Parameters:
cid (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idnoteId (
char
) – (required) 24-char hex note id
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionFile()
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 (
char
) – (required)filename (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionNote()
Remove a note from a(n) acquisition
Remove a note from a(n) acquisition
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionTags()
Delete multiple tags from a(n) acquisition
Delete multiple tags from a(n) acquisition
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteAcquisitionsByIds()
Delete multiple acquisitions by ID list
Delete multiple acquisitions by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteAcquisitionsByQuery()
Delete multiple acquisitions by query
Delete multiple acquisitions by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- downloadFileFromAcquisition()
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:
acquisitionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAcquisitionFileZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
acquisitionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getAcquisitionDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
acquisitionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadInputFromAcquisitionAnalysis()
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:
acquisitionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAcquisitionAnalysisInputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
acquisitionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getAcquisitionAnalysisInputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
acquisitionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadOutputFromAcquisitionAnalysis()
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:
acquisitionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAcquisitionAnalysisOutputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
acquisitionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getAcquisitionAnalysisOutputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
acquisitionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAcquisition()
Get a single acquisition
Get a single acquisition
- Parameters:
acquisitionId (
char
) – (required)join (
JoinType
) – (optional)joinAvatars (
logical
) – (optional) add name and avatar to notesxAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
AcquisitionOutput
, resp]
- getAcquisitionAnalyses()
Get analyses for a(n) acquisition.
Returns analyses that directly belong to this resource.
- Parameters:
cid (
char
) – (required)inflateJob (
logical
) – (optional)joinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getAcquisitionAnalysis()
Get an analysis.
Get an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)inflateJob (
logical
) – (optional) Return job as an object instead of an idjoinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)
- Returns:
[none, resp]
- getAcquisitionFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
cid (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getAcquisitionNote()
Get a note of a(n) acquisition.
Get a note of a(n) acquisition
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getAcquisitionTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- getAllAcquisitions()
Get a list of acquisitions
Get a list of acquisitions.
- Parameters:
exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsjoin (
JoinType
) – (optional)joinAvatars (
logical
) – (optional) add name and avatar to notescollectionId (
char
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- modifyAcquisition()
Update an acquisition
Update an acquisition
- Parameters:
acquisitionId (
char
) – (required)body (
flywheel.model.AcquisitionModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAcquisitionAnalysis()
Modify an analysis.
Modify an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)body (
flywheel.model.AnalysisModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAcquisitionFile()
Modify a file’s attributes
Note: If modifying a file’s modality, the current classification will be cleared (except for items in the "Custom" list)
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAcquisitionFileClassification()
Update classification for a particular file.
If replacing a file’s classification, the modality can optionally be modified as well.
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileClassificationDelta
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAcquisitionFileInfo()
Update info for a particular file.
Modify and return the file ‘info’ field
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAcquisitionInfo()
Update or replace info for a(n) acquisition.
Update or replace info for a(n) acquisition. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAcquisitionNote()
Update a note of a(n) acquisition.
Update a note of a(n) acquisition
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- renameAcquisitionTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- uploadFileToAcquisition()
Upload a file to a(n) acquisition.
Upload a file to a(n) acquisition.
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadpreserveMetadata (
logical
) – (optional)ticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)metadata (
char
) – (optional) Metadata object as a JSON-encoded stringxAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadOutputToAcquisitionAnalysis()
Upload an output file to an analysis.
Upload an output file to an analysis
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)file (
vector
) – (required) The file to uploadticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)contentType (
char
) – (optional)
- Returns:
[
vector[FileOutput]
, resp]
AnalysesApi Class
AnalysesApi API Provider
- class AnalysesApi
- addAnalysisNote()
Add a note to a(n) analysis.
Add a note to a(n) analysis.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addAnalysisTag()
Add a tag to a(n) analysis.
Propagates changes to projects, sessions and acquisitions
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- deleteAnalysesByIds()
Delete multiple analyses by ID list
Delete multiple analyses by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteAnalysesByQuery()
Delete multiple analyses by query
Delete multiple analyses by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteAnalysis()
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 audit-trail is enabled)
- Parameters:
analysisId (
char
) – (required) 24-char hex analysis iddeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteAnalysisNote()
Remove a note from a(n) analysis
Remove a note from a(n) analysis
- Parameters:
containerId (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteAnalysisTag()
Delete a tag
Delete a tag
- Parameters:
containerId (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- downloadInputFromAnalysis()
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:
analysisId (
char
) – (required) 24-character hex IDfilename (
char
) – (required) input filenameinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAnalysisInputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
analysisId (
char
) – (required) 24-character hex IDfilename (
char
) – (required) input filenameticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getAnalysisInputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
analysisId (
char
) – (required) 24-character hex IDfilename (
char
) – (required) input filenameticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadOutputFromAnalysis()
Get Output File
Get Output File
- Parameters:
analysisId (
char
) – (required) Container IDfilename (
char
) – (required) output file nameinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAnalysisOutputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
analysisId (
char
) – (required) Container IDfilename (
char
) – (required) output file nameticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getAnalysisOutputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
analysisId (
char
) – (required) Container IDfilename (
char
) – (required) output file nameticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAllAnalyses()
Find all analyses
Returns a page of analyses Args: filter (t.Optional[str]): The filters to apply sort (t.List[Tuple[str,int]): Sorting, as a list of (str, int) tuples limit (t.Optional[int]): The maximum number of entries to return skip (t.Optional[int]): The number of entries to skip page (t.Optional[int]): Page number after_id (t.Optional[str]): Id to return results after Returns: Page: if a above argument is not None
- Parameters:
inflateJob (
logical
) – (optional) Return job as an object instead of an idincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getAnalyses()
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:
containerName (
char
) – (required) The parent container typecontainerId (
char
) – (required) The parent container idsubcontainerName (
char
) – (required) The sub container type
- Returns:
[
vector[AnalysisListOutput]
, resp]
- getAnalysis()
Get an analysis.
Get an analysis by its id
- Parameters:
analysisId (
char
) – (required) 24-char hex analysis idinflateJob (
logical
) – (optional) expand job infojoinAvatars (
logical
) – (optional) add name and avatar to notesjoin (
JoinType
) – (optional)
- Returns:
[none, resp]
- getAnalysisFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
containerId (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getAnalysisNote()
Get a note of a(n) analysis.
Get a note of a(n) analysis
- Parameters:
containerId (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getAnalysisTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
containerId (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- modifyAnalysis()
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:
analysisId (
char
) – (required) 24-char hex analysis idbody (
flywheel.model.Object
) – (required) new analysis fields
- Returns:
[
ModifiedResult
, resp]
- modifyAnalysisInfo()
Update or replace info for a(n) analysis.
Update or replace info for a(n) analysis. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyAnalysisNote()
Update a note of a(n) analysis.
Update a note of a(n) analysis
- Parameters:
containerId (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- renameAnalysisTag()
Rename a tag.
Rename a tag
- Parameters:
containerId (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- uploadOutputToAnalysis()
Upload an output file to an analysis.
Upload an output file to an analysis
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadticket (
char
) – (optional)preserveMetadata (
logical
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)xAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
AuditTrailApi Class
AuditTrailApi API Provider
- class AuditTrailApi
- addAuditTrailReport()
Starts generation of an Audit Trail Report
Start generation of a new Audit Trail Report.
- Parameters:
body (
flywheel.model.CreateReportInput
) – (required)- Returns:
[
AuditTrailReport
, resp]
- deleteAuditTrailReport()
Deletes an Audit Trail Report
Delete an Audit Trail Report
- Parameters:
reportId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- downloadAuditTrailReport()
Download Audit Trail Report
Download Audit Trail Reports
- Parameters:
reportId (
char
) – (required)- Returns:
[none, resp]
- listAuditTrailReports()
List Audit Trail Reports
List Audit Trail Reports.
- Parameters:
filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- modifyAuditTrailReport()
Modify an Audit Trail Report
Modify an Audit Trail Report
- Parameters:
reportId (
char
) – (required)body (
flywheel.model.ModifyReportInput
) – (required)
- Returns:
[
AuditTrailReport
, resp]
AuthApi Class
AuthApi API Provider
BatchApi Class
BatchApi API Provider
- class BatchApi
- cancelBatch()
Cancel a Job
Cancels jobs that are still pending, returns number of jobs cancelled. Moves a ‘running’ batch job to ‘cancelled’.
- Parameters:
batchId (
char
) – (required)- Returns:
[
CancelledBatchOutput
, resp]
- createBatchJobFromJobs()
Create a batch job proposal from preconstructed jobs and insert it as ‘pending’.
Create a batch job proposal from preconstructed jobs and insert it as ‘pending’.
- Parameters:
body (
flywheel.model.PremadeJobsBatchProposalInput
) – (required)- Returns:
[
PremadeJobsBatchProposal
, resp]
- getAllBatches()
Get a list of batch jobs the user has created.
Requires login.
- Returns:
[
vector[Batch]
, resp]
- getBatch()
Get batch job details.
- Parameters:
batchId (
char
) – (required)jobs (
logical
) – (optional) If true, return job objects instead of job ids
- Returns:
[none, resp]
- proposeBatch()
Create a batch job proposal and insert it as ‘pending’.
Create a batch job proposal and insert it as ‘pending’.
- Parameters:
body (
flywheel.model.Object
) – (required) The batch proposal- Returns:
[
ClassicBatchProposalOutput
, resp]
- startBatch()
Launch a job.
Creates jobs from proposed inputs, returns jobs enqueued. Moves ‘pending’ batch job to ‘running’.
- Parameters:
batchId (
char
) – (required)- Returns:
[
vector[JobOutput]
, resp]
BulkApi Class
BulkApi API Provider
ChangeLogApi Class
ChangeLogApi API Provider
- class ChangeLogApi
- getChangeLog()
Get Change Log
- Parameters:
containerType (
flywheel.model.ChangeLogContainerType
) – (required)containerId (
char
) – (required)version (
integer
) – (optional) Optional version if retrieving logs for file
- Returns:
[
ChangeLogDocument
, resp]
- getFieldChangeLog()
Get change logs by specific field, in reverse chronological order
- Parameters:
containerType (
flywheel.model.ChangeLogContainerType
) – (required)containerId (
char
) – (required)field (
char
) – (required)version (
integer
) – (optional) Optional version if retrieving logs for file
- Returns:
[
FieldChangeLogDocument
, resp]
CollectionsApi Class
CollectionsApi API Provider
- class CollectionsApi
- addCollection()
Create a collection
Create a collection
- Parameters:
body (
flywheel.model.CollectionInput
) – (required)- Returns:
[
InsertedId
, resp]
- addCollectionNote()
Add a note to a(n) collection.
Add a note to a(n) collection.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addCollectionPermission()
Add a permission
Add a permission
- Parameters:
collectionId (
char
) – (required)body (
flywheel.model.AccessPermission
) – (required)
- Returns:
[
AccessPermissionOutput
, resp]
- addCollectionTag()
Add a tag to a(n) collection.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addCollectionTags()
Add multiple tags to a(n) collection
Add multiple tags to a(n) collection
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteCollection()
Delete a collection
Delete Collections.
- Parameters:
collectionId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- deleteCollectionFile()
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 (
char
) – (required)filename (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteCollectionNote()
Remove a note from a(n) collection
Remove a note from a(n) collection
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteCollectionTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteCollectionTags()
Delete multiple tags from a(n) collection
Delete multiple tags from a(n) collection
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteCollectionUserPermission()
Delete a permission
Delete a permission
- Parameters:
collectionId (
char
) – (required)userId (
char
) – (required)
- Returns:
[
ModifiedResult
, resp]
- deleteCollectionsByIds()
Delete multiple collections by ID list
Delete multiple collections by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteCollectionsByQuery()
Delete multiple collections by query
Delete multiple collections by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- downloadFileFromCollection()
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:
collectionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getCollectionFileZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
collectionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getCollectionDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
collectionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAllCollections()
List all collections.
List all collections.
- Parameters:
exhaustive (
logical
) – (optional)joinAvatars (
logical
) – (optional) add name and avatar to notesjoinFiles (
logical
) – (optional)join (
JoinType
) – (optional)stats (
logical
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsuserId (
char
) – (optional)filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getAllCollectionsCurators()
List all curators of collections
List all curators of collections
- Parameters:
filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
- Returns:
[
vector[Curator]
, resp]
- getCollection()
Retrieve a single collection
Retrieve a single collection
- Parameters:
collectionId (
char
) – (required)joinAvatars (
logical
) – (optional) add name and avatar to notesjoin (
JoinType
) – (optional)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
CollectionOutput
, resp]
- getCollectionAcquisitions()
List acquisitions in a collection
List acquisitions in a collection
- Parameters:
collectionId (
char
) – (required)session (
char
) – (optional) The id of a session, to which the acquisitions returned will be restrictedfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getCollectionFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
cid (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getCollectionNote()
Get a note of a(n) collection.
Get a note of a(n) collection
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getCollectionSessions()
List sessions in a collection
List sessions in a collection.
- Parameters:
collectionId (
char
) – (required)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getCollectionTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- getCollectionUserPermission()
List a user’s permissions for this group.
List a user’s permissions for this group
- Parameters:
collectionId (
char
) – (required)userId (
char
) – (required)
- Returns:
[
AccessPermissionOutput
, resp]
- modifyCollection()
Update a collection and its contents
Update a collection and its contents
- Parameters:
collectionId (
char
) – (required)body (
flywheel.model.CollectionInputWithContents
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyCollectionFile()
Modify a file’s attributes
Note: If modifying a file’s modality, the current classification will be cleared (except for items in the "Custom" list)
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyCollectionFileClassification()
Update classification for a particular file.
If replacing a file’s classification, the modality can optionally be modified as well.
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileClassificationDelta
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyCollectionFileInfo()
Update info for a particular file.
Modify and return the file ‘info’ field
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyCollectionInfo()
Update or replace info for a(n) collection.
Update or replace info for a(n) collection. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyCollectionNote()
Update a note of a(n) collection.
Update a note of a(n) collection
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- modifyCollectionUserPermission()
Update a user’s permission for this group.
Update a users permission for this group
- Parameters:
collectionId (
char
) – (required)userId (
char
) – (required)body (
flywheel.model.AccessPermissionUpdate
) – (required)
- Returns:
[
AccessPermissionOutput
, resp]
- renameCollectionTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- uploadFileToCollection()
Upload a file to a(n) collection.
Upload a file to a(n) collection.
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadpreserveMetadata (
logical
) – (optional)ticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)metadata (
char
) – (optional) Metadata object as a JSON-encoded stringxAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
ConfigApi Class
ConfigApi API Provider
- class ConfigApi
- getConfig()
Get public configuration
return config dict
- Returns:
[
ConfigOut
, resp]
- getConfigJs()
Return public Scitran configuration information in javascript format.
return config as a JavaScript string assignment
- Returns:
[
Map
, resp]
- getVersion()
Get server and database schema version info
return database version dict
- Returns:
[
Version
, resp]
ContainersApi Class
ContainersApi API Provider
- class ContainersApi
- addContainerAnalysis()
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 (
char
) – (required)body (
flywheel.model.Object
) – (required)job (
logical
) – (optional) returns job_id instead of analysis.idjob – (optional) returns job_id instead of analysis.id
- Returns:
[
InsertedId
, resp]
- addContainerAnalysisNote()
Add a note to a(n) container analysis.
Add a note to a(n) container analysis.
- Parameters:
containerId (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idbody (
flywheel.model.Object
) – (required) note content
- Returns:
[
Note
, resp]
- addContainerNote()
Add a note to a(n) container.
Add a note to a(n) container.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addContainerTag()
Add a tag to a(n) container.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addContainerTags()
Add multiple tags to a(n) container
Add multiple tags to a(n) container
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- addView()
Add a new data view
Create container view
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.ContainerIdViewInput
) – (required)
- Returns:
[
ViewIdOutput
, resp]
- deleteContainer()
Delete a container
Delete Container
- Parameters:
containerId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteContainerAnalysis()
Delete an analysis
Delete an analysis for a container.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) Provide a reason for the deletion
- Returns:
[
DeletedResult
, resp]
- deleteContainerAnalysisNote()
Remove a note from a(n) container analysis.
Remove a note from a(n) container analysis.
- Parameters:
cid (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idnoteId (
char
) – (required) 24-char hex note id
- Returns:
[
DeletedResult
, resp]
- deleteContainerFile()
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 (
char
) – (required)filename (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteContainerNote()
Remove a note from a(n) container
Remove a note from a(n) container
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteContainerTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteContainerTags()
Delete multiple tags from a(n) container
Delete multiple tags from a(n) container
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- downloadFileFromContainer()
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:
containerId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getContainerFileZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
containerId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getContainerDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
containerId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadInputFromContainerAnalysis()
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:
containerId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getContainerAnalysisInputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
containerId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getContainerAnalysisInputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
containerId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadOutputFromContainerAnalysis()
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:
containerId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getContainerAnalysisOutputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
containerId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getContainerAnalysisOutputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
containerId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getContainer()
Retrieve a single container
Find Container by ID
- Parameters:
containerId (
char
) – (required)join (
JoinType
) – (optional)joinAvatars (
logical
) – (optional)
- Returns:
[none, resp]
- getContainerAnalyses()
Get analyses for a(n) container.
Returns analyses that directly belong to this resource.
- Parameters:
cid (
char
) – (required)inflateJob (
logical
) – (optional)joinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getContainerAnalysis()
Get an analysis.
Get an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)inflateJob (
logical
) – (optional) Return job as an object instead of an idjoinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)
- Returns:
[none, resp]
- getContainerFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
cid (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getContainerNote()
Get a note of a(n) container.
Get a note of a(n) container
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getContainerTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- getViews()
Return a list of all views belonging to container
View all containers
- Parameters:
containerId (
char
) – (required) The ID of the container, one of user, group or project. Use "site" as containerId to save or get a site data view.filter (
char
) – (optional)sort (
char
) – (optional)limit (
integer
) – (optional)skip (
integer
) – (optional)page (
integer
) – (optional)afterId (
char
) – (optional)
- Returns:
[
vector[ViewOutput]
, resp]
- modifyContainer()
Update a container and its contents
Modify Container
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.ContainerUpdate
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyContainerAnalysis()
Modify an analysis.
Modify an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)body (
flywheel.model.AnalysisModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyContainerFile()
Modify a file’s attributes
Note: If modifying a file’s modality, the current classification will be cleared (except for items in the "Custom" list)
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyContainerFileClassification()
Update classification for a particular file.
If replacing a file’s classification, the modality can optionally be modified as well.
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileClassificationDelta
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyContainerFileInfo()
Update info for a particular file.
Modify and return the file ‘info’ field
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyContainerInfo()
Update or replace info for a(n) container.
Update or replace info for a(n) container. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyContainerNote()
Update a note of a(n) container.
Update a note of a(n) container
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- renameContainerTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- uploadFileToContainer()
Upload a file to a(n) container.
Upload a file to a(n) container.
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadpreserveMetadata (
logical
) – (optional)ticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)metadata (
char
) – (optional) Metadata object as a JSON-encoded stringxAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadOutputToContainerAnalysis()
Upload an output file to an analysis.
Upload an output file to an analysis
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)file (
vector
) – (required) The file to uploadticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)contentType (
char
) – (optional)
- Returns:
[
vector[FileOutput]
, resp]
DataViewExecutionsApi Class
DataViewExecutionsApi API Provider
- class DataViewExecutionsApi
- deleteViewExecution()
Delete a data_view_execution
- Parameters:
dataViewExecutionId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- getAllDataViewExecutions()
Get a list of data_view_executions
- Parameters:
exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getDataViewExecution()
Get a single data_view_execution
- Parameters:
dataViewExecutionId (
char
) – (required)- Returns:
[
DataViewExecution
, resp]
- getDataViewExecutionData()
Get the data from a data_view_execution
- Parameters:
dataViewExecutionId (
char
) – (required)ticket (
char
) – (optional) download ticket idfileFormat (
Object
) – (optional)fileName (
char
) – (optional) download ticket filename
- Returns:
[none, resp]
- saveDataViewExecution()
Save a data_view_execution to a project
- Parameters:
dataViewExecutionId (
char
) – (required)fileFormat (
Object
) – (optional)
- Returns:
[
File
, resp]
DataexplorerApi Class
DataexplorerApi API Provider
- class DataexplorerApi
- deleteSaveSearch()
Delete a saved search
- Parameters:
searchId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- getAllSavedSearches()
Get Queries
- Parameters:
exhaustive (
logical
) – (optional) Return all queries, Admin onlyfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getSavedSearch()
Return a saved search query
- Parameters:
sid (
char
) – (required)- Returns:
[
SaveSearch
, resp]
- getSearchQuerySuggestions()
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:
body (
flywheel.model.StructuredQuery
) – (required)- Returns:
[
StructuredQuerySuggestions
, resp]
- getSearchStatus()
Get the status of search (Mongo Connector)
- Returns:
[
SearchStatus
, resp]
- parseSearchQuery()
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:
body (
flywheel.model.StructuredQuery
) – (required)- Returns:
[
ParsedQueryResponse
, resp]
- replaceSearch()
Replace a search query
- Parameters:
sid (
char
) – (required)body (
flywheel.model.SaveSearchUpdate
) – (required)
- Returns:
[
SaveSearch
, resp]
- saveSearch()
Save a search query
- Parameters:
body (
flywheel.model.SaveSearchInput
) – (required)- Returns:
[
InsertedId
, resp]
- search()
Perform a search query
- Parameters:
body (
flywheel.model.SearchQuery
) – (required)simple (
logical
) – (optional) Unwrap result documents into a list.size (
integer
) – (optional) The maximum number of results to return.facets (
logical
) – (optional) Include additional statistics about the search results. Internal use only.csv (
logical
) – (optional) Format the response as a CSV file
- Returns:
[none, resp]
DevicesApi Class
DevicesApi API Provider
- class DevicesApi
- createDevice()
Create a new device.
Will create a new device record together with an api key. Request must be an admin request.
- Parameters:
body (
flywheel.model.DeviceCreate
) – (required)- Returns:
[
EgressDevice
, resp]
- deleteDevice()
Delete a device
Delete a device
- Parameters:
deviceId (
char
) – (required)- Returns:
[none, resp]
- deleteDeviceKey()
Delete Device Key
- Parameters:
deviceId (
char
) – (required)keyId (
char
) – (required)
- Returns:
[none, resp]
- generateKey()
Generate device API key
Regenerate device API key
- Parameters:
deviceId (
char
) – (required)body (
ApiKeyInputWithOptionalLabel
) – (optional)
- Returns:
[
Map
, resp]
- getAllDevices()
List all devices.
Requires login.
- Parameters:
joinKeys (
logical
) – (optional) Return device key. Admins onlyfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getAllDevicesStatus()
Get status for all known devices.
ok - missing - error - unknown
- Returns:
[
Map[String, DeviceStatusEntry]
, resp]
- getCurrentDevice()
Get current device.
Get current device.
- Returns:
[
EgressDevice
, resp]
- getDevice()
Get device details
- Parameters:
deviceId (
char
) – (required)- Returns:
[
EgressDevice
, resp]
- modifyDevice()
Update a device
Update a device
- Parameters:
deviceId (
char
) – (required)body (
flywheel.model.DeviceAdminUpdate
) – (required)
- Returns:
[
EgressDevice
, resp]
- regenerateKey()
This method is DEPRECATED, use generate_key instead
- Parameters:
deviceId (
char
) – (required)body (
ApiKeyInputWithOptionalLabel
) – (optional)
- Returns:
[
Map
, resp]
- updateDevice()
Modify a device’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 (
flywheel.model.DeviceSelfUpdate
) – (required)- Returns:
[
EgressDevice
, resp]
DimseApi Class
DimseApi API Provider
- class DimseApi
- createProjectAet()
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 (
flywheel.model.ProjectAETInput
) – (required)- Returns:
[
BaseAET
, resp]
- createServiceAet()
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 (
flywheel.model.Object
) – (required)- Returns:
[
ServiceAET
, resp]
- deleteProjectAet()
Delete a DIMSE project AET
Delete DIMSE project by AET. AETs can only be deleted by admins.
- Parameters:
projectAet (
char
) – (required)- Returns:
[
Map[String, integer]
, resp]
- deleteServiceAet()
Delete a DIMSE service AET
Delete DIMSE service by AET. AETs can only be deleted by admins.
- Parameters:
serviceAet (
char
) – (required)- Returns:
[
Map[String, integer]
, resp]
- getAllProjectAets()
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.
- Returns:
[
vector[ProjectAET]
, resp]
- getAllServiceAets()
List all DIMSE services AETs
Will list all DIMSE AETs referring to external DICOM nodes. Requires login and admin privilege.
- Returns:
[
vector[ServiceAET]
, resp]
- getProjectAet()
Get DIMSE project AET
Get DIMSE project by AET, id or project id. Requires admin privilege.
- Parameters:
projectAet (
char
) – (required)- Returns:
[
ProjectAET
, resp]
- getServiceAet()
Get DIMSE service by AET or id
Get a DIMSE service. Requires login and admin privilege.
- Parameters:
serviceAet (
char
) – (required)- Returns:
[
ServiceAET
, resp]
DownloadApi Class
DownloadApi API Provider
- class DownloadApi
- createDownloadTicket()
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 (
flywheel.model.Object
) – (required) Specification for the download to be performedtype (
Object
) – (optional) The download type, one of: bulk, classic or full. Default is classic.bulk (
logical
) – (optional)metadata (
logical
) – (optional) For "full" download, whether or not to include metadata sidecars. Default is false.analyses (
logical
) – (optional) For "full" download, whether or not to include analyses. Default is false.prefix (
char
) – (optional) A string to customize the name of the download in the format <prefix>_<timestamp>.tar. Defaults to "scitran".
- Returns:
[
DownloadTicketStub
, resp]
- downloadTicket()
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 (
char
) – (required) ID of the download ticketformat (
Object
) – (optional)
- Returns:
[none, resp]
FilesApi Class
FilesApi API Provider
- class FilesApi
- addFileTags()
Add list of tags on a file.
Add the tags on a file to the list of tags
- Parameters:
fileId (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[
vector[char]
, resp]
- deleteFile()
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:
fileId (
char
) – (required)version (
integer
) – (optional) Version of the file to delete (defaults to current version)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteFileTags()
Remove the specified tags from most recent file version
Remove the specified tags from most recent file version
- Parameters:
fileId (
char
) – (required)body (
vector[char]
) – (optional) List of application-specific tags
- Returns:
[none, resp]
- deleteFilesByIds()
Delete multiple files by ID list
Delete multiple files by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteFilesByQuery()
Delete multiple files by query
Delete multiple files by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- getAllFiles()
Return all files
Get metadata of all current user files
- Parameters:
filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
- Returns:
[
PageGenericFileOutput
, resp]
- getFile()
Get File
Get file details
- Parameters:
fileId (
char
) – (required)version (
integer
) – (optional)
- Returns:
[
FileOutput
, resp]
- getFileTags()
Return a file tags, from any version
Return a file tags, from any version
- Parameters:
fileId (
char
) – (required)version (
integer
) – (optional)
- Returns:
[
vector[char]
, resp]
- getFileVersions()
Get Versions
Get file version details
- Parameters:
fileId (
char
) – (required)- Returns:
[
vector[FileVersionOutput]
, resp]
- getFileZipInfo()
Get Zip Info
Get info on zipfile
- Parameters:
fileId (
char
) – (required)version (
integer
) – (optional)ticket (
char
) – (optional)
- Returns:
[
ZipfileInfo
, resp]
- moveFile()
Move and/or rename a file
Move a file to a new container and/or give it a new name
- Parameters:
fileId (
char
) – (required)body (
flywheel.model.FileMoveInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- restoreFile()
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:
fileId (
char
) – (required)version (
integer
) – (required)evaluateGearRules (
logical
) – (required) Specify if gear rules should be reevaluated on the newly created file version
- Returns:
[
FileOutput
, resp]
- setFileTags()
Set list of tags on a file.
Set the tags on a file to the list of tags provided
- Parameters:
fileId (
char
) – (required)body (
flywheel.model.vector[char]
) – (required) List of application-specific tags
- Returns:
[
ModifiedResult
, resp]
- upsertFile()
Upsert a File
Create or update a file
- Parameters:
body (
flywheel.model.FileUpsertInput
) – (required)forceUpdate (
logical
) – (optional)
- Returns:
[
FileUpsertOutput
, resp]
GearsApi Class
GearsApi API Provider
- class GearsApi
- addGear()
Create or update a gear.
If no existing gear is found, one will be created Otherwise, the specified gear will be updated
- Parameters:
gearName (
char
) – (required) Name of the gear to interact withbody (
flywheel.model.GearDocumentLegacyInput
) – (required)
- Returns:
[
GearIdOutput
, resp]
- addGearPermission()
Add an individual permission to the given gear
- Parameters:
gearName (
char
) – (required) Name of the gear to interact withpermissionType (
flywheel.model.GearPermissionsType
) – (required)body (
flywheel.model.GearPermissionsInput
) – (required)
- Returns:
[
GearSeries
, resp]
- deleteGear()
Delete a gear (not recommended)
- Parameters:
gearId (
char
) – (required) Id of the gear to interact with- Returns:
[none, resp]
- deleteGearPermission()
Delete an individual permission of the given gear
- Parameters:
gearName (
char
) – (required)permissionType (
flywheel.model.GearPermissionsType
) – (required)permissionId (
char
) – (required)
- Returns:
[none, resp]
- deleteGearPermissions()
Delete permissions of the given gear
- Parameters:
gearName (
char
) – (required)- Returns:
[none, resp]
- getAllGears()
List all gears
List all gears
- Parameters:
projectId (
char
) – (optional)allVersions (
logical
) – (optional) return all versions of each gearincludeInvalid (
logical
) – (optional) return gears with the ‘invalid’ flag setfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsxAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getGear()
Retrieve details about a specific gear
Retrieve details about a specific gear
- Parameters:
gearId (
char
) – (required)- Returns:
[
GearDocument
, resp]
- getGearContext()
Get context values for the given gear and container.
Ref: https://github.com/flywheel-io/gears/tree/master/spec#contextual-values
- Parameters:
gearId (
char
) – (required)containerName (
char
) – (required)containerId (
char
) – (required)
- Returns:
[
Map[String, Object]
, resp]
- getGearInvocation()
Get a schema for invoking a gear
Get a schema for invoking a gear.
- Parameters:
gearId (
char
) – (required)- Returns:
[
Map
, resp]
- getGearSeries()
Get gear series.
Gets the series for the gear by its name
- Parameters:
gearName (
char
) – (required)- Returns:
[
GearSeries
, resp]
- getGearSuggest()
Get files with input suggestions, parent containers, and child containers for the given container.
- Parameters:
gearId (
char
) – (required) Id of the gear to interact withcontainerName (
char
) – (required) Type of the container to interact withcontainerId (
char
) – (required) Id of the container to interact withfilter (
char
) – (optional)sort (
char
) – (optional)limit (
integer
) – (optional)skip (
integer
) – (optional)page (
integer
) – (optional)include (
vector[char]
) – (optional) Include only "children" or "files"collection (
char
) – (optional) Get suggestions for a collection
- Returns:
[
GearSuggestionOutput
, resp]
- getGearTicket()
Retrieve a specific gear ticket
- Parameters:
ticketId (
char
) – (required)- Returns:
[
GearTicket
, resp]
- getMyGearTickets()
Retrieve all gear tickets for the current user
- Returns:
[
vector[char]
, resp]
- modifyGearSeries()
Update a gear series
- Parameters:
gearName (
char
) – (required) Name of the gear series to modifybody (
flywheel.model.GearSeriesUpdate
) – (required)
- Returns:
[
GearSeries
, resp]
- prepareAddGear()
Prepare a gear upload
Prepare a gear upload
- Parameters:
body (
flywheel.model.GearDocumentInput
) – (required)- Returns:
[
GearTicketOutput
, resp]
- replaceGearPermissions()
Replace permissions for the given gear
- Parameters:
gearName (
char
) – (required) Name of the gear to interact withbody (
flywheel.model.GearPermissions
) – (required)
- Returns:
[
GearSeries
, resp]
- saveGear()
Report the result of a gear upload and save the ticket
Report the result of a gear upload and save the ticket
- Parameters:
body (
flywheel.model.Object
) – (required) The ticket, repo and pointer- Returns:
[
GearDocument
, resp]
GroupsApi Class
GroupsApi API Provider
- class GroupsApi
- addGroup()
Add a group
Create a new group.
- Parameters:
body (
flywheel.model.GroupInput
) – (required)- Returns:
[
InsertedId
, resp]
- addGroupPermission()
Add a permission
Adds permission to the group Args: group_id: the id of the group permission: The access permission auth_session: The auth session of the user Returns AccessPermissionOutput: The added permission
- Parameters:
groupId (
char
) – (required)body (
flywheel.model.AccessPermission
) – (required)
- Returns:
[
AccessPermissionOutput
, resp]
- addGroupPermissionTemplate()
Add a permission template
Add a permission template
- Parameters:
groupId (
char
) – (required)body (
flywheel.model.RolePermission
) – (required)propagate (
logical
) – (optional)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
RolePermissionOutput
, resp]
- addGroupTag()
Add a tag to a(n) group.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addGroupTags()
Add multiple tags to a(n) group
Add multiple tags to a(n) group
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- addRoleToGroup()
Add a role to the pool of roles in a group
Add a group role.
- Parameters:
groupId (
char
) – (required)body (
flywheel.model.GroupRole
) – (required)
- Returns:
[
RoleOutput
, resp]
- deleteGroup()
Delete group
Delete a group.
- Parameters:
groupId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- deleteGroupTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteGroupTags()
Delete multiple tags from a(n) group
Delete multiple tags from a(n) group
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteGroupUserPermission()
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:
groupId (
char
) – (required)userId (
char
) – (required)
- Returns:
[
ModifiedResult
, resp]
- deleteGroupUserPermissionTemplate()
Delete a permission
Delete a permission
- Parameters:
groupId (
char
) – (required)userId (
char
) – (required)propagate (
logical
) – (optional)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
ModifiedResult
, resp]
- deleteGroupsByIds()
Delete multiple groups by ID list
Delete multiple groups by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteGroupsByQuery()
Delete multiple groups by query
Delete multiple groups by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- getAllGroupRoles()
Get list of group roles
Gets all group roles
- Parameters:
groupId (
char
) – (required)- Returns:
[
vector[RoleOutput]
, resp]
- getAllGroups()
List all groups
Find all groups.
- Parameters:
exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getGroup()
Get group info
Get a group by ID.
- Parameters:
groupId (
char
) – (required)- Returns:
[
GroupOutput
, resp]
- getGroupProjects()
Get all projects in a group
Get projects for a group
- Parameters:
groupId (
char
) – (required)exhaustive (
logical
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getGroupRole()
Return the role identified by the RoleId
Get a group role.
- Parameters:
groupId (
char
) – (required)roleId (
char
) – (required)
- Returns:
[
RoleOutput
, resp]
- getGroupTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- getGroupUserPermission()
List a user’s permissions for this group.
List a user’s permissions for this group
- Parameters:
groupId (
char
) – (required)userId (
char
) – (required)
- Returns:
[
AccessPermissionOutput
, resp]
- getGroupUserPermissionTemplate()
List a user’s permissions for this group.
List a user’s permissions for this group.
- Parameters:
groupId (
char
) – (required)userId (
char
) – (required)
- Returns:
[
RolePermissionOutput
, resp]
- modifyGroup()
Update group
Modify a group.
- Parameters:
groupId (
char
) – (required)body (
flywheel.model.GroupUpdate
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyGroupUserPermission()
Update a user’s permission for this group.
Update a user’s permission for this group.
- Parameters:
groupId (
char
) – (required)userId (
char
) – (required)body (
flywheel.model.AccessPermissionUpdate
) – (required)
- Returns:
[
AccessPermissionOutput
, resp]
- modifyGroupUserPermissionTemplate()
Update a user’s permission for this group.
Update a user’s permission for this group.
- Parameters:
groupId (
char
) – (required)userId (
char
) – (required)body (
flywheel.model.RolePermissionUpdate
) – (required)propagate (
logical
) – (optional)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
RolePermissionOutput
, resp]
- removeRoleFromGroup()
Remove the role from the group
Delete a group role.
- Parameters:
groupId (
char
) – (required)roleId (
char
) – (required)
- Returns:
[none, resp]
- renameGroupTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
JobsApi Class
JobsApi API Provider
- class JobsApi
- addJob()
Add a job
Add a job
- Parameters:
body (
flywheel.model.InputJob
) – (required)- Returns:
[
InsertedId
, resp]
- addJobLogs()
Add logs to a job.
- Parameters:
jobId (
char
) – (required)body (
flywheel.model.vector[JobLog]
) – (required)
- Returns:
[none, resp]
- askJobs()
Ask the queue a question
Ask the queue a question, receiving work or statistics in return.
- Parameters:
body (
flywheel.model.JobAsk
) – (required)- Returns:
[
JobAskResponse
, resp]
- askJobsState()
Ask job count by state
Ask the queue for the number of jobs for a given state and query.
- Parameters:
jobState (
flywheel.model.JobState
) – (required)body (
flywheel.model.JobAsk
) – (required)
- Returns:
[
JobAskStateResponse
, resp]
- completeJob()
Complete a job, with information
- Parameters:
jobId (
char
) – (required)body (
flywheel.model.JobComplete
) – (required)jobTicketId (
char
) – (optional) ticket id for job completion
- Returns:
[none, resp]
- determineProviderForJob()
Determine the effective compute provider for a proposed job.
- Parameters:
body (
flywheel.model.InputJob
) – (required)- Returns:
[
Provider
, resp]
- engineCompleteJob()
Complete a job, with information.
- Parameters:
jobId (
char
) – (required)body (
flywheel.model.JobComplete
) – (required)jobTicketId (
char
) – (optional) ticket id for job completion
- Returns:
[none, resp]
- enginePrepareCompleteJob()
Create a ticket for completing a job, with id and status.
- Parameters:
jobId (
char
) – (required)- Returns:
[
JobTicketOutput
, resp]
- getAllJobs()
Return all jobs
- Parameters:
includeParentInfo (
logical
) – (optional) Include the parent info for the jobsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getJob()
Get job details
- Parameters:
jobId (
char
) – (required)- Returns:
[
JobOutput
, resp]
- getJobConfig()
Get a job’s config
- Parameters:
jobId (
char
) – (required)- Returns:
[
JobOutputConfig
, resp]
- getJobDetail()
Get job container details
- Parameters:
jobId (
char
) – (required)- Returns:
[
JobDetail
, resp]
- getJobLogs()
Get job logs
- Parameters:
jobId (
char
) – (required)- Returns:
[
JobLogRecord
, resp]
- getJobsStats()
Get stats about all current jobs
- Returns:
[
Map
, resp]
- getNextJob()
Get the next job in the queue
Used by the engine.
- Parameters:
tags (
vector[char]
) – (optional)tags – (optional)
- Returns:
[
Job
, resp]
- modifyJob()
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:
jobId (
char
) – (required)body (
flywheel.model.JobModify
) – (required)
- Returns:
[
ModifiedResult
, resp]
- prepareCompleteJob()
Create a ticket for completing a job, with id and status.
- Parameters:
jobId (
char
) – (required)- Returns:
[
JobTicketOutput
, resp]
- reapJobs()
Reap stale jobs
- Returns:
[
OrphanedCount
, resp]
- retryJob()
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:
jobId (
char
) – (required)computeProviderId (
char
) – (optional)ignoreState (
logical
) – (optional)
- Returns:
[
InsertedId
, resp]
- updateJobProfile()
Update profile information on a job. (e.g. machine type, etc)
Update profile information on a job. (e.g. machine type, etc)
- Parameters:
jobId (
char
) – (required)body (
flywheel.model.InputJobProfile
) – (required)
- Returns:
[
ModifiedResult
, resp]
- updateJobsPriority()
Update a job priority.
- Parameters:
body (
flywheel.model.JobPriorityUpdate
) – (required)- Returns:
[
ModifiedResult
, resp]
JupyterlabServersApi Class
JupyterlabServersApi API Provider
- class JupyterlabServersApi
- getJupyterlabServer()
Get jupyterlab server
Get jupyterlab server
- Parameters:
jupyterlabServerId (
char
) – (required)- Returns:
[
JupyterlabServerResponse
, resp]
- modifyJupyterlabServer()
Update a jupyterlab server
Update a jupyterlab server
- Parameters:
jupyterlabServerId (
char
) – (required)body (
flywheel.model.JupyterlabServerModify
) – (required)
- Returns:
[
ModifiedResult
, resp]
ModalitiesApi Class
ModalitiesApi API Provider
- class ModalitiesApi
- addModality()
Create a new modality.
handlers.modalityhandler.ModalityHandler.post
- Parameters:
body (
flywheel.model.ModalityInput
) – (required)- Returns:
[
InsertedId
, resp]
- deleteModality()
Delete a modality
- Parameters:
modalityId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- getAllModalities()
List all modalities.
Requires login.
- Parameters:
filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getModality()
Get a modality’s classification specification
- Parameters:
modalityId (
char
) – (required)- Returns:
[
ModalityOutput
, resp]
- replaceModality()
Replace modality
- Parameters:
modalityId (
char
) – (required)body (
flywheel.model.ModalityModify
) – (required)
- Returns:
[
ModalityOutput
, resp]
PackfilesApi Class
PackfilesApi API Provider
ProjectsApi Class
ProjectsApi API Provider
- class ProjectsApi
- addProject()
Create a new project
- Parameters:
body (
flywheel.model.ProjectInput
) – (required)inherit (
logical
) – (optional) Inherit permissions from the group permission template
- Returns:
[
InsertedId
, resp]
- addProjectAnalysis()
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 (
char
) – (required)body (
flywheel.model.Object
) – (required)job (
logical
) – (optional) returns job_id instead of analysis.idjob – (optional) returns job_id instead of analysis.id
- Returns:
[
InsertedId
, resp]
- addProjectAnalysisNote()
Add a note to a(n) project analysis.
Add a note to a(n) project analysis.
- Parameters:
containerId (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idbody (
flywheel.model.Object
) – (required) note content
- Returns:
[
Note
, resp]
- addProjectNote()
Add a note to a(n) project.
Add a note to a(n) project.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addProjectPermission()
Add a permission
Add user to a project Args: project_id: The id of the project permission: The permission to add auth_session: The auth session Returns: RolePermissionOutput: The added permission
- Parameters:
projectId (
char
) – (required)body (
flywheel.model.RolePermission
) – (required)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
RolePermissionOutput
, resp]
- addProjectRule()
Create a new rule for a project.
- Parameters:
projectId (
char
) – (required)body (
flywheel.model.GearRuleInput
) – (required)
- Returns:
[
GearRuleOutput
, resp]
- addProjectTag()
Add a tag to a(n) project.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addProjectTags()
Add multiple tags to a(n) project
Add multiple tags to a(n) project
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- catalogList()
Catalog List
- Parameters:
searchString (
char
) – (optional) Include only results containing the search stringfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- deleteProject()
Delete a project
Only site admins and users with "admin" project permissions may delete a project
- Parameters:
projectId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabled
- Returns:
[
DeletedResult
, resp]
- deleteProjectAnalysis()
Delete an analysis
Delete an analysis for a container.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) Provide a reason for the deletion
- Returns:
[
DeletedResult
, resp]
- deleteProjectAnalysisNote()
Remove a note from a(n) project analysis.
Remove a note from a(n) project analysis.
- Parameters:
cid (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idnoteId (
char
) – (required) 24-char hex note id
- Returns:
[
DeletedResult
, resp]
- deleteProjectFile()
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 (
char
) – (required)filename (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteProjectNote()
Remove a note from a(n) project
Remove a note from a(n) project
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteProjectTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteProjectTags()
Delete multiple tags from a(n) project
Delete multiple tags from a(n) project
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteProjectUserPermission()
Delete a permission
- Parameters:
projectId (
char
) – (required)uid (
char
) – (required)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
ModifiedResult
, resp]
- deleteProjectsByIds()
Delete multiple projects by ID list
Delete multiple projects by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteProjectsByQuery()
Delete multiple projects by query
Delete multiple projects by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- downloadFileFromProject()
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:
projectId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getProjectFileZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
projectId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getProjectDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
projectId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadInputFromProjectAnalysis()
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:
projectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getProjectAnalysisInputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
projectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getProjectAnalysisInputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
projectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadOutputFromProjectAnalysis()
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:
projectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getProjectAnalysisOutputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
projectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getProjectAnalysisOutputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
projectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- endProjectPackfileUpload()
End a packfile upload
- Parameters:
token (
char
) – (required)metadata (
char
) – (required) Metadata object as a JSON-encoded stringfileCount (
integer
) – (required) Number of files uploaded into this packfile.projectId (
char
) – (required)
- Returns:
[none, resp]
- getAllProjects()
Get a list of projects
- Parameters:
counts (
logical
) – (optional) Append the count of subjects in each projectstats (
logical
) – (optional) Return the status of subjects and sessions in each projectjoinAvatars (
logical
) – (optional) Return the joined avatars of the permissionsjoin (
JoinType
) – (optional)exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getAllProjectsGroups()
List all groups which have a project in them
- Parameters:
exhaustive (
logical
) – (optional) returns exhaustive list if correct permissionsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[
vector[GroupOutput]
, resp]
- getCatalogListFilterOptions()
Get all filter options for sharing a project
- Returns:
[
SharingFilterOptions
, resp]
- getProject()
Get a single project
- Parameters:
projectId (
char
) – (required)join (
JoinType
) – (optional)joinAvatars (
logical
) – (optional) add name and avatar to notesxAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
ProjectOutput
, resp]
- getProjectAcquisitions()
List all acquisitions for the given project.
- Parameters:
projectId (
char
) – (required)collectionId (
char
) – (optional)exhaustive (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getProjectAnalyses()
Get analyses for a(n) project.
Returns analyses that directly belong to this resource.
- Parameters:
cid (
char
) – (required)inflateJob (
logical
) – (optional)joinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getProjectAnalysis()
Get an analysis.
Get an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)inflateJob (
logical
) – (optional) Return job as an object instead of an idjoinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)
- Returns:
[none, resp]
- getProjectFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
cid (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getProjectNote()
Get a note of a(n) project.
Get a note of a(n) project
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getProjectRule()
Get a project rule.
Get a project rule.
- Parameters:
projectId (
char
) – (required)ruleId (
char
) – (required)
- Returns:
[
GearRuleOutput
, resp]
- getProjectRules()
List all rules for a project.
- Parameters:
projectId (
char
) – (required)- Returns:
[
vector[GearRuleOutput]
, resp]
- getProjectSessions()
List all sessions for the given project.
Returns a page of sessions by their parent
- Parameters:
projectId (
char
) – (required) 24-char hex subject idjoin (
JoinType
) – (optional) join file originsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getProjectSettings()
Get a(n) project settings
Route for getting settings from a a(n) project
- Parameters:
projectId (
char
) – (required)- Returns:
[
ProjectSettingsOutput
, resp]
- getProjectSubjects()
List all subjects for the given project.
List all subjects for the given project.
- Parameters:
projectId (
char
) – (required)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getProjectTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- getProjectUserPermission()
List a user’s permissions for this project.
Get a user’s permission from a project Args: project_id: The id of the project uid: The id of the user auth_session: The auth session Returns: RolePermissionOutput: The permission
- Parameters:
projectId (
char
) – (required)uid (
char
) – (required)
- Returns:
[
RolePermissionOutput
, resp]
- modifyProject()
Update a project
- Parameters:
projectId (
char
) – (required)body (
flywheel.model.ProjectModify
) – (required)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
ModifiedResult
, resp]
- modifyProjectAnalysis()
Modify an analysis.
Modify an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)body (
flywheel.model.AnalysisModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyProjectFile()
Modify a file’s attributes
Note: If modifying a file’s modality, the current classification will be cleared (except for items in the "Custom" list)
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyProjectFileClassification()
Update classification for a particular file.
If replacing a file’s classification, the modality can optionally be modified as well.
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileClassificationDelta
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyProjectFileInfo()
Update info for a particular file.
Modify and return the file ‘info’ field
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyProjectInfo()
Update or replace info for a(n) project.
Update or replace info for a(n) project. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifyProjectNote()
Update a note of a(n) project.
Update a note of a(n) project
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- modifyProjectRule()
Update a rule on a project.
Update a rule on a project.
- Parameters:
projectId (
char
) – (required)ruleId (
char
) – (required)body (
flywheel.model.GearRuleModifyInput
) – (required)
- Returns:
[
GearRuleOutput
, resp]
- modifyProjectSettings()
Modify a(n) project settings
Route for modifying settings for a a(n) project
- Parameters:
projectId (
char
) – (required)body (
flywheel.model.ProjectSettingsInput
) – (required)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
ProjectSettingsOutput
, resp]
- modifyProjectUserPermission()
Update a user’s permission for this project.
Update a user’s permission for this project.
- Parameters:
projectId (
char
) – (required)uid (
char
) – (required)body (
flywheel.model.RolePermissionUpdate
) – (required)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
RolePermissionOutput
, resp]
- projectCopy()
Copy By Reference
Copy a project and its descendants to a new project tree
- Parameters:
projectId (
char
) – (required)body (
flywheel.model.ProjectCopyInput
) – (required)
- Returns:
[
ProjectCopyOutput
, resp]
- projectPackfileUpload()
Add files to an in-progress packfile
- Parameters:
projectId (
char
) – (required)token (
char
) – (required)file (
vector
) – (required)
- Returns:
[
vector[FileOutput]
, resp]
- recalcAllProjects()
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.
- Returns:
[
SessionTemplateRecalcOutput
, resp]
- recalcProject()
Currently does nothing–will eventually calculate if sessions in the project satisfy the template.
Currently does nothing–will eventually calculate if sessions in the project satisfy the template.
- Parameters:
projectId (
char
) – (required)- Returns:
[
SessionTemplateRecalcOutput
, resp]
- removeProjectRule()
Remove a project rule.
- Parameters:
projectId (
char
) – (required)ruleId (
char
) – (required)
- Returns:
[none, resp]
- removeProjectTemplate()
Remove the session template for a project.
- Parameters:
projectId (
char
) – (required)- Returns:
[
DeletedResult
, resp]
- renameProjectTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- setProjectTemplate()
Set the session template for a project.
- Parameters:
projectId (
char
) – (required)body (
flywheel.model.ProjectTemplateListInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- startProjectPackfileUpload()
Start a packfile upload to project
- Parameters:
projectId (
char
) – (required)- Returns:
[
UploadTokenOutput
, resp]
- uploadFileToProject()
Upload a file to a(n) project.
Upload a file to a(n) project.
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadpreserveMetadata (
logical
) – (optional)ticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)metadata (
char
) – (optional) Metadata object as a JSON-encoded stringxAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadOutputToProjectAnalysis()
Upload an output file to an analysis.
Upload an output file to an analysis
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)file (
vector
) – (required) The file to uploadticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)contentType (
char
) – (optional)
- Returns:
[
vector[FileOutput]
, resp]
- upsertProjectHierarchy()
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:
projectId (
char
) – (required)body (
flywheel.model.ProjectHierarchyInput
) – (required)uidScope (
char
) – (optional)
- Returns:
[
ProjectHierarchyOutput
, resp]
ReportsApi Class
ReportsApi API Provider
- class ReportsApi
- collectUsage()
Collect daily usage statistics.
Collects usage statistics for the selected day (or yesterday if no day is given)
- Parameters:
year (
integer
) – (optional) The year portion of the datemonth (
integer
) – (optional) The month portion of the dateday (
integer
) – (optional) The day portion of the date
- Returns:
[none, resp]
- getAccessLogReport()
Get a report of access log entries for the given parameters
- Parameters:
csv (
logical
) – (optional) Set to download a csv file instead of jsonfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order.(e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to returnskip (
integer
) – (optional) The number of entries to skippage (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)startDate (
datetime
) – (optional) An ISO formatted timestamp for the start time of the reportendDate (
datetime
) – (optional) An ISO formatted timestamp for the end time of the reportuser (
char
) – (optional) User id of the target usersubject (
char
) – (optional) Limit the report to the subject code of subject accessedproject (
char
) – (optional) Limit the report to the project idaccessTypes (
vector[AccessType]
) – (optional) The list of access_types to filter logsxAcceptFeature (
vector[char]
) – (optional)
- Returns:
[
vector[ReportAccessLogEntry]
, resp]
- getAccessLogTypes()
Get the list of types of access log entries
- Returns:
[
vector[char]
, resp]
- getDailyUsageReport()
Get a daily usage report for the given month.
If no year/month pair is given, the current month will be used.
- Parameters:
year (
integer
) – (optional) The year portion of the datemonth (
integer
) – (optional) The month portion of the dategroup (
char
) – (optional) Limit the report to the given group idproject (
char
) – (optional) Limit the report to the given project id
- Returns:
[
vector[DailyReportUsage]
, resp]
- getLegacyUsageReport()
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 (
char
) – (required) The type of usage report to generatestartDate (
datetime
) – (optional) An ISO formatted timestamp for the start time of the reportendDate (
datetime
) – (optional) An ISO formatted timestamp for the end time of the report
- Returns:
[
vector[LegacyUsageReport]
, resp]
- getProjectReport()
Get project report
Get project report
- Parameters:
projects (
vector[char]
) – (optional) Specify multiple times to include projects in the reportstartDate (
datetime
) – (optional) Report start dateendDate (
datetime
) – (optional) Report end date
- Returns:
[
ProjectReportList
, resp]
- getSiteReport()
Get the site report
- Returns:
[
SiteReport
, resp]
- getUsageAvailability()
Get year/month combinations where report data is available.
Get year/month combinations where report data is available. Returns: Returns the list of months where report data is available
- Returns:
[
ReportAvailabilityList
, resp]
- getUsageReport()
Get a usage report for the given month.
If no year/month pair is given, the current month will be used.
- Parameters:
year (
integer
) – (optional) The year portion of the datemonth (
integer
) – (optional) The month portion of the dateproject (
char
) – (optional) Project to filter to
- Returns:
[
vector[ReportUsage]
, resp]
ResolveApi Class
ResolveApi API Provider
- class ResolveApi
- lookupPath()
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 (
flywheel.model.ResolveInput
) – (required)fullTree (
logical
) – (optional)exhaustive (
logical
) – (optional)
- Returns:
[
ResolverNode
, resp]
- resolvePath()
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 (
flywheel.model.ResolveInput
) – (required)fullTree (
logical
) – (optional) Parse full download style paths (e.g. group/PROJECTS/project_label/SUBJECTS/…)minattr (
logical
) – (optional) Return only minimal attributesexhaustive (
logical
) – (optional) Set to return a complete list regardless of permissions
- Returns:
[
ResolveOutput
, resp]
RolesApi Class
RolesApi API Provider
- class RolesApi
- addRole()
Add a new role
- Parameters:
body (
flywheel.model.RoleInput
) – (required)- Returns:
[
RoleOutput
, resp]
- deleteRole()
Delete the role
- Parameters:
roleId (
char
) – (required) The ID of the role- Returns:
[none, resp]
- getAllRoles()
Get list of all roles
- Parameters:
filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getRole()
Return the role identified by the RoleId
- Parameters:
roleId (
char
) – (required) The ID of the role- Returns:
[
RoleOutput
, resp]
- modifyRole()
Update the role identified by RoleId
- Parameters:
roleId (
char
) – (required)body (
flywheel.model.RoleUpdate
) – (required)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
RoleOutput
, resp]
SessionsApi Class
SessionsApi API Provider
- class SessionsApi
- addSession()
Create a new session
Create a session.
- Parameters:
body (
flywheel.model.SessionInput
) – (required)- Returns:
[
InsertedId
, resp]
- addSessionAnalysis()
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 (
char
) – (required)body (
flywheel.model.Object
) – (required)job (
logical
) – (optional) returns job_id instead of analysis.idjob – (optional) returns job_id instead of analysis.id
- Returns:
[
InsertedId
, resp]
- addSessionAnalysisNote()
Add a note to a(n) session analysis.
Add a note to a(n) session analysis.
- Parameters:
containerId (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idbody (
flywheel.model.Object
) – (required) note content
- Returns:
[
Note
, resp]
- addSessionNote()
Add a note to a(n) session.
Add a note to a(n) session.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addSessionTag()
Add a tag to a(n) session.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addSessionTags()
Add multiple tags to a(n) session
Add multiple tags to a(n) session
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteSession()
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:
sessionId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteSessionAnalysis()
Delete an analysis
Delete an analysis for a container.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) Provide a reason for the deletion
- Returns:
[
DeletedResult
, resp]
- deleteSessionAnalysisNote()
Remove a note from a(n) session analysis.
Remove a note from a(n) session analysis.
- Parameters:
cid (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idnoteId (
char
) – (required) 24-char hex note id
- Returns:
[
DeletedResult
, resp]
- deleteSessionFile()
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 (
char
) – (required)filename (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteSessionNote()
Remove a note from a(n) session
Remove a note from a(n) session
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteSessionTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteSessionTags()
Delete multiple tags from a(n) session
Delete multiple tags from a(n) session
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteSessionsByIds()
Delete multiple sessions by ID list
Delete multiple sessions by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteSessionsByQuery()
Delete multiple sessions by query
Delete multiple sessions by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- downloadFileFromSession()
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:
sessionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getSessionFileZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
sessionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getSessionDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
sessionId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadInputFromSessionAnalysis()
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:
sessionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getSessionAnalysisInputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
sessionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getSessionAnalysisInputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
sessionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadOutputFromSessionAnalysis()
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:
sessionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getSessionAnalysisOutputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
sessionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getSessionAnalysisOutputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
sessionId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAllSessions()
Get a list of sessions
Finds all sessions.
- Parameters:
exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsjoinAvatars (
logical
) – (optional) add name and avatar to notesjoin (
JoinType
) – (optional) join file originsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsuserId (
char
) – (optional)filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getSession()
Get a single session
Get a single session
- Parameters:
sessionId (
char
) – (required)joinAvatars (
logical
) – (optional) add name and avatar to notesjoin (
JoinType
) – (optional)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
SessionOutput
, resp]
- getSessionAcquisitions()
List acquisitions in a session
Get acquisitions.
- Parameters:
sessionId (
char
) – (required)collectionId (
char
) – (optional)exhaustive (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getSessionAnalyses()
Get analyses for a(n) session.
Returns analyses that directly belong to this resource.
- Parameters:
cid (
char
) – (required)inflateJob (
logical
) – (optional)joinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getSessionAnalysis()
Get an analysis.
Get an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)inflateJob (
logical
) – (optional) Return job as an object instead of an idjoinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)
- Returns:
[none, resp]
- getSessionFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
cid (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getSessionJobs()
Return any jobs that use inputs from this session
Gets session jobs.
- Parameters:
sessionId (
char
) – (required)states (
vector[char]
) – (optional) filter results by job statetags (
vector[char]
) – (optional) filter results by job tagsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getSessionNote()
Get a note of a(n) session.
Get a note of a(n) session
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getSessionTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- modifySession()
Update a session
Modify a session.
- Parameters:
sessionId (
char
) – (required)body (
flywheel.model.SessionModify
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySessionAnalysis()
Modify an analysis.
Modify an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)body (
flywheel.model.AnalysisModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySessionFile()
Modify a file’s attributes
Note: If modifying a file’s modality, the current classification will be cleared (except for items in the "Custom" list)
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySessionFileClassification()
Update classification for a particular file.
If replacing a file’s classification, the modality can optionally be modified as well.
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileClassificationDelta
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySessionFileInfo()
Update info for a particular file.
Modify and return the file ‘info’ field
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySessionInfo()
Update or replace info for a(n) session.
Update or replace info for a(n) session. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySessionNote()
Update a note of a(n) session.
Update a note of a(n) session
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- renameSessionTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- uploadFileToSession()
Upload a file to a(n) session.
Upload a file to a(n) session.
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadpreserveMetadata (
logical
) – (optional)ticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)metadata (
char
) – (optional) Metadata object as a JSON-encoded stringxAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadOutputToSessionAnalysis()
Upload an output file to an analysis.
Upload an output file to an analysis
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)file (
vector
) – (required) The file to uploadticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)contentType (
char
) – (optional)
- Returns:
[
vector[FileOutput]
, resp]
SiteApi Class
SiteApi API Provider
- class SiteApi
- addProvider()
Add a new provider
- Parameters:
body (
flywheel.model.IngressProvider
) – (required)- Returns:
[
EgressProviderId
, resp]
- addSiteRule()
Create a new site rule.
- Parameters:
body (
flywheel.model.GearRuleInput
) – (required)- Returns:
[
GearRule
, resp]
- deleteProvider()
Delete the provider identified by ProviderId
Returns an empty 204 response if successful. The provider will be deleted asynchronously; if it is a storage provider, any files on the provider that have been deleted but not yet cleaned up will be hard deleted. Use the get_provider operation to check the deletion status.
- Parameters:
providerId (
char
) – (required) The ID of the provider- Returns:
[none, resp]
- getBookmarkList()
Get Bookmark List
- Returns:
[
vector[Bookmark]
, resp]
- getProvider()
Return the provider identified by ProviderId
Return the provider identified by ProviderId
- Parameters:
providerId (
char
) – (required) The ID of the provider- Returns:
[
EgressProvider
, resp]
- getProviderConfig()
Return the configuration for provider identified by ProviderId
The returned configuration will be redacted, with any privileged values replaced with null.
- Parameters:
providerId (
char
) – (required) The ID of the provider- Returns:
[
Map
, resp]
- getProviders()
Return a list of all providers on the site
Return a list of all providers on the site
- Parameters:
class (
ProviderClass
) – (optional) Limit the response to the given provider classfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
- Returns:
[
vector[EgressProvider]
, resp]
- getSiteRule()
Get a site rule.
- Parameters:
ruleId (
char
) – (required)- Returns:
[
GearRule
, resp]
- getSiteRules()
List all site rules.
- Parameters:
limit (
integer
) – (optional)afterId (
char
) – (optional)name (
char
) – (optional)
- Returns:
[
vector[GearRule]
, resp]
- getSiteSettings()
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.
- Returns:
[
SiteSettings
, resp]
- modifyBookmarkList()
Modify Bookmark List
- Parameters:
body (
flywheel.model.vector[Bookmark]
) – (required)- Returns:
[
vector[Bookmark]
, resp]
- modifyProvider()
Update the provider identified by ProviderId
Update the provider identified by ProviderId
- Parameters:
providerId (
char
) – (required) The ID of the providerbody (
flywheel.model.IngressUpdateProvider
) – (required)
- Returns:
[
EgressProvider
, resp]
- modifySiteRule()
Update a site rule.
- Parameters:
ruleId (
char
) – (required)body (
flywheel.model.GearRuleModifyInput
) – (required)
- Returns:
[
GearRule
, resp]
- modifySiteSettings()
Update administrative site settings
- Parameters:
body (
flywheel.model.IngressSiteSettings
) – (required)- Returns:
[
SiteSettings
, resp]
- removeSiteRule()
Remove a site rule.
- Parameters:
ruleId (
char
) – (required)- Returns:
[none, resp]
SubjectsApi Class
SubjectsApi API Provider
- class SubjectsApi
- addSubject()
Create a new subject
Create a new subject
- Parameters:
body (
flywheel.model.Object
) – (required) subject object to create- Returns:
[
InsertedId
, resp]
- addSubjectAnalysis()
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 (
char
) – (required)body (
flywheel.model.Object
) – (required)job (
logical
) – (optional) returns job_id instead of analysis.idjob – (optional) returns job_id instead of analysis.id
- Returns:
[
InsertedId
, resp]
- addSubjectAnalysisNote()
Add a note to a(n) subject analysis.
Add a note to a(n) subject analysis.
- Parameters:
containerId (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idbody (
flywheel.model.Object
) – (required) note content
- Returns:
[
Note
, resp]
- addSubjectNote()
Add a note to a(n) subject.
Add a note to a(n) subject.
- Parameters:
containerId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
Note
, resp]
- addSubjectTag()
Add a tag to a(n) subject.
Propagates changes to projects, sessions and acquisitions
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Tag
) – (required)
- Returns:
[
ModifiedResult
, resp]
- addSubjectTags()
Add multiple tags to a(n) subject
Add multiple tags to a(n) subject
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- createMasterSubjectCode()
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 (
flywheel.model.Object
) – (required)- Returns:
[
MasterSubjectCodeOutput
, resp]
- deleteSubject()
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:
subjectId (
char
) – (required) 24-char hex subject iddeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteSubjectAnalysis()
Delete an analysis
Delete an analysis for a container.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) Provide a reason for the deletion
- Returns:
[
DeletedResult
, resp]
- deleteSubjectAnalysisNote()
Remove a note from a(n) subject analysis.
Remove a note from a(n) subject analysis.
- Parameters:
cid (
char
) – (required) 24-char hex idanalysisId (
char
) – (required) 24-char hex analysis idnoteId (
char
) – (required) 24-char hex note id
- Returns:
[
DeletedResult
, resp]
- deleteSubjectFile()
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 (
char
) – (required)filename (
char
) – (required)deleteReason (
ContainerDeleteReason
) – (optional) A reason for deletion when audit-trail is enabledforce (
logical
) – (optional) Force deletion of the file even if some checks fail. Deprecated, will be removed in a future release.
- Returns:
[
DeletedResult
, resp]
- deleteSubjectNote()
Remove a note from a(n) subject
Remove a note from a(n) subject
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
DeletedResult
, resp]
- deleteSubjectTag()
Delete a tag
Delete a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
DeletedResult
, resp]
- deleteSubjectTags()
Delete multiple tags from a(n) subject
Delete multiple tags from a(n) subject
- Parameters:
cid (
char
) – (required)body (
flywheel.model.vector[char]
) – (required)
- Returns:
[none, resp]
- deleteSubjectsByIds()
Delete multiple subjects by ID list
Delete multiple subjects by ID list
- Parameters:
body (
flywheel.model.vector[char]
) – (required) List of IDs to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- deleteSubjectsByQuery()
Delete multiple subjects by query
Delete multiple subjects by query
- Parameters:
body (
flywheel.model.vector[Filter]
) – (required) Query for containers to deletedeleteReason (
ContainerDeleteReason
) – (optional)
- Returns:
[
DeletedResult
, resp]
- downloadFileFromSubject()
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:
subjectId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getSubjectFileZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
subjectId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getSubjectDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
subjectId (
char
) – (required) 24-character hex IDfileName (
char
) – (required) output file nameticket (
char
) – (optional) The generated ticket id for the download, or present but empty to generate a ticket idinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) 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"version (
integer
) – (optional) version of the file to downloadhash (
char
) – (optional) file hash for comparisonrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadInputFromSubjectAnalysis()
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:
subjectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getSubjectAnalysisInputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
subjectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getSubjectAnalysisInputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
subjectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) 24-char hex ticket idinfo (
logical
) – (optional) get file info onlymember (
char
) – (optional) get zipfile memberview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- downloadOutputFromSubjectAnalysis()
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:
subjectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)info (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getSubjectAnalysisOutputZipInfo()
Retrieve the zip info of a child file by name.
Does not work on files whose names contain a forward slash.
- Parameters:
subjectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
FileZipInfo
, resp]
- getSubjectAnalysisOutputDownloadTicket()
Get a signed URL to download a named child file.
- Parameters:
subjectId (
char
) – (required) 24-character hex IDanalysisId (
char
) – (required) 24-char hex analysis idfilename (
char
) – (required) filename to download (get tar of all if empty)ticket (
char
) – (optional) ticket id of the outputs to downloadinfo (
logical
) – (optional) If the file is a zipfile, return a json response of zipfile member informationmember (
char
) – (optional) The filename of a zipfile member to download rather than the entire fileview (
logical
) – (optional) feature flag for view/downloadrange (
char
) – (optional) byte ranges to returnxAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[none, resp]
- getAllSubjects()
Get a list of subjects
Get a list of subjects
- Parameters:
exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsjoin (
JoinType
) – (optional) join file originsjoinAvatars (
logical
) – (optional) add name and avatar to notesincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getSubject()
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:
subjectId (
char
) – (required) 24-char hex subject idjoin (
JoinType
) – (optional) join file originsjoinAvatars (
logical
) – (optional) add name and avatar to notesxAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[
SubjectOutput
, resp]
- getSubjectAnalyses()
Get analyses for a(n) subject.
Returns analyses that directly belong to this resource.
- Parameters:
cid (
char
) – (required)inflateJob (
logical
) – (optional)joinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getSubjectAnalysis()
Get an analysis.
Get an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)inflateJob (
logical
) – (optional) Return job as an object instead of an idjoinAvatars (
logical
) – (optional)join (
JoinType
) – (optional)
- Returns:
[none, resp]
- getSubjectFileInfo()
Get info for a particular file.
Get info for a particular file.
- Parameters:
cid (
char
) – (required) Container Idfilename (
char
) – (required)
- Returns:
[
FileOutput
, resp]
- getSubjectNote()
Get a note of a(n) subject.
Get a note of a(n) subject
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)
- Returns:
[
Note
, resp]
- getSubjectSessions()
List sessions of a subject
List sessions of a subject
- Parameters:
subjectId (
char
) – (required) 24-char hex subject idjoin (
JoinType
) – (optional) join file originsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[Object]
) – (optional)
- Returns:
[none, resp]
- getSubjectTag()
Get the value of a tag, by name.
Get the value of a tag, by name
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact with
- Returns:
[
char
, resp]
- modifySubject()
Update a subject
Update a subject
- Parameters:
subjectId (
char
) – (required) 24-char hex subject idbody (
flywheel.model.Object
) – (required) subject object to modify
- Returns:
[
ModifiedResult
, resp]
- modifySubjectAnalysis()
Modify an analysis.
Modify an analysis.
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)body (
flywheel.model.AnalysisModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySubjectFile()
Modify a file’s attributes
Note: If modifying a file’s modality, the current classification will be cleared (except for items in the "Custom" list)
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileModifyInput
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySubjectFileClassification()
Update classification for a particular file.
If replacing a file’s classification, the modality can optionally be modified as well.
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.FileClassificationDelta
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySubjectFileInfo()
Update info for a particular file.
Modify and return the file ‘info’ field
- Parameters:
cid (
char
) – (required)filename (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySubjectInfo()
Update or replace info for a(n) subject.
Update or replace info for a(n) subject. Keys that contain ‘$’ or ‘.’ will be sanitized in the process of being updated on the container.
- Parameters:
cid (
char
) – (required)body (
flywheel.model.Info
) – (required)
- Returns:
[
ModifiedResult
, resp]
- modifySubjectNote()
Update a note of a(n) subject.
Update a note of a(n) subject
- Parameters:
cid (
char
) – (required)noteId (
char
) – (required)body (
flywheel.model.NoteInput
) – (required)
- Returns:
[
integer
, resp]
- renameSubjectTag()
Rename a tag.
Rename a tag
- Parameters:
cid (
char
) – (required)value (
char
) – (required) The tag to interact withbody (
flywheel.model.Tag
) – (required)
- Returns:
[
char
, resp]
- uploadFileToSubject()
Upload a file to a(n) subject.
Upload a file to a(n) subject.
- Parameters:
containerId (
char
) – (required)file (
vector
) – (required) The file to uploadpreserveMetadata (
logical
) – (optional)ticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)metadata (
char
) – (optional) Metadata object as a JSON-encoded stringxAcceptFeature (
vector[char]
) – (optional) redirect headercontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadOutputToSubjectAnalysis()
Upload an output file to an analysis.
Upload an output file to an analysis
- Parameters:
cid (
char
) – (required)analysisId (
char
) – (required)file (
vector
) – (required) The file to uploadticket (
char
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)contentType (
char
) – (optional)
- Returns:
[
vector[FileOutput]
, resp]
- verifyMasterSubjectCode()
Verify that the given master subject code exists or not
Verify that the given master subject code exists or not
- Parameters:
code (
char
) – (required) code id- Returns:
[
MasterSubjectCodeOutput
, resp]
TreeApi Class
TreeApi API Provider
- class TreeApi
- fetchTree()
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 (
flywheel.model.GraphFilter
) – (required)exhaustive (
logical
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getTreeGraph()
Get a description of the flywheel hiearchy
Get a description of the flywheel hiearchy
- Returns:
[
Map[String, TreeGraphNode]
, resp]
UidsApi Class
UidsApi API Provider
UploadApi Class
UploadApi API Provider
- class UploadApi
- cleanupSignedUploadUrl()
Cleanup unused file blob previously uploaded using signed URL
- Parameters:
body (
flywheel.model.SignedUrlCleanupInput
) – (required)- Returns:
[none, resp]
- completeS3MultipartUpload()
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:
body (
flywheel.model.CompleteS3MultipartUploadInput
) – (required)- Returns:
[
CompleteMultipartUploadOutput
, resp]
- createSignedUploadUrl()
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:
body (
flywheel.model.SignedUrlUploadInput
) – (required)- Returns:
[
SignedUrlUploadOutput
, resp]
- uploadByLabel()
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 withticket
> 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:
preserveMetadata (
logical
) – (optional)ticket (
char
) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the uploadid (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)files (
vector
) – (optional)metadata (
containers.Map
) – (optional) Metadata objectcontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadByReaper()
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:
preserveMetadata (
logical
) – (optional)ticket (
char
) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the uploaduidPlacement (
logical
) – (optional)id (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)files (
vector
) – (optional)metadata (
containers.Map
) – (optional) Metadata objectcontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadByUid()
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 withticket
> 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:
preserveMetadata (
logical
) – (optional)ticket (
char
) – (optional) Use empty value to get a ticket, and provide the ticket id to finalize the uploadid (
char
) – (optional)level (
ContainerType
) – (optional)job (
char
) – (optional)files (
vector
) – (optional)metadata (
containers.Map
) – (optional) Metadata objectcontentType (
char
) – (optional)
- Returns:
[none, resp]
- uploadSignedFsFile()
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 (
char
) – (required) Upload tokenbody (
vector
) – (required) Signed filesystem file upload payload
- Returns:
[
SignedFSUploadOutput
, resp]
UsersApi Class
UsersApi API Provider
- class UsersApi
- addUser()
Add a new user
Add a new user
- Parameters:
body (
flywheel.model.UserInput
) – (required)- Returns:
[
UserOutputId
, resp]
- deleteUser()
Delete a user
Delete a user
- Parameters:
userId (
char
) – (required)- Returns:
[none, resp]
- deleteUserKey()
Delete User Api Key
- Parameters:
id (
char
) – (required)- Returns:
[none, resp]
- generateUserKey()
Generates user api key
Generate user api key for the current user.
- Parameters:
body (
flywheel.model.CoreModelsApiKeyApiKeyInput
) – (required)- Returns:
[
ApiKeyOutput
, resp]
- getAllUsers()
Return a list of all users
Gets all users with pagination Args:
- Parameters:
filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getCurrentUser()
Get information about the current user
Gets the current user Args: auth_session (AuthSession): session from incoming request Returns: CurrentUserOutput: Pydantic model for client side user data
- Returns:
[
CurrentUserOutput
, resp]
- getCurrentUserAvatar()
Get the avatar of the current user
Gets avatar of current user Args: auth_session (AuthSession): session from incoming request Returns: str: url of avatar
- Parameters:
default (
char
) – (optional)- Returns:
[none, resp]
- getCurrentUserInfo()
Get info of the current user
Gets user info fields. Args: fields (str): csv of arbitrary keys to look for in user info auth_session (AuthSession): session from incoming request Returns: dict: arbitrary data matching the provided csv values
- Parameters:
fields (
char
) – (optional) Get only the specified fields from user’s info. Accept multiple fields separated by comma.- Returns:
[
Map
, resp]
- getCurrentUserJobs()
Return list of jobs created by the current user
Gets jobs assigned to user with optional gear name regex Args: gear_name (str): name of gear to filter by auth_session (AuthSession): session from incoming request Returns: list: List of jobs linked to the user
- Parameters:
gear (
char
) – (optional) Gear name. Get only the jobs which are related to a specific gear.exhaustive (
logical
) – (optional)filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[
UserJobs
, resp]
- getUser()
Get information about the specified user
Get user by id Args: uid (str): string matching uid pattern Returns: UserOutput: Pydantic model for sending data to client
- Parameters:
userId (
char
) – (required)includeDeleted (
logical
) – (optional)
- Returns:
[
UserOutput
, resp]
- getUserAcquisitions()
Get all acquisitions that belong to the given user.
Get all acquisitions that belong to the given user.
- Parameters:
uid (
char
) – (required)exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
- Returns:
[
vector[AcquisitionListOutput]
, resp]
- getUserAvatar()
Get the avatar of the specified user
gets avatar of user and redirects to it Args: user_id (str): user id matching user_id regex Returns: RedirectResponse: redirects user to avatar Raises (ResourceNotFound): Raises 404 if no user avatar
- Parameters:
userId (
char
) – (required)default (
char
) – (optional)
- Returns:
[none, resp]
- getUserCollections()
Get all collections that belong to the given user.
- Parameters:
userId (
char
) – (required)filter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional)
- Returns:
[none, resp]
- getUserGroups()
List all groups the specified user is a member of
- Parameters:
uid (
char
) – (required)exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)xAcceptFeature (
vector[char]
) – (optional) redirect header
- Returns:
[
vector[GroupOutput]
, resp]
- getUserProjects()
Get all projects that belong to the given user.
Get all projects that belong to the given user.
- Parameters:
uid (
char
) – (required)exhaustive (
logical
) – (optional) Set to return a complete list regardless of permissionsincludeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
- Returns:
[
vector[ProjectListOutput]
, resp]
- getUserSessions()
Get all sessions that belong to the given user.
Get all sessions that belong to the given user.
- Parameters:
uid (
char
) – (required)exhaustive (
logical
) – (optional)includeAllInfo (
logical
) – (optional) Include all info in returned objectsfilter (
char
) – (optional) The filter to apply. (e.g. label=my-label,created>2018-09-22)sort (
char
) – (optional) The sort fields and order. (e.g. label:asc,created:desc)limit (
integer
) – (optional) The maximum number of entries to return.skip (
integer
) – (optional) The number of entries to skip.page (
integer
) – (optional) The page number (i.e. skip limit*page entries)afterId (
char
) – (optional) Paginate after the given id. (Cannot be used with sort, page or skip)
- Returns:
[
vector[SessionListOutput]
, resp]
- modifyCurrentUserInfo()
Update or replace info for the current user.
Modifies user info fields Args: info (Info): Model representing arbitrary data auth_session (AuthSession): session from incoming request Returns: None
- Parameters:
body (
flywheel.model.Info
) – (required)- Returns:
[none, resp]
- modifyUser()
Update the specified user
Update the specified user
- Parameters:
uid (
char
) – (required)body (
flywheel.model.ModifyUserInput
) – (required)clearPermissions (
logical
) – (optional)
- Returns:
[
ModifiedResult
, resp]
- syncUser()
Sync a center user to enterprise (Sync service use ONLY)
- Parameters:
cid (
char
) – (required)body (
flywheel.model.SyncUserInput
) – (required)
- Returns:
[none, resp]
ViewsApi Class
ViewsApi API Provider
- class ViewsApi
- dataViewColumns()
Return a list of all known column aliases for use in data views
- Returns:
[
vector[DataViewColumnAlias]
, resp]
- deleteView()
Delete a data view
Soft deletes data view in database
- Parameters:
viewId (
char
) – (required) The ID of the view- Returns:
[
DeletedResult
, resp]
- evaluateView()
Execute a view, returning data in the preferred format.
- Parameters:
viewId (
char
) – (required) The ID of the viewcontainerId (
char
) – (required) The target container for view executionticket (
char
) – (optional) download ticket idfilename (
char
) – (optional) download ticket filenameformat (
Object
) – (optional) Available values : csv, tsv, json, ndjson, json_flat, json-row-columnsort (
char
) – (optional) The sort fields and order.(e.g. label:asc,created:desc)filter (
char
) – (optional) An optional filter expressionskip (
integer
) – (optional) The optional number of rows to skiplimit (
integer
) – (optional) The optional max number of rows to return
- Returns:
[none, resp]
- evaluateViewAdhoc()
Execute an ad-hoc view, returning data in the preferred format.
- Parameters:
containerId (
char
) – (required) The target container for view executionbody (
flywheel.model.ContainerPipelineInput
) – (required)filename (
char
) – (optional) download ticket filenameformat (
Object
) – (optional) Available values : csv, tsv, json, ndjson, json_flat, json-row-columnticket (
char
) – (optional) download ticket idsort (
char
) – (optional) The sort fields and order.(e.g. label:asc,created:desc)filter (
char
) – (optional) An optional filter expressionskip (
integer
) – (optional) The optional number of rows to skiplimit (
integer
) – (optional) The optional max number of rows to return
- Returns:
[none, resp]
- getView()
Return the view identified by ViewId
- Parameters:
viewId (
char
) – (required) The ID of the view- Returns:
[
ViewOutput
, resp]
- modifyView()
Update the view identified by ViewId
- Parameters:
viewId (
char
) – (required) The ID of the viewbody (
flywheel.model.ContainerModify
) – (required)
- Returns:
[
ModifiedResult
, resp]
- queueAdhoc()
Execute an ad-hoc view, returning a reference to the created data view execution.
- Parameters:
containerId (
char
) – (required) The target container for view executionbody (
flywheel.model.ContainerPipelineInput
) – (required)sort (
char
) – (optional) The sort fields and order.(e.g. label:asc,created:desc)filter (
char
) – (optional) An optional filter expressionskip (
integer
) – (optional) The optional number of rows to skiplimit (
integer
) – (optional) The optional max number of rows to return
- Returns:
[
DataViewExecution
, resp]
- queueSaved()
Execute a view, returning a reference to the created data view execution.
Execute a view, returning a reference to the created data view execution.
- Parameters:
viewId (
char
) – (required) The ID of the viewcontainerId (
char
) – (required) The target container for view executionsort (
char
) – (optional) The sort fields and order.(e.g. label:asc,created:desc)filter (
char
) – (optional) An optional filter expressionskip (
integer
) – (optional) The optional number of rows to skiplimit (
integer
) – (optional) The optional max number of rows to return
- Returns:
[
DataViewExecution
, resp]
- saveViewDataToContainer()
Execute a view, saving data to the target container / file
Execute a view, saving data to the target container / file
- Parameters:
containerId (
char
) – (required) The target container for view executionbody (
flywheel.model.ContainerIdViewInputExecuteAndSave
) – (required)format (
Object
) – (optional) Available values : csv, tsv, json, ndjson, json_flat, json-row-columnticket (
char
) – (optional) download ticket idfilter (
char
) – (optional) An optional filter expressionsort (
char
) – (optional) The sort fields and order.(e.g. label:asc,created:desc)skip (
integer
) – (optional) The optional number of rows to skiplimit (
integer
) – (optional) The optional max number of rows to return
- Returns:
[
File
, resp]