flywheel.model package¶

Acquisition¶

class Acquisition¶

label¶

Application-specific label

Returns: The label of this Acquisition.
Return type: char

info¶

Gets the info of this Acquisition.

Returns: The info of this Acquisition.
Return type: CommonInfo

session¶

Unique database ID

Returns: The session of this Acquisition.
Return type: char

uid¶

A user database ID

Returns: The uid of this Acquisition.
Return type: char

timestamp¶

Gets the timestamp of this Acquisition.

Returns: The timestamp of this Acquisition.
Return type: datetime

timezone¶

Gets the timezone of this Acquisition.

Returns: The timezone of this Acquisition.
Return type: char

id¶

Unique database ID

Returns: The id of this Acquisition.
Return type: char

parents¶

Gets the parents of this Acquisition.

Returns: The parents of this Acquisition.
Return type: ContainerParents

collections¶

Gets the collections of this Acquisition.

Returns: The collections of this Acquisition.
Return type: vector[char]

files¶

Gets the files of this Acquisition.

Returns: The files of this Acquisition.
Return type: FileEntry

created¶

Creation time (automatically set)

Returns: The created of this Acquisition.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Acquisition.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this Acquisition.
Return type: integer

infoExists¶

Gets the infoExists of this Acquisition.

Returns: The infoExists of this Acquisition.
Return type: logical

permissions¶

Gets the permissions of this Acquisition.

Returns: The permissions of this Acquisition.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this Acquisition.

Returns: The notes of this Acquisition.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this Acquisition.
Return type: vector[char]

analyses¶

Gets the analyses of this Acquisition.

Returns: The analyses of this Acquisition.
Return type: AnalysisOutput

AcquisitionMetadataInput¶

class AcquisitionMetadataInput¶

label¶

Gets the label of this AcquisitionMetadataInput.

Returns: The label of this AcquisitionMetadataInput.
Return type: char

info¶

Gets the info of this AcquisitionMetadataInput.

Returns: The info of this AcquisitionMetadataInput.
Return type: containers.Map

metadata¶

Gets the metadata of this AcquisitionMetadataInput.

Returns: The metadata of this AcquisitionMetadataInput.
Return type: containers.Map

measurement¶

Gets the measurement of this AcquisitionMetadataInput.

Returns: The measurement of this AcquisitionMetadataInput.
Return type: char

instrument¶

Gets the instrument of this AcquisitionMetadataInput.

Returns: The instrument of this AcquisitionMetadataInput.
Return type: char

uid¶

Gets the uid of this AcquisitionMetadataInput.

Returns: The uid of this AcquisitionMetadataInput.
Return type: char

tags¶

Array of application-specific tags

Returns: The tags of this AcquisitionMetadataInput.
Return type: vector[char]

timestamp¶

Gets the timestamp of this AcquisitionMetadataInput.

Returns: The timestamp of this AcquisitionMetadataInput.
Return type: datetime

timezone¶

Gets the timezone of this AcquisitionMetadataInput.

Returns: The timezone of this AcquisitionMetadataInput.
Return type: char

files¶

Gets the files of this AcquisitionMetadataInput.

Returns: The files of this AcquisitionMetadataInput.
Return type: FileEntry

AnalysisFilesCreateTicketOutput¶

class AnalysisFilesCreateTicketOutput¶

ticket¶

Gets the ticket of this AnalysisFilesCreateTicketOutput.

Returns: The ticket of this AnalysisFilesCreateTicketOutput.
Return type: char

filename¶

Gets the filename of this AnalysisFilesCreateTicketOutput.

Returns: The filename of this AnalysisFilesCreateTicketOutput.
Return type: char

fileCnt¶

Gets the fileCnt of this AnalysisFilesCreateTicketOutput.

Returns: The fileCnt of this AnalysisFilesCreateTicketOutput.
Return type: integer

size¶

Gets the size of this AnalysisFilesCreateTicketOutput.

Returns: The size of this AnalysisFilesCreateTicketOutput.
Return type: integer

AnalysisInput¶

Analysis input for creating ad-hoc analyses

class AnalysisInput¶

Analysis input for creating ad-hoc analyses

inputs¶

The set of inputs that this analysis is based on

Returns: The inputs of this AnalysisInput.
Return type: FileReference

description¶

Gets the description of this AnalysisInput.

Returns: The description of this AnalysisInput.
Return type: char

info¶

Gets the info of this AnalysisInput.

Returns: The info of this AnalysisInput.
Return type: CommonInfo

label¶

Application-specific label

Returns: The label of this AnalysisInput.
Return type: char

job¶

Gets the job of this AnalysisInput.

Returns: The job of this AnalysisInput.
Return type: Job

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this AnalysisInput.
Return type: char

AnalysisInputLegacy¶

class AnalysisInputLegacy¶

inputs¶

The set of inputs that this analysis is based on

Returns: The inputs of this AnalysisInputLegacy.
Return type: FileEntry

outputs¶

Gets the outputs of this AnalysisInputLegacy.

Returns: The outputs of this AnalysisInputLegacy.
Return type: FileEntry

description¶

Gets the description of this AnalysisInputLegacy.

Returns: The description of this AnalysisInputLegacy.
Return type: char

label¶

Application-specific label

Returns: The label of this AnalysisInputLegacy.
Return type: char

AnalysisListEntry¶

class AnalysisListEntry¶

id¶

Unique database ID

Returns: The id of this AnalysisListEntry.
Return type: char

inputs¶

Gets the inputs of this AnalysisListEntry.

Returns: The inputs of this AnalysisListEntry.
Return type: FileEntry

files¶

Gets the files of this AnalysisListEntry.

Returns: The files of this AnalysisListEntry.
Return type: FileEntry

job¶

Unique database ID

Returns: The job of this AnalysisListEntry.
Return type: char

gearInfo¶

Gets the gearInfo of this AnalysisListEntry.

Returns: The gearInfo of this AnalysisListEntry.
Return type: GearInfo

notes¶

Gets the notes of this AnalysisListEntry.

Returns: The notes of this AnalysisListEntry.
Return type: Note

description¶

Gets the description of this AnalysisListEntry.

Returns: The description of this AnalysisListEntry.
Return type: char

label¶

Application-specific label

Returns: The label of this AnalysisListEntry.
Return type: char

parent¶

Gets the parent of this AnalysisListEntry.

Returns: The parent of this AnalysisListEntry.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisListEntry.

Returns: The parents of this AnalysisListEntry.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this AnalysisListEntry.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this AnalysisListEntry.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this AnalysisListEntry.
Return type: integer

AnalysisOutput¶

class AnalysisOutput¶

id¶

Unique database ID

Returns: The id of this AnalysisOutput.
Return type: char

inputs¶

Gets the inputs of this AnalysisOutput.

Returns: The inputs of this AnalysisOutput.
Return type: FileEntry

files¶

Gets the files of this AnalysisOutput.

Returns: The files of this AnalysisOutput.
Return type: FileEntry

job¶

Gets the job of this AnalysisOutput.

Returns: The job of this AnalysisOutput.
Return type: Job

gearInfo¶

Gets the gearInfo of this AnalysisOutput.

Returns: The gearInfo of this AnalysisOutput.
Return type: GearInfo

notes¶

Gets the notes of this AnalysisOutput.

Returns: The notes of this AnalysisOutput.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this AnalysisOutput.
Return type: vector[char]

info¶

Gets the info of this AnalysisOutput.

Returns: The info of this AnalysisOutput.
Return type: CommonInfo

description¶

Gets the description of this AnalysisOutput.

Returns: The description of this AnalysisOutput.
Return type: char

label¶

Application-specific label

Returns: The label of this AnalysisOutput.
Return type: char

parent¶

Gets the parent of this AnalysisOutput.

Returns: The parent of this AnalysisOutput.
Return type: ContainerReference

parents¶

Gets the parents of this AnalysisOutput.

Returns: The parents of this AnalysisOutput.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this AnalysisOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this AnalysisOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this AnalysisOutput.
Return type: integer

AnalysisUpdate¶

class AnalysisUpdate¶

label¶

Application-specific label

Returns: The label of this AnalysisUpdate.
Return type: char

AuthLoginOutput¶

class AuthLoginOutput¶

token¶

Gets the token of this AuthLoginOutput.

Returns: The token of this AuthLoginOutput.
Return type: char

AuthLoginStatus¶

class AuthLoginStatus¶

origin¶

Gets the origin of this AuthLoginStatus.

Returns: The origin of this AuthLoginStatus.
Return type: ReportAccessLogOrigin

userIsAdmin¶

Whether or not the user has admin privileges

Returns: The userIsAdmin of this AuthLoginStatus.
Return type: logical

isDevice¶

Whether or not the credentials identified a device

Returns: The isDevice of this AuthLoginStatus.
Return type: logical

roles¶

Gets the roles of this AuthLoginStatus.

Returns: The roles of this AuthLoginStatus.
Return type: vector[char]

AuthLogoutOutput¶

class AuthLogoutOutput¶

tokensRemoved¶

Gets the tokensRemoved of this AuthLogoutOutput.

Returns: The tokensRemoved of this AuthLogoutOutput.
Return type: integer

Avatars¶

class Avatars¶

gravatar¶

Gets the gravatar of this Avatars.

Returns: The gravatar of this Avatars.
Return type: char

provider¶

Gets the provider of this Avatars.

Returns: The provider of this Avatars.
Return type: char

custom¶

Gets the custom of this Avatars.

Returns: The custom of this Avatars.
Return type: char

Batch¶

class Batch¶

id¶

Unique database ID

Returns: The id of this Batch.
Return type: char

gearId¶

Gets the gearId of this Batch.

Returns: The gearId of this Batch.
Return type: char

state¶

Gets the state of this Batch.

Returns: The state of this Batch.
Return type: char

origin¶

Gets the origin of this Batch.

Returns: The origin of this Batch.
Return type: JobOrigin

config¶

Gets the config of this Batch.

Returns: The config of this Batch.
Return type: JobConfig

jobs¶

Gets the jobs of this Batch.

Returns: The jobs of this Batch.
Return type: vector[char]

created¶

Creation time (automatically set)

Returns: The created of this Batch.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Batch.
Return type: datetime

BatchCancelOutput¶

class BatchCancelOutput¶

numberCancelled¶

Gets the numberCancelled of this BatchCancelOutput.

Returns: The numberCancelled of this BatchCancelOutput.
Return type: integer

BatchJobsProposalInput¶

class BatchJobsProposalInput¶

jobs¶

Gets the jobs of this BatchJobsProposalInput.

Returns: The jobs of this BatchJobsProposalInput.
Return type: Job

BatchProposal¶

class BatchProposal¶

id¶

Unique database ID

Returns: The id of this BatchProposal.
Return type: char

gearId¶

Gets the gearId of this BatchProposal.

Returns: The gearId of this BatchProposal.
Return type: char

state¶

Gets the state of this BatchProposal.

Returns: The state of this BatchProposal.
Return type: char

config¶

Gets the config of this BatchProposal.

Returns: The config of this BatchProposal.
Return type: JobConfig

origin¶

Gets the origin of this BatchProposal.

Returns: The origin of this BatchProposal.
Return type: JobOrigin

proposal¶

Gets the proposal of this BatchProposal.

Returns: The proposal of this BatchProposal.
Return type: BatchProposalDetail

ambiguous¶

Gets the ambiguous of this BatchProposal.

Returns: The ambiguous of this BatchProposal.
Return type: ContainerOutputWithFiles

matched¶

Gets the matched of this BatchProposal.

Returns: The matched of this BatchProposal.
Return type: ContainerOutputWithFiles

notMatched¶

Gets the notMatched of this BatchProposal.

Returns: The notMatched of this BatchProposal.
Return type: ContainerOutputWithFiles

optionalInputPolicy¶

ignored: Ignore all optional inputs, flexible: match a file if it’s there, otherwise still match the container, required: treat all optional inputs as required inputs.

Returns: The optionalInputPolicy of this BatchProposal.
Return type: char

improperPermissions¶

Gets the improperPermissions of this BatchProposal.

Returns: The improperPermissions of this BatchProposal.
Return type: vector[char]

created¶

Creation time (automatically set)

Returns: The created of this BatchProposal.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this BatchProposal.
Return type: datetime

BatchProposalDetail¶

class BatchProposalDetail¶

analysis¶

Gets the analysis of this BatchProposalDetail.

Returns: The analysis of this BatchProposalDetail.
Return type: AnalysisInput

tags¶

Array of application-specific tags

Returns: The tags of this BatchProposalDetail.
Return type: vector[char]

BatchProposalInput¶

class BatchProposalInput¶

gearId¶

Gets the gearId of this BatchProposalInput.

Returns: The gearId of this BatchProposalInput.
Return type: char

config¶

Gets the config of this BatchProposalInput.

Returns: The config of this BatchProposalInput.
Return type: JobConfig

tags¶

Array of application-specific tags

Returns: The tags of this BatchProposalInput.
Return type: vector[char]

optionalInputPolicy¶

ignored: Ignore all optional inputs, flexible: match a file if it’s there, otherwise still match the container, required: treat all optional inputs as required inputs.

Returns: The optionalInputPolicy of this BatchProposalInput.
Return type: char

analysis¶

Gets the analysis of this BatchProposalInput.

Returns: The analysis of this BatchProposalInput.
Return type: AnalysisInput

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this BatchProposalInput.
Return type: char

targets¶

Gets the targets of this BatchProposalInput.

Returns: The targets of this BatchProposalInput.
Return type: ContainerReference

Body¶

class Body¶

firstName¶

First name

Returns: The firstName of this Body.
Return type: char

lastName¶

Last name

Returns: The lastName of this Body.
Return type: char

dateOfBirth¶

Date of birth in YYYY-MM-DD format

Returns: The dateOfBirth of this Body.
Return type: char

patientId¶

Patient id

Returns: The patientId of this Body.
Return type: char

usePatientId¶

Use patient ID for identification or first name, last name, DOB

Returns: The usePatientId of this Body.
Return type: logical

BulkMoveSessions¶

class BulkMoveSessions¶

destinationContainerType¶

The type of destination container

Returns: The destinationContainerType of this BulkMoveSessions.
Return type: char

sources¶

Array of continer Ids that you would like to bulk move

Returns: The sources of this BulkMoveSessions.
Return type: vector[char]

destinations¶

Array with a single continer Id of the destination container’s Id

Returns: The destinations of this BulkMoveSessions.
Return type: vector[char]

conflictMode¶

How to handle conflicts. Required even if no conflicts are found

Returns: The conflictMode of this BulkMoveSessions.
Return type: char

CallbacksVirusScanInput¶

Virus scan result

class CallbacksVirusScanInput¶

Virus scan result

state¶

Gets the state of this CallbacksVirusScanInput.

Returns: The state of this CallbacksVirusScanInput.
Return type: char

ClassificationAddDelete¶

class ClassificationAddDelete¶

add¶

Gets the add of this ClassificationAddDelete.

Returns: The add of this ClassificationAddDelete.
Return type: CommonClassification

delete¶

Gets the delete of this ClassificationAddDelete.

Returns: The delete of this ClassificationAddDelete.
Return type: CommonClassification

ClassificationReplace¶

class ClassificationReplace¶

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this ClassificationReplace.
Return type: char

replace¶

Gets the replace of this ClassificationReplace.

Returns: The replace of this ClassificationReplace.
Return type: containers.Map

ClassificationUpdateInput¶

Helper endpoint for editing an object’s classification key

class ClassificationUpdateInput¶

Helper endpoint for editing an object’s classification key

add¶

Gets the add of this ClassificationUpdateInput.

Returns: The add of this ClassificationUpdateInput.
Return type: CommonClassification

delete¶

Gets the delete of this ClassificationUpdateInput.

Returns: The delete of this ClassificationUpdateInput.
Return type: CommonClassification

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this ClassificationUpdateInput.
Return type: char

replace¶

Gets the replace of this ClassificationUpdateInput.

Returns: The replace of this ClassificationUpdateInput.
Return type: containers.Map

Collection¶

class Collection¶

label¶

Application-specific label

Returns: The label of this Collection.
Return type: char

info¶

Gets the info of this Collection.

Returns: The info of this Collection.
Return type: CommonInfo

description¶

Gets the description of this Collection.

Returns: The description of this Collection.
Return type: char

contents¶

Gets the contents of this Collection.

Returns: The contents of this Collection.
Return type: CollectionOperation

id¶

Unique database ID

Returns: The id of this Collection.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this Collection.
Return type: logical

curator¶

Database ID of a user

Returns: The curator of this Collection.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this Collection.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Collection.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this Collection.
Return type: integer

permissions¶

Gets the permissions of this Collection.

Returns: The permissions of this Collection.
Return type: RolesRoleAssignment

files¶

Gets the files of this Collection.

Returns: The files of this Collection.
Return type: FileEntry

notes¶

Gets the notes of this Collection.

Returns: The notes of this Collection.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this Collection.
Return type: vector[char]

analyses¶

Gets the analyses of this Collection.

Returns: The analyses of this Collection.
Return type: AnalysisOutput

CollectionNewOutput¶

class CollectionNewOutput¶

id¶

Unique database ID

Returns: The id of this CollectionNewOutput.
Return type: char

CollectionNode¶

class CollectionNode¶

level¶

Gets the level of this CollectionNode.

Returns: The level of this CollectionNode.
Return type: char

id¶

Unique database ID

Returns: The id of this CollectionNode.
Return type: char

CollectionOperation¶

class CollectionOperation¶

operation¶

Gets the operation of this CollectionOperation.

Returns: The operation of this CollectionOperation.
Return type: char

nodes¶

Gets the nodes of this CollectionOperation.

Returns: The nodes of this CollectionOperation.
Return type: CollectionNode

CommonClassification¶

class CommonClassification¶

CommonDeletedCount¶

class CommonDeletedCount¶

deleted¶

Gets the deleted of this CommonDeletedCount.

Returns: The deleted of this CommonDeletedCount.
Return type: integer

CommonEditions¶

class CommonEditions¶

lab¶

Gets the lab of this CommonEditions.

Returns: The lab of this CommonEditions.
Return type: logical

CommonInfo¶

Free-form information storage

class CommonInfo¶: Free-form information storage

CommonKey¶

class CommonKey¶

key¶

Gets the key of this CommonKey.

Returns: The key of this CommonKey.
Return type: char

CommonModifiedCount¶

class CommonModifiedCount¶

modified¶

Gets the modified of this CommonModifiedCount.

Returns: The modified of this CommonModifiedCount.
Return type: integer

CommonObjectCreated¶

class CommonObjectCreated¶

id¶

Gets the id of this CommonObjectCreated.

Returns: The id of this CommonObjectCreated.
Return type: char

ConfigAuthOutput¶

class ConfigAuthOutput¶

verifyEndpoint¶

Gets the verifyEndpoint of this ConfigAuthOutput.

Returns: The verifyEndpoint of this ConfigAuthOutput.
Return type: char

clientId¶

Gets the clientId of this ConfigAuthOutput.

Returns: The clientId of this ConfigAuthOutput.
Return type: char

clientSecret¶

Gets the clientSecret of this ConfigAuthOutput.

Returns: The clientSecret of this ConfigAuthOutput.
Return type: char

authEndpoint¶

Gets the authEndpoint of this ConfigAuthOutput.

Returns: The authEndpoint of this ConfigAuthOutput.
Return type: char

refreshEndpoint¶

Gets the refreshEndpoint of this ConfigAuthOutput.

Returns: The refreshEndpoint of this ConfigAuthOutput.
Return type: char

ConfigFeatureMap¶

A map of supported features

class ConfigFeatureMap¶

A map of supported features

signedUrl¶

Whether or not this server supports signed url uploads

Returns: The signedUrl of this ConfigFeatureMap.
Return type: logical

jobTickets¶

Whether or not this server supports new job tickets

Returns: The jobTickets of this ConfigFeatureMap.
Return type: logical

jobAsk¶

Whether or not this server supports the /jobs/ask endpoint

Returns: The jobAsk of this ConfigFeatureMap.
Return type: logical

multiproject¶

Whether or not this server has the multiproject feature enabled

Returns: The multiproject of this ConfigFeatureMap.
Return type: logical

healthcareApi¶

Google Healthcare API integration

Returns: The healthcareApi of this ConfigFeatureMap.
Return type: logical

crawler¶

Whether or not this server uses crawler as the search driver

Returns: The crawler of this ConfigFeatureMap.
Return type: logical

ConfigOutput¶

class ConfigOutput¶

site¶

Gets the site of this ConfigOutput.

Returns: The site of this ConfigOutput.
Return type: ConfigSiteConfigOutput

modified¶

Gets the modified of this ConfigOutput.

Returns: The modified of this ConfigOutput.
Return type: char

auth¶

Gets the auth of this ConfigOutput.

Returns: The auth of this ConfigOutput.
Return type: ConfigAuthOutput

created¶

Gets the created of this ConfigOutput.

Returns: The created of this ConfigOutput.
Return type: char

signedUrl¶

Whether or not this server supports signed url uploads

Returns: The signedUrl of this ConfigOutput.
Return type: logical

features¶

Gets the features of this ConfigOutput.

Returns: The features of this ConfigOutput.
Return type: ConfigFeatureMap

ConfigSiteConfigOutput¶

class ConfigSiteConfigOutput¶

centralUrl¶

Gets the centralUrl of this ConfigSiteConfigOutput.

Returns: The centralUrl of this ConfigSiteConfigOutput.
Return type: char

sslCert¶

Gets the sslCert of this ConfigSiteConfigOutput.

Returns: The sslCert of this ConfigSiteConfigOutput.
Return type: char

apiUrl¶

Gets the apiUrl of this ConfigSiteConfigOutput.

Returns: The apiUrl of this ConfigSiteConfigOutput.
Return type: char

registered¶

Gets the registered of this ConfigSiteConfigOutput.

Returns: The registered of this ConfigSiteConfigOutput.
Return type: logical

id¶

Gets the id of this ConfigSiteConfigOutput.

Returns: The id of this ConfigSiteConfigOutput.
Return type: char

name¶

Gets the name of this ConfigSiteConfigOutput.

Returns: The name of this ConfigSiteConfigOutput.
Return type: char

ConfigSiteSettings¶

class ConfigSiteSettings¶

created¶

Gets the created of this ConfigSiteSettings.

Returns: The created of this ConfigSiteSettings.
Return type: char

modified¶

Gets the modified of this ConfigSiteSettings.

Returns: The modified of this ConfigSiteSettings.
Return type: char

centerGears¶

A list of gear algorithm names that are treated as center-pays for the purpose of the billing report

Returns: The centerGears of this ConfigSiteSettings.
Return type: vector[char]

providers¶

Gets the providers of this ConfigSiteSettings.

Returns: The providers of this ConfigSiteSettings.
Return type: ProviderLinks

viewerApps¶

A list of viewer app associations for files and container

Returns: The viewerApps of this ConfigSiteSettings.
Return type: ViewerApp

ldapSync¶

Gets the ldapSync of this ConfigSiteSettings.

Returns: The ldapSync of this ConfigSiteSettings.
Return type: LdapSync

ConfigSiteSettingsInput¶

class ConfigSiteSettingsInput¶

centerGears¶

A list of gear algorithm names that are treated as center-pays for the purpose of the billing report

Returns: The centerGears of this ConfigSiteSettingsInput.
Return type: vector[char]

providers¶

Gets the providers of this ConfigSiteSettingsInput.

Returns: The providers of this ConfigSiteSettingsInput.
Return type: ProviderLinks

viewerApps¶

A list of viewer app associations for files and container

Returns: The viewerApps of this ConfigSiteSettingsInput.
Return type: ViewerApp

ldapSync¶

Gets the ldapSync of this ConfigSiteSettingsInput.

Returns: The ldapSync of this ConfigSiteSettingsInput.
Return type: LdapSync

ContainerNewOutput¶

class ContainerNewOutput¶

id¶

Unique database ID

Returns: The id of this ContainerNewOutput.
Return type: char

ContainerOutput¶

Generic container output

class ContainerOutput¶

Generic container output

containerType¶

Gets the containerType of this ContainerOutput.

Returns: The containerType of this ContainerOutput.
Return type: char

ContainerOutputWithFiles¶

Generic container output with files

class ContainerOutputWithFiles¶

Generic container output with files

id¶

Unique database ID

Returns: The id of this ContainerOutputWithFiles.
Return type: char

label¶

Application-specific label

Returns: The label of this ContainerOutputWithFiles.
Return type: char

files¶

Gets the files of this ContainerOutputWithFiles.

Returns: The files of this ContainerOutputWithFiles.
Return type: FileEntry

created¶

Creation time (automatically set)

Returns: The created of this ContainerOutputWithFiles.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerOutputWithFiles.
Return type: datetime

ContainerParents¶

class ContainerParents¶

analysis¶

Unique database ID

Returns: The analysis of this ContainerParents.
Return type: char

acquisition¶

Unique database ID

Returns: The acquisition of this ContainerParents.
Return type: char

session¶

Unique database ID

Returns: The session of this ContainerParents.
Return type: char

subject¶

Unique database ID

Returns: The subject of this ContainerParents.
Return type: char

project¶

Unique database ID

Returns: The project of this ContainerParents.
Return type: char

group¶

Unique database ID

Returns: The group of this ContainerParents.
Return type: char

ContainerReference¶

A reference to an individual container, by type and id

class ContainerReference¶

A reference to an individual container, by type and id

type¶

The type of container (e.g. session)

Returns: The type of this ContainerReference.
Return type: char

id¶

Unique database ID

Returns: The id of this ContainerReference.
Return type: char

ContainerUidcheck¶

Input for checking the existence of UIDs

class ContainerUidcheck¶

Input for checking the existence of UIDs

sessions¶

A list of UIDs

Returns: The sessions of this ContainerUidcheck.
Return type: vector[char]

acquisitions¶

A list of UIDs

Returns: The acquisitions of this ContainerUidcheck.
Return type: vector[char]

projectId¶

Unique database ID

Returns: The projectId of this ContainerUidcheck.
Return type: char

projectIds¶

A list of Project IDs

Returns: The projectIds of this ContainerUidcheck.
Return type: vector[char]

ContainerUpdate¶

Generic input, should be validated by the correct schema later on

class ContainerUpdate¶: Generic input, should be validated by the correct schema later on

DataView¶

Specifies a flattened view of the flywheel hierarchy, possibly including files.

class DataView¶

Specifies a flattened view of the flywheel hierarchy, possibly including files.

parent¶

The parent container id

Returns: The parent of this DataView.
Return type: char

label¶

Application-specific label

Returns: The label of this DataView.
Return type: char

description¶

Gets the description of this DataView.

Returns: The description of this DataView.
Return type: char

columns¶

Gets the columns of this DataView.

Returns: The columns of this DataView.
Return type: DataViewColumnSpec

fileSpec¶

Gets the fileSpec of this DataView.

Returns: The fileSpec of this DataView.
Return type: DataViewFileSpec

includeIds¶

Whether or not to include container id fields. Default is true

Returns: The includeIds of this DataView.
Return type: logical

includeLabels¶

Whether or not to include container label fields. Default is true

Returns: The includeLabels of this DataView.
Return type: logical

missingDataStrategy¶

What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.

Returns: The missingDataStrategy of this DataView.
Return type: char

sort¶

Opt out of sorting results by setting value to false

Returns: The sort of this DataView.
Return type: logical

id¶

Unique database ID

Returns: The id of this DataView.
Return type: char

origin¶

Gets the origin of this DataView.

Returns: The origin of this DataView.
Return type: Origin

DataViewAnalysisFilterSpec¶

Specifies which analyses to match for files

class DataViewAnalysisFilterSpec¶

Specifies which analyses to match for files

label¶

Gets the label of this DataViewAnalysisFilterSpec.

Returns: The label of this DataViewAnalysisFilterSpec.
Return type: DataViewNameFilterSpec

gearName¶

Gets the gearName of this DataViewAnalysisFilterSpec.

Returns: The gearName of this DataViewAnalysisFilterSpec.
Return type: DataViewNameFilterSpec

gearVersion¶

Gets the gearVersion of this DataViewAnalysisFilterSpec.

Returns: The gearVersion of this DataViewAnalysisFilterSpec.
Return type: DataViewNameFilterSpec

DataViewColumnAlias¶

Represents a column alias for use in data views. Maps from src to name.

class DataViewColumnAlias¶

Represents a column alias for use in data views. Maps from src to name.

name¶

The column alias name

Returns: The name of this DataViewColumnAlias.
Return type: char

src¶

The source for this column’s data

Returns: The src of this DataViewColumnAlias.
Return type: char

group¶

The list of columns that belong to this group

Returns: The group of this DataViewColumnAlias.
Return type: vector[char]

description¶

A description of this field

Returns: The description of this DataViewColumnAlias.
Return type: char

type¶

The type that this value should be translated to (for typed output)

Returns: The type of this DataViewColumnAlias.
Return type: char

DataViewColumnSpec¶

Describe a column that should belong to the view

class DataViewColumnSpec¶

Describe a column that should belong to the view

src¶

The source property in the format of {container}.{field}

Returns: The src of this DataViewColumnSpec.
Return type: char

dst¶

The optional destination property name

Returns: The dst of this DataViewColumnSpec.
Return type: char

type¶

The type that this value should be translated to (for typed output)

Returns: The type of this DataViewColumnSpec.
Return type: char

expr¶

An optional expression, allowing simple calculations (add, subtract, multiply, divide). Use ‘x’ to substitute the column

Returns: The expr of this DataViewColumnSpec.
Return type: char

DataViewFileSpec¶

Specifies a file to be processed, including filename matching and parsing options

class DataViewFileSpec¶

Specifies a file to be processed, including filename matching and parsing options

container¶

The type of container (e.g. session)

Returns: The container of this DataViewFileSpec.
Return type: char

analysisFilter¶

Gets the analysisFilter of this DataViewFileSpec.

Returns: The analysisFilter of this DataViewFileSpec.
Return type: DataViewAnalysisFilterSpec

filter¶

Gets the filter of this DataViewFileSpec.

Returns: The filter of this DataViewFileSpec.
Return type: DataViewNameFilterSpec

zipMember¶

Gets the zipMember of this DataViewFileSpec.

Returns: The zipMember of this DataViewFileSpec.
Return type: DataViewZipFilterSpec

match¶

If multiple file matches are encountered, which file to choose. Default is first

Returns: The match of this DataViewFileSpec.
Return type: char

format¶

The expected data file format, default is auto-detect

Returns: The format of this DataViewFileSpec.
Return type: char

formatOptions¶

Gets the formatOptions of this DataViewFileSpec.

Returns: The formatOptions of this DataViewFileSpec.
Return type: containers.Map

processFiles¶

Set to false to skip file reading, and return file attributes instead

Returns: The processFiles of this DataViewFileSpec.
Return type: logical

columns¶

Gets the columns of this DataViewFileSpec.

Returns: The columns of this DataViewFileSpec.
Return type: DataViewColumnSpec

DataViewNameFilterSpec¶

Specifies either a pattern match or regular expression match string filter

class DataViewNameFilterSpec¶

Specifies either a pattern match or regular expression match string filter

value¶

The pattern or regular expression to match

Returns: The value of this DataViewNameFilterSpec.
Return type: char

regex¶

Whether or not this filter is a pattern or regular expression match

Returns: The regex of this DataViewNameFilterSpec.
Return type: logical

DataViewSaveDataViewInput¶

A request to save data-view data to a container

class DataViewSaveDataViewInput¶

A request to save data-view data to a container

view¶

Gets the view of this DataViewSaveDataViewInput.

Returns: The view of this DataViewSaveDataViewInput.
Return type: DataView

viewId¶

Unique database ID

Returns: The viewId of this DataViewSaveDataViewInput.
Return type: char

containerType¶

The type of container (e.g. session)

Returns: The containerType of this DataViewSaveDataViewInput.
Return type: char

containerId¶

Unique database ID

Returns: The containerId of this DataViewSaveDataViewInput.
Return type: char

filename¶

The name of the file on disk

Returns: The filename of this DataViewSaveDataViewInput.
Return type: char

description¶

Gets the description of this DataViewSaveDataViewInput.

Returns: The description of this DataViewSaveDataViewInput.
Return type: char

DataViewZipFilterSpec¶

Specifies filters for zip members.

class DataViewZipFilterSpec¶

Specifies filters for zip members.

value¶

The pattern or regular expression to match

Returns: The value of this DataViewZipFilterSpec.
Return type: char

regex¶

Whether or not this filter is a pattern or regular expression match

Returns: The regex of this DataViewZipFilterSpec.
Return type: logical

match¶

If multiple file matches are encountered, which file to choose. Default is first

Returns: The match of this DataViewZipFilterSpec.
Return type: char

Device¶

class Device¶

id¶

Unique database ID

Returns: The id of this Device.
Return type: char

label¶

Gets the label of this Device.

Returns: The label of this Device.
Return type: char

type¶

Gets the type of this Device.

Returns: The type of this Device.
Return type: char

version¶

Gets the version of this Device.

Returns: The version of this Device.
Return type: char

name¶

Gets the name of this Device.

Returns: The name of this Device.
Return type: char

key¶

Gets the key of this Device.

Returns: The key of this Device.
Return type: char

errors¶

Gets the errors of this Device.

Returns: The errors of this Device.
Return type: vector[char]

info¶

Gets the info of this Device.

Returns: The info of this Device.
Return type: CommonInfo

interval¶

Gets the interval of this Device.

Returns: The interval of this Device.
Return type: integer

lastSeen¶

Gets the lastSeen of this Device.

Returns: The lastSeen of this Device.
Return type: datetime

disabled¶

Gets the disabled of this Device.

Returns: The disabled of this Device.
Return type: logical

DeviceStatus¶

class DeviceStatus¶

DeviceStatusEntry¶

class DeviceStatusEntry¶

errors¶

Gets the errors of this DeviceStatusEntry.

Returns: The errors of this DeviceStatusEntry.
Return type: vector[char]

lastSeen¶

Gets the lastSeen of this DeviceStatusEntry.

Returns: The lastSeen of this DeviceStatusEntry.
Return type: datetime

status¶

Gets the status of this DeviceStatusEntry.

Returns: The status of this DeviceStatusEntry.
Return type: char

DimseProjectInput¶

class DimseProjectInput¶

aet¶

DICOM Application Entity Title

Returns: The aet of this DimseProjectInput.
Return type: char

projectId¶

Unique database ID

Returns: The projectId of this DimseProjectInput.
Return type: char

DimseProjectOutput¶

class DimseProjectOutput¶

id¶

Unique database ID

Returns: The id of this DimseProjectOutput.
Return type: char

created¶

Gets the created of this DimseProjectOutput.

Returns: The created of this DimseProjectOutput.
Return type: datetime

creator¶

Database ID of a user

Returns: The creator of this DimseProjectOutput.
Return type: char

aet¶

DICOM Application Entity Title

Returns: The aet of this DimseProjectOutput.
Return type: char

projectId¶

Unique database ID

Returns: The projectId of this DimseProjectOutput.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this DimseProjectOutput.
Return type: char

port¶

DICOM service port number

Returns: The port of this DimseProjectOutput.
Return type: integer

DimseServiceInput¶

class DimseServiceInput¶

aet¶

DICOM Application Entity Title

Returns: The aet of this DimseServiceInput.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this DimseServiceInput.
Return type: char

port¶

DICOM service port number

Returns: The port of this DimseServiceInput.
Return type: integer

DimseServiceOutput¶

class DimseServiceOutput¶

id¶

Unique database ID

Returns: The id of this DimseServiceOutput.
Return type: char

created¶

Gets the created of this DimseServiceOutput.

Returns: The created of this DimseServiceOutput.
Return type: datetime

creator¶

Database ID of a user

Returns: The creator of this DimseServiceOutput.
Return type: char

aet¶

DICOM Application Entity Title

Returns: The aet of this DimseServiceOutput.
Return type: char

host¶

DICOM service hostname or IP

Returns: The host of this DimseServiceOutput.
Return type: char

port¶

DICOM service port number

Returns: The port of this DimseServiceOutput.
Return type: integer

Download¶

Specifies a set of files to download

class Download¶

Specifies a set of files to download

optional¶

Gets the optional of this Download.

Returns: The optional of this Download.
Return type: logical

nodes¶

Gets the nodes of this Download.

Returns: The nodes of this Download.
Return type: DownloadNode

containerFilters¶

Gets the containerFilters of this Download.

Returns: The containerFilters of this Download.
Return type: DownloadContainerFilter

filters¶

Gets the filters of this Download.

Returns: The filters of this Download.
Return type: DownloadFilter

DownloadContainerFilter¶

class DownloadContainerFilter¶

tags¶

Gets the tags of this DownloadContainerFilter.

Returns: The tags of this DownloadContainerFilter.
Return type: DownloadContainerFilterDefinition

DownloadContainerFilterDefinition¶

class DownloadContainerFilterDefinition¶

type¶

Gets the type of this DownloadContainerFilterDefinition.

Returns: The type of this DownloadContainerFilterDefinition.
Return type: char

plus¶

A list of items to include or exclude from a download

Returns: The plus of this DownloadContainerFilterDefinition.
Return type: vector[char]

minus¶

A list of items to include or exclude from a download

Returns: The minus of this DownloadContainerFilterDefinition.
Return type: vector[char]

DownloadFilter¶

class DownloadFilter¶

tags¶

Gets the tags of this DownloadFilter.

Returns: The tags of this DownloadFilter.
Return type: DownloadFilterDefinition

types¶

Gets the types of this DownloadFilter.

Returns: The types of this DownloadFilter.
Return type: DownloadFilterDefinition

since¶

Gets the since of this DownloadFilter.

Returns: The since of this DownloadFilter.
Return type: float

DownloadFilterDefinition¶

class DownloadFilterDefinition¶

plus¶

A list of items to include or exclude from a download

Returns: The plus of this DownloadFilterDefinition.
Return type: vector[char]

minus¶

A list of items to include or exclude from a download

Returns: The minus of this DownloadFilterDefinition.
Return type: vector[char]

DownloadInput¶

Specifies a set of files to download

class DownloadInput¶

Specifies a set of files to download

optional¶

Gets the optional of this DownloadInput.

Returns: The optional of this DownloadInput.
Return type: logical

nodes¶

Gets the nodes of this DownloadInput.

Returns: The nodes of this DownloadInput.
Return type: DownloadNode

containerFilters¶

Gets the containerFilters of this DownloadInput.

Returns: The containerFilters of this DownloadInput.
Return type: DownloadContainerFilter

filters¶

Gets the filters of this DownloadInput.

Returns: The filters of this DownloadInput.
Return type: DownloadFilter

DownloadNode¶

A reference to a container

class DownloadNode¶

A reference to a container

level¶

Gets the level of this DownloadNode.

Returns: The level of this DownloadNode.
Return type: char

id¶

Gets the id of this DownloadNode.

Returns: The id of this DownloadNode.
Return type: char

DownloadTicket¶

A ticket for non-authenticated download of files

class DownloadTicket¶

A ticket for non-authenticated download of files

ticket¶

The ticket to use to perform the actual download

Returns: The ticket of this DownloadTicket.
Return type: char

DownloadTicketWithSummary¶

A ticket for non-authenticated download of files, including a summary

class DownloadTicketWithSummary¶

A ticket for non-authenticated download of files, including a summary

ticket¶

The ticket to use to perform the actual download

Returns: The ticket of this DownloadTicketWithSummary.
Return type: char

fileCnt¶

The number of files that will be included in the download

Returns: The fileCnt of this DownloadTicketWithSummary.
Return type: integer

size¶

An estimated total number of bytes that will be downloaded

Returns: The size of this DownloadTicketWithSummary.
Return type: integer

EnginemetadataEngineUploadInput¶

class EnginemetadataEngineUploadInput¶

project¶

Gets the project of this EnginemetadataEngineUploadInput.

Returns: The project of this EnginemetadataEngineUploadInput.
Return type: ProjectMetadataInput

subject¶

Gets the subject of this EnginemetadataEngineUploadInput.

Returns: The subject of this EnginemetadataEngineUploadInput.
Return type: SubjectMetadataInput

session¶

Gets the session of this EnginemetadataEngineUploadInput.

Returns: The session of this EnginemetadataEngineUploadInput.
Return type: SessionMetadataInput

acquisition¶

Gets the acquisition of this EnginemetadataEngineUploadInput.

Returns: The acquisition of this EnginemetadataEngineUploadInput.
Return type: AcquisitionMetadataInput

EnginemetadataLabelUploadInput¶

class EnginemetadataLabelUploadInput¶

group¶

Gets the group of this EnginemetadataLabelUploadInput.

Returns: The group of this EnginemetadataLabelUploadInput.
Return type: GroupMetadataInput

project¶

Gets the project of this EnginemetadataLabelUploadInput.

Returns: The project of this EnginemetadataLabelUploadInput.
Return type: ProjectMetadataInput

session¶

Gets the session of this EnginemetadataLabelUploadInput.

Returns: The session of this EnginemetadataLabelUploadInput.
Return type: SessionMetadataInput

acquisition¶

Gets the acquisition of this EnginemetadataLabelUploadInput.

Returns: The acquisition of this EnginemetadataLabelUploadInput.
Return type: EnginemetadataUploadAcquisitionMetadataInput

EnginemetadataUidMatchUploadInput¶

class EnginemetadataUidMatchUploadInput¶

project¶

Gets the project of this EnginemetadataUidMatchUploadInput.

Returns: The project of this EnginemetadataUidMatchUploadInput.
Return type: ProjectMetadataInput

session¶

Gets the session of this EnginemetadataUidMatchUploadInput.

Returns: The session of this EnginemetadataUidMatchUploadInput.
Return type: SessionMetadataInput

acquisition¶

Gets the acquisition of this EnginemetadataUidMatchUploadInput.

Returns: The acquisition of this EnginemetadataUidMatchUploadInput.
Return type: EnginemetadataUploadAcquisitionMetadataInput

EnginemetadataUidUploadInput¶

class EnginemetadataUidUploadInput¶

group¶

Gets the group of this EnginemetadataUidUploadInput.

Returns: The group of this EnginemetadataUidUploadInput.
Return type: GroupMetadataInput

project¶

Gets the project of this EnginemetadataUidUploadInput.

Returns: The project of this EnginemetadataUidUploadInput.
Return type: ProjectMetadataInput

session¶

Gets the session of this EnginemetadataUidUploadInput.

Returns: The session of this EnginemetadataUidUploadInput.
Return type: SessionMetadataInput

acquisition¶

Gets the acquisition of this EnginemetadataUidUploadInput.

Returns: The acquisition of this EnginemetadataUidUploadInput.
Return type: EnginemetadataUploadAcquisitionMetadataInput

EnginemetadataUploadAcquisitionMetadataInput¶

class EnginemetadataUploadAcquisitionMetadataInput¶

label¶

Gets the label of this EnginemetadataUploadAcquisitionMetadataInput.

Returns: The label of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: char

info¶

Gets the info of this EnginemetadataUploadAcquisitionMetadataInput.

Returns: The info of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: containers.Map

uid¶

Gets the uid of this EnginemetadataUploadAcquisitionMetadataInput.

Returns: The uid of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: char

timestamp¶

Gets the timestamp of this EnginemetadataUploadAcquisitionMetadataInput.

Returns: The timestamp of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: datetime

timezone¶

Gets the timezone of this EnginemetadataUploadAcquisitionMetadataInput.

Returns: The timezone of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: char

files¶

Gets the files of this EnginemetadataUploadAcquisitionMetadataInput.

Returns: The files of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: FileEntry

tags¶

Array of application-specific tags

Returns: The tags of this EnginemetadataUploadAcquisitionMetadataInput.
Return type: vector[char]

FileEntry¶

A file description

class FileEntry¶

A file description

id¶

Gets the id of this FileEntry.

Returns: The id of this FileEntry.
Return type: char

fileId¶

Unique database ID

Returns: The fileId of this FileEntry.
Return type: char

version¶

Version of the file

Returns: The version of this FileEntry.
Return type: integer

name¶

The name of the file on disk

Returns: The name of this FileEntry.
Return type: char

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this FileEntry.
Return type: char

mimetype¶

A MIME Content-Type of the file

Returns: The mimetype of this FileEntry.
Return type: char

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this FileEntry.
Return type: char

deidLogId¶

The UUID of the de-id log

Returns: The deidLogId of this FileEntry.
Return type: char

classification¶

Gets the classification of this FileEntry.

Returns: The classification of this FileEntry.
Return type: CommonClassification

tags¶

Array of application-specific tags

Returns: The tags of this FileEntry.
Return type: vector[char]

info¶

Gets the info of this FileEntry.

Returns: The info of this FileEntry.
Return type: CommonInfo

origin¶

Gets the origin of this FileEntry.

Returns: The origin of this FileEntry.
Return type: FileOrigin

hash¶

Cryptographic hash of the file

Returns: The hash of this FileEntry.
Return type: char

parents¶

Gets the parents of this FileEntry.

Returns: The parents of this FileEntry.
Return type: ContainerParents

parentRef¶

Gets the parentRef of this FileEntry.

Returns: The parentRef of this FileEntry.
Return type: ContainerReference

providerId¶

Unique database ID

Returns: The providerId of this FileEntry.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this FileEntry.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this FileEntry.
Return type: datetime

replaced¶

Last replaced time (automatically updated)

Returns: The replaced of this FileEntry.
Return type: datetime

size¶

Size of the file, in bytes

Returns: The size of this FileEntry.
Return type: integer

infoExists¶

Gets the infoExists of this FileEntry.

Returns: The infoExists of this FileEntry.
Return type: logical

zipMemberCount¶

Number of entries in the zip archive

Returns: The zipMemberCount of this FileEntry.
Return type: integer

FileOrigin¶

class FileOrigin¶

id¶

Database ID of joined name and method

Returns: The id of this FileOrigin.
Return type: char

method¶

Method of file origin

Returns: The method of this FileOrigin.
Return type: char

type¶

Type of file origin (e.g. device, user, job)

Returns: The type of this FileOrigin.
Return type: char

name¶

Name of device, user or job that originated the file

Returns: The name of this FileOrigin.
Return type: char

via¶

Gets the via of this FileOrigin.

Returns: The via of this FileOrigin.
Return type: FileVia

FileReference¶

A reference to an individual file in a container, by type, id and name

class FileReference¶

A reference to an individual file in a container, by type, id and name

type¶

The type of container (e.g. session)

Returns: The type of this FileReference.
Return type: char

id¶

Unique database ID

Returns: The id of this FileReference.
Return type: char

name¶

The name of the file on disk

Returns: The name of this FileReference.
Return type: char

FileVersionOutput¶

Used by frontend to display all versions of a file

class FileVersionOutput¶

Used by frontend to display all versions of a file

created¶

Creation time (automatically set)

Returns: The created of this FileVersionOutput.
Return type: datetime

deleted¶

Deleted time (automatically set on delete)

Returns: The deleted of this FileVersionOutput.
Return type: datetime

fileId¶

Unique database ID

Returns: The fileId of this FileVersionOutput.
Return type: char

origin¶

Gets the origin of this FileVersionOutput.

Returns: The origin of this FileVersionOutput.
Return type: FileOrigin

version¶

Gets the version of this FileVersionOutput.

Returns: The version of this FileVersionOutput.
Return type: integer

FileVia¶

class FileVia¶

id¶

Gets the id of this FileVia.

Returns: The id of this FileVia.
Return type: char

method¶

Gets the method of this FileVia.

Returns: The method of this FileVia.
Return type: char

type¶

Gets the type of this FileVia.

Returns: The type of this FileVia.
Return type: char

name¶

Gets the name of this FileVia.

Returns: The name of this FileVia.
Return type: char

FileZipEntry¶

A zip member description

class FileZipEntry¶

A zip member description

comment¶

Gets the comment of this FileZipEntry.

Returns: The comment of this FileZipEntry.
Return type: char

path¶

Gets the path of this FileZipEntry.

Returns: The path of this FileZipEntry.
Return type: char

timestamp¶

Gets the timestamp of this FileZipEntry.

Returns: The timestamp of this FileZipEntry.
Return type: datetime

size¶

Size of the file, in bytes

Returns: The size of this FileZipEntry.
Return type: integer

FileZipInfo¶

Zip file information

class FileZipInfo¶

Zip file information

comment¶

Gets the comment of this FileZipInfo.

Returns: The comment of this FileZipInfo.
Return type: char

members¶

Gets the members of this FileZipInfo.

Returns: The members of this FileZipInfo.
Return type: FileZipEntry

Gear¶

Gear manifest

class Gear¶

Gear manifest

author¶

The author of this gear.

Returns: The author of this Gear.
Return type: char

maintainer¶

(optional) The maintainer of this gear. Can be used to distinguish the algorithm author from the gear maintainer.

Returns: The maintainer of this Gear.
Return type: char

cite¶

(optional) Any citations relevant to the algorithm(s) or work present in the gear.

Returns: The cite of this Gear.
Return type: char

config¶

Gets the config of this Gear.

Returns: The config of this Gear.
Return type: GearConfig

custom¶

Gets the custom of this Gear.

Returns: The custom of this Gear.
Return type: GearCustom

description¶

A brief description of the gear’s purpose. Ideally 1-4 sentences.

Returns: The description of this Gear.
Return type: char

environment¶

Gets the environment of this Gear.

Returns: The environment of this Gear.
Return type: GearEnvironment

command¶

If provided, the starting command for the gear, rather than /flywheel/v0/run. Will be templated according to the spec.

Returns: The command of this Gear.
Return type: char

inputs¶

Gets the inputs of this Gear.

Returns: The inputs of this Gear.
Return type: GearInputs

label¶

The human-friendly name of this gear.

Returns: The label of this Gear.
Return type: char

license¶

Software license of the gear

Returns: The license of this Gear.
Return type: char

name¶

The identification of this gear.

Returns: The name of this Gear.
Return type: char

source¶

A valid URI, or empty string.

Returns: The source of this Gear.
Return type: char

url¶

A valid URI, or empty string.

Returns: The url of this Gear.
Return type: char

version¶

A human-friendly string explaining the release version of this gear. Example: 3.2.1

Returns: The version of this Gear.
Return type: char

GearConfig¶

Schema snippets describing the options this gear consumes. Not currently processed.

class GearConfig¶: Schema snippets describing the options this gear consumes. Not currently processed.

GearContextLookup¶

Describes a gear input

class GearContextLookup¶: Describes a gear input

GearContextLookupItem¶

class GearContextLookupItem¶

found¶

Was the context value found?

Returns: The found of this GearContextLookupItem.
Return type: logical

containerType¶

The type of container (e.g. session)

Returns: The containerType of this GearContextLookupItem.
Return type: char

id¶

Id of the container where the context value was found, if any.

Returns: The id of this GearContextLookupItem.
Return type: char

label¶

Label of the container where the context value was found, if any.

Returns: The label of this GearContextLookupItem.
Return type: char

value¶

The value if found. Valid IFF found is true. Can be null.

Returns: The value of this GearContextLookupItem.
Return type: containers.Map

GearCustom¶

A place for gear authors to put arbitrary information.

class GearCustom¶: A place for gear authors to put arbitrary information.

GearDirective¶

A schema directive.

class GearDirective¶: A schema directive.

GearDoc¶

A full gear description, including manifest and exchange information

class GearDoc¶

A full gear description, including manifest and exchange information

id¶

Unique database ID

Returns: The id of this GearDoc.
Return type: char

category¶

The gear category

Returns: The category of this GearDoc.
Return type: char

gear¶

Gets the gear of this GearDoc.

Returns: The gear of this GearDoc.
Return type: Gear

exchange¶

Gets the exchange of this GearDoc.

Returns: The exchange of this GearDoc.
Return type: GearExchange

created¶

Creation time (automatically set)

Returns: The created of this GearDoc.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this GearDoc.
Return type: datetime

GearEnvironment¶

Environment variables that should be set for the gear.

class GearEnvironment¶: Environment variables that should be set for the gear.

GearExchange¶

Metadata object that describes the origin of a gear version

class GearExchange¶

Metadata object that describes the origin of a gear version

gitCommit¶

The SHA-1 hash referring to the git commit

Returns: The gitCommit of this GearExchange.
Return type: char

rootfsHash¶

The cryptographic hash of the root filesystem in the form of “algorithm:<base16 hash>”

Returns: The rootfsHash of this GearExchange.
Return type: char

rootfsUrl¶

The absolute URL of the gear’s root file system

Returns: The rootfsUrl of this GearExchange.
Return type: char

GearInfo¶

Optional information about a gear

class GearInfo¶

Optional information about a gear

id¶

Gets the id of this GearInfo.

Returns: The id of this GearInfo.
Return type: char

category¶

The gear category

Returns: The category of this GearInfo.
Return type: char

name¶

The identification of this gear.

Returns: The name of this GearInfo.
Return type: char

version¶

A human-friendly string explaining the release version of this gear. Example: 3.2.1

Returns: The version of this GearInfo.
Return type: char

GearInputItem¶

Describes a gear input

class GearInputItem¶

Describes a gear input

base¶

The type of gear input.

Returns: The base of this GearInputItem.
Return type: char

description¶

Hackaround for description not technically being a schema directive

Returns: The description of this GearInputItem.
Return type: char

optional¶

Allow the gear to mark an input file as optional.

Returns: The optional of this GearInputItem.
Return type: logical

GearInputs¶

Schema snippets describing the inputs this gear consumes.

class GearInputs¶: Schema snippets describing the inputs this gear consumes.

Group¶

class Group¶

id¶

Gets the id of this Group.

Returns: The id of this Group.
Return type: char

label¶

The group label

Returns: The label of this Group.
Return type: char

permissionsTemplate¶

Gets the permissionsTemplate of this Group.

Returns: The permissionsTemplate of this Group.
Return type: RolesRoleAssignment

roles¶

Gets the roles of this Group.

Returns: The roles of this Group.
Return type: vector[char]

permissions¶

Gets the permissions of this Group.

Returns: The permissions of this Group.
Return type: PermissionAccessPermission

created¶

Creation time (automatically set)

Returns: The created of this Group.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Group.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this Group.
Return type: integer

tags¶

Array of application-specific tags

Returns: The tags of this Group.
Return type: vector[char]

providers¶

Gets the providers of this Group.

Returns: The providers of this Group.
Return type: ProviderLinks

editions¶

Gets the editions of this Group.

Returns: The editions of this Group.
Return type: CommonEditions

GroupMetadataInput¶

class GroupMetadataInput¶

id¶

Gets the id of this GroupMetadataInput.

Returns: The id of this GroupMetadataInput.
Return type: char

label¶

Gets the label of this GroupMetadataInput.

Returns: The label of this GroupMetadataInput.
Return type: char

GroupNewOutput¶

class GroupNewOutput¶

id¶

Gets the id of this GroupNewOutput.

Returns: The id of this GroupNewOutput.
Return type: char

InfoAddRemove¶

Indicates properties to update and a list of properties to remove

class InfoAddRemove¶

Indicates properties to update and a list of properties to remove

set¶

Key/value pairs of properties to set

Returns: The set of this InfoAddRemove.
Return type: containers.Map

delete¶

A list of properties to remove

Returns: The delete of this InfoAddRemove.
Return type: vector[char]

InfoReplace¶

Indicates that info should be replaced with the properties in this document

class InfoReplace¶

Indicates that info should be replaced with the properties in this document

replace¶

The new set of properties for the info

Returns: The replace of this InfoReplace.
Return type: containers.Map

InfoUpdateInput¶

Helper endpoint for editing an object’s info key

class InfoUpdateInput¶

Helper endpoint for editing an object’s info key

set¶

Key/value pairs of properties to set

Returns: The set of this InfoUpdateInput.
Return type: containers.Map

delete¶

A list of properties to remove

Returns: The delete of this InfoUpdateInput.
Return type: vector[char]

replace¶

The new set of properties for the info

Returns: The replace of this InfoUpdateInput.
Return type: containers.Map

InlineResponse200¶

class InlineResponse200¶

modified¶

Gets the modified of this InlineResponse200.

Returns: The modified of this InlineResponse200.
Return type: integer

InlineResponse2001¶

class InlineResponse2001¶

key¶

Gets the key of this InlineResponse2001.

Returns: The key of this InlineResponse2001.
Return type: char

InlineResponse2002¶

class InlineResponse2002¶

deleted¶

Gets the deleted of this InlineResponse2002.

Returns: The deleted of this InlineResponse2002.
Return type: integer

InlineResponse2003¶

class InlineResponse2003¶

id¶

Database ID of a user

Returns: The id of this InlineResponse2003.
Return type: char

roleIds¶

Gets the roleIds of this InlineResponse2003.

Returns: The roleIds of this InlineResponse2003.
Return type: vector[char]

access¶

Gets the access of this InlineResponse2003.

Returns: The access of this InlineResponse2003.
Return type: char

InlineResponse2004¶

class InlineResponse2004¶

firstname¶

First name

Returns: The firstname of this InlineResponse2004.
Return type: char

lastname¶

Last name

Returns: The lastname of this InlineResponse2004.
Return type: char

id¶

Database ID of a user

Returns: The id of this InlineResponse2004.
Return type: char

InlineResponse2005¶

class InlineResponse2005¶

modified¶

Gets the modified of this InlineResponse2005.

Returns: The modified of this InlineResponse2005.
Return type: integer

jobsSpawned¶

Gets the jobsSpawned of this InlineResponse2005.

Returns: The jobsSpawned of this InlineResponse2005.
Return type: integer

Job¶

class Job¶

id¶

Unique database ID

Returns: The id of this Job.
Return type: char

origin¶

Gets the origin of this Job.

Returns: The origin of this Job.
Return type: JobOrigin

gearId¶

Gets the gearId of this Job.

Returns: The gearId of this Job.
Return type: char

gearInfo¶

Gets the gearInfo of this Job.

Returns: The gearInfo of this Job.
Return type: GearInfo

previousJobId¶

Gets the previousJobId of this Job.

Returns: The previousJobId of this Job.
Return type: char

inputs¶

Gets the inputs of this Job.

Returns: The inputs of this Job.
Return type: JobInputsObject

destination¶

Gets the destination of this Job.

Returns: The destination of this Job.
Return type: JobDestination

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this Job.
Return type: char

group¶

Gets the group of this Job.

Returns: The group of this Job.
Return type: char

project¶

Unique database ID

Returns: The project of this Job.
Return type: char

tags¶

Gets the tags of this Job.

Returns: The tags of this Job.
Return type: vector[char]

state¶

Gets the state of this Job.

Returns: The state of this Job.
Return type: char

failureReason¶

An optional suspected reason for job failure

Returns: The failureReason of this Job.
Return type: char

attempt¶

Gets the attempt of this Job.

Returns: The attempt of this Job.
Return type: integer

created¶

Creation time (automatically set)

Returns: The created of this Job.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Job.
Return type: datetime

retried¶

Retried time (automatically set)

Returns: The retried of this Job.
Return type: datetime

config¶

Gets the config of this Job.

Returns: The config of this Job.
Return type: JobConfig

transitions¶

Gets the transitions of this Job.

Returns: The transitions of this Job.
Return type: JobTransitionTimes

request¶

Gets the request of this Job.

Returns: The request of this Job.
Return type: JobRequest

savedFiles¶

Gets the savedFiles of this Job.

Returns: The savedFiles of this Job.
Return type: vector[char]

profile¶

Gets the profile of this Job.

Returns: The profile of this Job.
Return type: JobProfile

relatedContainerIds¶

The set of all related container ids

Returns: The relatedContainerIds of this Job.
Return type: vector[char]

label¶

Application-specific label

Returns: The label of this Job.
Return type: char

JobAsk¶

Describes how a job should be transitioned after outputs have been uploaded

class JobAsk¶

Describes how a job should be transitioned after outputs have been uploaded

whitelist¶

Properties that must match against jobs

Returns: The whitelist of this JobAsk.
Return type: JobConfigInputs

blacklist¶

Properties that must NOT match against jobs

Returns: The blacklist of this JobAsk.
Return type: JobConfigInputs

capabilities¶

A set of capabilities that must be a superset of matched jobs

Returns: The capabilities of this JobAsk.
Return type: vector[char]

xReturn¶

Which sorts of return values to receive from ask

Returns: The xReturn of this JobAsk.
Return type: JobAskReturn

JobAskResponse¶

Return based on job-ask-return type

class JobAskResponse¶

Return based on job-ask-return type

jobs¶

Gets the jobs of this JobAskResponse.

Returns: The jobs of this JobAskResponse.
Return type: Job

states¶

Gets the states of this JobAskResponse.

Returns: The states of this JobAskResponse.
Return type: JobStateCounts

JobAskReturn¶

Which sorts of return values to receive from ask

class JobAskReturn¶

Which sorts of return values to receive from ask

jobs¶

Gets the jobs of this JobAskReturn.

Returns: The jobs of this JobAskReturn.
Return type: integer

peek¶

Gets the peek of this JobAskReturn.

Returns: The peek of this JobAskReturn.
Return type: logical

states¶

Gets the states of this JobAskReturn.

Returns: The states of this JobAskReturn.
Return type: logical

encoded¶

Gets the encoded of this JobAskReturn.

Returns: The encoded of this JobAskReturn.
Return type: logical

JobAskState¶

Object describing the input for counting jobs that match the given query for a given state

class JobAskState¶

Object describing the input for counting jobs that match the given query for a given state

whitelist¶

Properties that must match against jobs

Returns: The whitelist of this JobAskState.
Return type: JobConfigInputs

blacklist¶

Properties that must NOT match against jobs

Returns: The blacklist of this JobAskState.
Return type: JobConfigInputs

capabilities¶

A set of capabilities that must be a superset of matched jobs

Returns: The capabilities of this JobAskState.
Return type: vector[char]

limit¶

Gets the limit of this JobAskState.

Returns: The limit of this JobAskState.
Return type: integer

JobAskStateResponse¶

Return number of jobs for a given state and query

class JobAskStateResponse¶

Return number of jobs for a given state and query

count¶

Gets the count of this JobAskStateResponse.

Returns: The count of this JobAskStateResponse.
Return type: integer

JobCompletionInput¶

Describes how a job should be transitioned after outputs have been uploaded

class JobCompletionInput¶

Describes how a job should be transitioned after outputs have been uploaded

success¶

Whether or not the job succeeded

Returns: The success of this JobCompletionInput.
Return type: logical

elapsed¶

The elapsed time of the job, in seconds

Returns: The elapsed of this JobCompletionInput.
Return type: integer

failureReason¶

An optional suspected reason for job failure

Returns: The failureReason of this JobCompletionInput.
Return type: char

profile¶

Gets the profile of this JobCompletionInput.

Returns: The profile of this JobCompletionInput.
Return type: JobProfileInput

JobCompletionTicket¶

A ticket for uploading files and completing a job

class JobCompletionTicket¶

A ticket for uploading files and completing a job

ticket¶

The ticket to use to perform file uploads to a job

Returns: The ticket of this JobCompletionTicket.
Return type: char

JobConfig¶

class JobConfig¶

JobConfigInputs¶

class JobConfigInputs¶

JobConfigOutput¶

class JobConfigOutput¶

config¶

Gets the config of this JobConfigOutput.

Returns: The config of this JobConfigOutput.
Return type: JobConfig

destination¶

Gets the destination of this JobConfigOutput.

Returns: The destination of this JobConfigOutput.
Return type: JobDestination

inputs¶

Gets the inputs of this JobConfigOutput.

Returns: The inputs of this JobConfigOutput.
Return type: JobConfigInputs

JobContainerDetail¶

class JobContainerDetail¶

id¶

Gets the id of this JobContainerDetail.

Returns: The id of this JobContainerDetail.
Return type: char

label¶

Application-specific label

Returns: The label of this JobContainerDetail.
Return type: char

JobDestination¶

class JobDestination¶

type¶

Gets the type of this JobDestination.

Returns: The type of this JobDestination.
Return type: char

id¶

Gets the id of this JobDestination.

Returns: The id of this JobDestination.
Return type: char

JobDetail¶

class JobDetail¶

id¶

Unique database ID

Returns: The id of this JobDetail.
Return type: char

origin¶

Gets the origin of this JobDetail.

Returns: The origin of this JobDetail.
Return type: JobOrigin

gearId¶

Gets the gearId of this JobDetail.

Returns: The gearId of this JobDetail.
Return type: char

gearInfo¶

Gets the gearInfo of this JobDetail.

Returns: The gearInfo of this JobDetail.
Return type: GearInfo

parentInfo¶

Gets the parentInfo of this JobDetail.

Returns: The parentInfo of this JobDetail.
Return type: JobDetailParentInfo

previousJobId¶

Gets the previousJobId of this JobDetail.

Returns: The previousJobId of this JobDetail.
Return type: char

inputs¶

Gets the inputs of this JobDetail.

Returns: The inputs of this JobDetail.
Return type: JobDetailInputsObject

outputs¶

Gets the outputs of this JobDetail.

Returns: The outputs of this JobDetail.
Return type: JobDetailFileEntry

destination¶

Gets the destination of this JobDetail.

Returns: The destination of this JobDetail.
Return type: JobDestination

tags¶

Gets the tags of this JobDetail.

Returns: The tags of this JobDetail.
Return type: vector[char]

state¶

Gets the state of this JobDetail.

Returns: The state of this JobDetail.
Return type: char

attempt¶

Gets the attempt of this JobDetail.

Returns: The attempt of this JobDetail.
Return type: integer

created¶

Creation time (automatically set)

Returns: The created of this JobDetail.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this JobDetail.
Return type: datetime

retried¶

Retried time (automatically set)

Returns: The retried of this JobDetail.
Return type: datetime

config¶

Gets the config of this JobDetail.

Returns: The config of this JobDetail.
Return type: JobConfig

request¶

Gets the request of this JobDetail.

Returns: The request of this JobDetail.
Return type: JobRequest

JobDetailFileEntry¶

class JobDetailFileEntry¶

ref¶

Gets the ref of this JobDetailFileEntry.

Returns: The ref of this JobDetailFileEntry.
Return type: FileReference

object¶

Gets the object of this JobDetailFileEntry.

Returns: The object of this JobDetailFileEntry.
Return type: FileEntry

JobDetailInputsObject¶

class JobDetailInputsObject¶

JobDetailParentInfo¶

class JobDetailParentInfo¶

group¶

Gets the group of this JobDetailParentInfo.

Returns: The group of this JobDetailParentInfo.
Return type: JobContainerDetail

project¶

Gets the project of this JobDetailParentInfo.

Returns: The project of this JobDetailParentInfo.
Return type: JobContainerDetail

subject¶

Gets the subject of this JobDetailParentInfo.

Returns: The subject of this JobDetailParentInfo.
Return type: JobContainerDetail

session¶

Gets the session of this JobDetailParentInfo.

Returns: The session of this JobDetailParentInfo.
Return type: JobContainerDetail

acquisition¶

Gets the acquisition of this JobDetailParentInfo.

Returns: The acquisition of this JobDetailParentInfo.
Return type: JobContainerDetail

analysis¶

Gets the analysis of this JobDetailParentInfo.

Returns: The analysis of this JobDetailParentInfo.
Return type: JobContainerDetail

JobExecutorInfo¶

class JobExecutorInfo¶

name¶

A machine or instance name, possibly a FQDN

Returns: The name of this JobExecutorInfo.
Return type: char

host¶

The hostname or (more likely) IP address of the engine instance

Returns: The host of this JobExecutorInfo.
Return type: char

instanceType¶

A free form string describing the instance type

Returns: The instanceType of this JobExecutorInfo.
Return type: char

cpuCores¶

The number of CPU cores

Returns: The cpuCores of this JobExecutorInfo.
Return type: integer

gpu¶

Whether or not a GPU is available

Returns: The gpu of this JobExecutorInfo.
Return type: logical

memoryBytes¶

The amount of memory on the system, in bytes

Returns: The memoryBytes of this JobExecutorInfo.
Return type: integer

diskBytes¶

The size of the hard disk on the system, in bytes

Returns: The diskBytes of this JobExecutorInfo.
Return type: integer

swapBytes¶

The available swap space, in bytes

Returns: The swapBytes of this JobExecutorInfo.
Return type: integer

JobGearMatch¶

An object describing characteristics to match on gears

class JobGearMatch¶

An object describing characteristics to match on gears

group¶

A set of groups that are in the hierarchy of an input or destination

Returns: The group of this JobGearMatch.
Return type: vector[char]

gearName¶

A set of gear.name matches

Returns: The gearName of this JobGearMatch.
Return type: vector[char]

tag¶

A set of job.tags matches

Returns: The tag of this JobGearMatch.
Return type: vector[char]

computeProvider¶

A set of compute providers to match

Returns: The computeProvider of this JobGearMatch.
Return type: vector[char]

JobInputsArrayItem¶

class JobInputsArrayItem¶

type¶

The type of container (e.g. session)

Returns: The type of this JobInputsArrayItem.
Return type: char

id¶

Unique database ID

Returns: The id of this JobInputsArrayItem.
Return type: char

name¶

The name of the file on disk

Returns: The name of this JobInputsArrayItem.
Return type: char

input¶

Gets the input of this JobInputsArrayItem.

Returns: The input of this JobInputsArrayItem.
Return type: char

base¶

Gets the base of this JobInputsArrayItem.

Returns: The base of this JobInputsArrayItem.
Return type: char

found¶

Gets the found of this JobInputsArrayItem.

Returns: The found of this JobInputsArrayItem.
Return type: logical

JobInputsItem¶

class JobInputsItem¶

type¶

Gets the type of this JobInputsItem.

Returns: The type of this JobInputsItem.
Return type: char

uri¶

Gets the uri of this JobInputsItem.

Returns: The uri of this JobInputsItem.
Return type: char

location¶

Gets the location of this JobInputsItem.

Returns: The location of this JobInputsItem.
Return type: char

vu¶

Gets the vu of this JobInputsItem.

Returns: The vu of this JobInputsItem.
Return type: char

JobInputsObject¶

class JobInputsObject¶

JobListEntry¶

class JobListEntry¶

id¶

Unique database ID

Returns: The id of this JobListEntry.
Return type: char

origin¶

Gets the origin of this JobListEntry.

Returns: The origin of this JobListEntry.
Return type: JobOrigin

gearId¶

Gets the gearId of this JobListEntry.

Returns: The gearId of this JobListEntry.
Return type: char

gearInfo¶

Gets the gearInfo of this JobListEntry.

Returns: The gearInfo of this JobListEntry.
Return type: GearInfo

previousJobId¶

Gets the previousJobId of this JobListEntry.

Returns: The previousJobId of this JobListEntry.
Return type: char

inputs¶

Gets the inputs of this JobListEntry.

Returns: The inputs of this JobListEntry.
Return type: JobInputsArrayItem

destination¶

Gets the destination of this JobListEntry.

Returns: The destination of this JobListEntry.
Return type: JobDestination

tags¶

Gets the tags of this JobListEntry.

Returns: The tags of this JobListEntry.
Return type: vector[char]

state¶

Gets the state of this JobListEntry.

Returns: The state of this JobListEntry.
Return type: char

attempt¶

Gets the attempt of this JobListEntry.

Returns: The attempt of this JobListEntry.
Return type: integer

created¶

Creation time (automatically set)

Returns: The created of this JobListEntry.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this JobListEntry.
Return type: datetime

retried¶

Retried time (automatically set)

Returns: The retried of this JobListEntry.
Return type: datetime

config¶

Gets the config of this JobListEntry.

Returns: The config of this JobListEntry.
Return type: JobConfig

request¶

Gets the request of this JobListEntry.

Returns: The request of this JobListEntry.
Return type: JobRequest

savedFiles¶

Gets the savedFiles of this JobListEntry.

Returns: The savedFiles of this JobListEntry.
Return type: vector[char]

JobLog¶

class JobLog¶

id¶

Unique database ID

Returns: The id of this JobLog.
Return type: char

logs¶

Gets the logs of this JobLog.

Returns: The logs of this JobLog.
Return type: JobLogStatement

JobLogStatement¶

class JobLogStatement¶

fd¶

Gets the fd of this JobLogStatement.

Returns: The fd of this JobLogStatement.
Return type: integer

msg¶

Gets the msg of this JobLogStatement.

Returns: The msg of this JobLogStatement.
Return type: char

JobOrigin¶

class JobOrigin¶

type¶

Gets the type of this JobOrigin.

Returns: The type of this JobOrigin.
Return type: char

id¶

Gets the id of this JobOrigin.

Returns: The id of this JobOrigin.
Return type: char

JobProfile¶

class JobProfile¶

totalInputFiles¶

The number of input files

Returns: The totalInputFiles of this JobProfile.
Return type: integer

totalInputSizeBytes¶

The combined size of all input files, in bytes

Returns: The totalInputSizeBytes of this JobProfile.
Return type: integer

totalOutputFiles¶

The number of output files

Returns: The totalOutputFiles of this JobProfile.
Return type: integer

totalOutputSizeBytes¶

The combined size of all output files, in bytes

Returns: The totalOutputSizeBytes of this JobProfile.
Return type: integer

preparationTimeMs¶

The length of time taken to download gear container and inputs, in milliseconds

Returns: The preparationTimeMs of this JobProfile.
Return type: integer

elapsedTimeMs¶

The runtime of the job, in milliseconds

Returns: The elapsedTimeMs of this JobProfile.
Return type: integer

uploadTimeMs¶

The length of time taken to upload the job’s outputs, in milliseconds

Returns: The uploadTimeMs of this JobProfile.
Return type: integer

totalTimeMs¶

The total length of time from start to finish, in milliseconds

Returns: The totalTimeMs of this JobProfile.
Return type: integer

versions¶

Gets the versions of this JobProfile.

Returns: The versions of this JobProfile.
Return type: JobVersionInfo

executor¶

Gets the executor of this JobProfile.

Returns: The executor of this JobProfile.
Return type: JobExecutorInfo

JobProfileInput¶

class JobProfileInput¶

preparationTimeMs¶

The length of time taken to download gear container and inputs, in milliseconds

Returns: The preparationTimeMs of this JobProfileInput.
Return type: integer

elapsedTimeMs¶

The runtime of the job, in milliseconds

Returns: The elapsedTimeMs of this JobProfileInput.
Return type: integer

uploadTimeMs¶

The length of time taken to upload the job’s outputs, in milliseconds

Returns: The uploadTimeMs of this JobProfileInput.
Return type: integer

versions¶

Gets the versions of this JobProfileInput.

Returns: The versions of this JobProfileInput.
Return type: JobVersionInfo

executor¶

Gets the executor of this JobProfileInput.

Returns: The executor of this JobProfileInput.
Return type: JobExecutorInfo

JobRequest¶

class JobRequest¶

inputs¶

Gets the inputs of this JobRequest.

Returns: The inputs of this JobRequest.
Return type: JobInputsItem

target¶

Gets the target of this JobRequest.

Returns: The target of this JobRequest.
Return type: containers.Map

outputs¶

Gets the outputs of this JobRequest.

Returns: The outputs of this JobRequest.
Return type: vector[containers.Map]

JobStateCounts¶

The number of jobs matching the filter, for each job state

class JobStateCounts¶

The number of jobs matching the filter, for each job state

pending¶

Gets the pending of this JobStateCounts.

Returns: The pending of this JobStateCounts.
Return type: integer

running¶

Gets the running of this JobStateCounts.

Returns: The running of this JobStateCounts.
Return type: integer

failed¶

Gets the failed of this JobStateCounts.

Returns: The failed of this JobStateCounts.
Return type: integer

complete¶

Gets the complete of this JobStateCounts.

Returns: The complete of this JobStateCounts.
Return type: integer

cancelled¶

Gets the cancelled of this JobStateCounts.

Returns: The cancelled of this JobStateCounts.
Return type: integer

JobStatsByState¶

class JobStatsByState¶

pending¶

Gets the pending of this JobStatsByState.

Returns: The pending of this JobStatsByState.
Return type: integer

running¶

Gets the running of this JobStatsByState.

Returns: The running of this JobStatsByState.
Return type: integer

failed¶

Gets the failed of this JobStatsByState.

Returns: The failed of this JobStatsByState.
Return type: integer

complete¶

Gets the complete of this JobStatsByState.

Returns: The complete of this JobStatsByState.
Return type: integer

cancelled¶

Gets the cancelled of this JobStatsByState.

Returns: The cancelled of this JobStatsByState.
Return type: integer

JobTransitionTimes¶

class JobTransitionTimes¶

running¶

The timestamp when the job transitioned into the running state

Returns: The running of this JobTransitionTimes.
Return type: datetime

failed¶

The timestamp when the job transitioned into the failed state

Returns: The failed of this JobTransitionTimes.
Return type: datetime

complete¶

The timestamp when the job transitioned into the complete state

Returns: The complete of this JobTransitionTimes.
Return type: datetime

cancelled¶

The timestamp when the job transitioned into the cancelled state

Returns: The cancelled of this JobTransitionTimes.
Return type: datetime

JobVersionInfo¶

An object that contains known version info for components involved in the job

class JobVersionInfo¶: An object that contains known version info for components involved in the job

LdapSync¶

class LdapSync¶

groupDn¶

Gets the groupDn of this LdapSync.

Returns: The groupDn of this LdapSync.
Return type: char

syncError¶

Gets the syncError of this LdapSync.

Returns: The syncError of this LdapSync.
Return type: char

lastAttempt¶

Gets the lastAttempt of this LdapSync.

Returns: The lastAttempt of this LdapSync.
Return type: char

lastSuccess¶

Gets the lastSuccess of this LdapSync.

Returns: The lastSuccess of this LdapSync.
Return type: char

LdapSyncData¶

class LdapSyncData¶

users¶

Gets the users of this LdapSyncData.

Returns: The users of this LdapSyncData.
Return type: LdapSyncLdapUser

error¶

Gets the error of this LdapSyncData.

Returns: The error of this LdapSyncData.
Return type: char

LdapSyncInput¶

class LdapSyncInput¶

groupDn¶

Gets the groupDn of this LdapSyncInput.

Returns: The groupDn of this LdapSyncInput.
Return type: char

LdapSyncLdapUser¶

class LdapSyncLdapUser¶

uid¶

Gets the uid of this LdapSyncLdapUser.

Returns: The uid of this LdapSyncLdapUser.
Return type: char

firstname¶

Gets the firstname of this LdapSyncLdapUser.

Returns: The firstname of this LdapSyncLdapUser.
Return type: char

lastname¶

Gets the lastname of this LdapSyncLdapUser.

Returns: The lastname of this LdapSyncLdapUser.
Return type: char

MasterSubjectCodeCodeOutput¶

class MasterSubjectCodeCodeOutput¶

code¶

Master subject code

Returns: The code of this MasterSubjectCodeCodeOutput.
Return type: char

MasterSubjectCodeDobInput¶

class MasterSubjectCodeDobInput¶

firstName¶

First name

Returns: The firstName of this MasterSubjectCodeDobInput.
Return type: char

lastName¶

Last name

Returns: The lastName of this MasterSubjectCodeDobInput.
Return type: char

dateOfBirth¶

Date of birth in YYYY-MM-DD format

Returns: The dateOfBirth of this MasterSubjectCodeDobInput.
Return type: char

patientId¶

Patient id

Returns: The patientId of this MasterSubjectCodeDobInput.
Return type: char

usePatientId¶

Use patient ID for identification or first name, last name, DOB

Returns: The usePatientId of this MasterSubjectCodeDobInput.
Return type: logical

MasterSubjectCodeIdInput¶

class MasterSubjectCodeIdInput¶

firstName¶

First name

Returns: The firstName of this MasterSubjectCodeIdInput.
Return type: char

lastName¶

Last name

Returns: The lastName of this MasterSubjectCodeIdInput.
Return type: char

dateOfBirth¶

Date of birth in YYYY-MM-DD format

Returns: The dateOfBirth of this MasterSubjectCodeIdInput.
Return type: char

patientId¶

Patient id

Returns: The patientId of this MasterSubjectCodeIdInput.
Return type: char

usePatientId¶

Use patient ID for identification or first name, last name, DOB

Returns: The usePatientId of this MasterSubjectCodeIdInput.
Return type: logical

Modality¶

class Modality¶

id¶

Unique database ID

Returns: The id of this Modality.
Return type: char

classification¶

Gets the classification of this Modality.

Returns: The classification of this Modality.
Return type: CommonClassification

description¶

Gets the description of this Modality.

Returns: The description of this Modality.
Return type: char

active¶

Gets the active of this Modality.

Returns: The active of this Modality.
Return type: logical

Note¶

class Note¶

text¶

The actual contents of the note

Returns: The text of this Note.
Return type: char

id¶

Unique database ID

Returns: The id of this Note.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this Note.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Note.
Return type: datetime

user¶

Database ID of a user

Returns: The user of this Note.
Return type: char

Origin¶

class Origin¶

type¶

Gets the type of this Origin.

Returns: The type of this Origin.
Return type: char

id¶

Gets the id of this Origin.

Returns: The id of this Origin.
Return type: char

Packfile¶

class Packfile¶

project¶

Gets the project of this Packfile.

Returns: The project of this Packfile.
Return type: PackfileProjectInput

session¶

Gets the session of this Packfile.

Returns: The session of this Packfile.
Return type: PackfileSessionInput

acquisition¶

Gets the acquisition of this Packfile.

Returns: The acquisition of this Packfile.
Return type: PackfileAcquisitionInput

packfile¶

Gets the packfile of this Packfile.

Returns: The packfile of this Packfile.
Return type: PackfilePackfileInput

PackfileAcquisitionInput¶

class PackfileAcquisitionInput¶

label¶

Gets the label of this PackfileAcquisitionInput.

Returns: The label of this PackfileAcquisitionInput.
Return type: char

timestamp¶

Gets the timestamp of this PackfileAcquisitionInput.

Returns: The timestamp of this PackfileAcquisitionInput.
Return type: datetime

timezone¶

Gets the timezone of this PackfileAcquisitionInput.

Returns: The timezone of this PackfileAcquisitionInput.
Return type: char

PackfilePackfileInput¶

class PackfilePackfileInput¶

type¶

Gets the type of this PackfilePackfileInput.

Returns: The type of this PackfilePackfileInput.
Return type: char

deidLogId¶

Gets the deidLogId of this PackfilePackfileInput.

Returns: The deidLogId of this PackfilePackfileInput.
Return type: char

PackfileProjectInput¶

class PackfileProjectInput¶

id¶

Gets the id of this PackfileProjectInput.

Returns: The id of this PackfileProjectInput.
Return type: char

PackfileSessionInput¶

class PackfileSessionInput¶

label¶

Gets the label of this PackfileSessionInput.

Returns: The label of this PackfileSessionInput.
Return type: char

subject¶

Gets the subject of this PackfileSessionInput.

Returns: The subject of this PackfileSessionInput.
Return type: Subject

PackfileStart¶

class PackfileStart¶

token¶

Gets the token of this PackfileStart.

Returns: The token of this PackfileStart.
Return type: char

PermissionAccessPermission¶

class PermissionAccessPermission¶

id¶

Database ID of a user

Returns: The id of this PermissionAccessPermission.
Return type: char

access¶

Gets the access of this PermissionAccessPermission.

Returns: The access of this PermissionAccessPermission.
Return type: char

Project¶

class Project¶

label¶

Application-specific label

Returns: The label of this Project.
Return type: char

info¶

Gets the info of this Project.

Returns: The info of this Project.
Return type: CommonInfo

description¶

Gets the description of this Project.

Returns: The description of this Project.
Return type: char

group¶

Gets the group of this Project.

Returns: The group of this Project.
Return type: char

providers¶

Gets the providers of this Project.

Returns: The providers of this Project.
Return type: ProviderLinks

editions¶

Gets the editions of this Project.

Returns: The editions of this Project.
Return type: CommonEditions

ldapSync¶

Gets the ldapSync of this Project.

Returns: The ldapSync of this Project.
Return type: LdapSync

id¶

Unique database ID

Returns: The id of this Project.
Return type: char

parents¶

Gets the parents of this Project.

Returns: The parents of this Project.
Return type: ContainerParents

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this Project.
Return type: logical

created¶

Creation time (automatically set)

Returns: The created of this Project.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Project.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this Project.
Return type: integer

templates¶

Gets the templates of this Project.

Returns: The templates of this Project.
Return type: containers.Map

permissions¶

Gets the permissions of this Project.

Returns: The permissions of this Project.
Return type: RolesBackwardsCompatibleRoleAssignment

files¶

Gets the files of this Project.

Returns: The files of this Project.
Return type: FileEntry

notes¶

Gets the notes of this Project.

Returns: The notes of this Project.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this Project.
Return type: vector[char]

analyses¶

Gets the analyses of this Project.

Returns: The analyses of this Project.
Return type: AnalysisOutput

ProjectMetadataInput¶

class ProjectMetadataInput¶

label¶

Gets the label of this ProjectMetadataInput.

Returns: The label of this ProjectMetadataInput.
Return type: char

info¶

Gets the info of this ProjectMetadataInput.

Returns: The info of this ProjectMetadataInput.
Return type: containers.Map

files¶

Gets the files of this ProjectMetadataInput.

Returns: The files of this ProjectMetadataInput.
Return type: FileEntry

tags¶

Array of application-specific tags

Returns: The tags of this ProjectMetadataInput.
Return type: vector[char]

ProjectTemplateRequirement¶

class ProjectTemplateRequirement¶

minimum¶

Gets the minimum of this ProjectTemplateRequirement.

Returns: The minimum of this ProjectTemplateRequirement.
Return type: integer

maximum¶

Gets the maximum of this ProjectTemplateRequirement.

Returns: The maximum of this ProjectTemplateRequirement.
Return type: integer

ProjectTemplateSessionTemplate¶

class ProjectTemplateSessionTemplate¶

session¶

Gets the session of this ProjectTemplateSessionTemplate.

Returns: The session of this ProjectTemplateSessionTemplate.
Return type: containers.Map

acquisitions¶

Gets the acquisitions of this ProjectTemplateSessionTemplate.

Returns: The acquisitions of this ProjectTemplateSessionTemplate.
Return type: ProjectTemplateRequirement

Provider¶

class Provider¶

id¶

Unique database ID

Returns: The id of this Provider.
Return type: char

providerClass¶

The provider class - one of compute or storage

Returns: The providerClass of this Provider.
Return type: char

providerType¶

The provider type (e.g. static or gcloud)

Returns: The providerType of this Provider.
Return type: char

label¶

A human readable label for the provider

Returns: The label of this Provider.
Return type: char

origin¶

Gets the origin of this Provider.

Returns: The origin of this Provider.
Return type: Origin

created¶

Creation time (automatically set)

Returns: The created of this Provider.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Provider.
Return type: datetime

config¶

The provider-specific configuration fields.

Returns: The config of this Provider.
Return type: containers.Map

creds¶

The provider-specific credential fields.

Returns: The creds of this Provider.
Return type: containers.Map

ProviderInput¶

class ProviderInput¶

providerClass¶

The provider class - one of compute or storage

Returns: The providerClass of this ProviderInput.
Return type: char

providerType¶

The provider type (e.g. static or gcloud)

Returns: The providerType of this ProviderInput.
Return type: char

label¶

A human readable label for the provider

Returns: The label of this ProviderInput.
Return type: char

config¶

The provider-specific configuration fields.

Returns: The config of this ProviderInput.
Return type: containers.Map

creds¶

The provider-specific credential fields.

Returns: The creds of this ProviderInput.
Return type: containers.Map

ProviderLinks¶

Links to providers for containers

class ProviderLinks¶

Links to providers for containers

compute¶

Unique database ID

Returns: The compute of this ProviderLinks.
Return type: char

storage¶

Unique database ID

Returns: The storage of this ProviderLinks.
Return type: char

ReportAccessLogContext¶

The context for a logged request, describing the members of the accessed hierarchy

class ReportAccessLogContext¶

The context for a logged request, describing the members of the accessed hierarchy

group¶

Gets the group of this ReportAccessLogContext.

Returns: The group of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

project¶

Gets the project of this ReportAccessLogContext.

Returns: The project of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

subject¶

Gets the subject of this ReportAccessLogContext.

Returns: The subject of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

session¶

Gets the session of this ReportAccessLogContext.

Returns: The session of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

acquisition¶

Gets the acquisition of this ReportAccessLogContext.

Returns: The acquisition of this ReportAccessLogContext.
Return type: ReportAccessLogContextEntry

file¶

Gets the file of this ReportAccessLogContext.

Returns: The file of this ReportAccessLogContext.
Return type: ReportAccessLogContextFileEntry

ReportAccessLogContextEntry¶

class ReportAccessLogContextEntry¶

id¶

Unique database ID

Returns: The id of this ReportAccessLogContextEntry.
Return type: char

label¶

Application-specific label

Returns: The label of this ReportAccessLogContextEntry.
Return type: char

ReportAccessLogContextFileEntry¶

class ReportAccessLogContextFileEntry¶

name¶

The name of the file on disk

Returns: The name of this ReportAccessLogContextFileEntry.
Return type: char

ReportAccessLogEntry¶

A single entry in the access log report

class ReportAccessLogEntry¶

A single entry in the access log report

id¶

The access log entry id

Returns: The id of this ReportAccessLogEntry.
Return type: char

accessType¶

A named field used in the access log report

Returns: The accessType of this ReportAccessLogEntry.
Return type: char

context¶

Gets the context of this ReportAccessLogEntry.

Returns: The context of this ReportAccessLogEntry.
Return type: ReportAccessLogContext

origin¶

Gets the origin of this ReportAccessLogEntry.

Returns: The origin of this ReportAccessLogEntry.
Return type: ReportAccessLogOrigin

requestMethod¶

The http request method (e.g. GET, PUT, POST, DELETE)

Returns: The requestMethod of this ReportAccessLogEntry.
Return type: char

requestPath¶

The HTTP request path (e.g. /api/projects)

Returns: The requestPath of this ReportAccessLogEntry.
Return type: char

timestamp¶

Gets the timestamp of this ReportAccessLogEntry.

Returns: The timestamp of this ReportAccessLogEntry.
Return type: datetime

ReportAccessLogOrigin¶

The origin of a logged request (e.g. a user id)

class ReportAccessLogOrigin¶

The origin of a logged request (e.g. a user id)

type¶

The origin type (e.g. user)

Returns: The type of this ReportAccessLogOrigin.
Return type: char

id¶

The origin id (e.g. user id)

Returns: The id of this ReportAccessLogOrigin.
Return type: char

ReportDailyUsageEntry¶

An entry in the usage report, describing storage and gear usage by group

class ReportDailyUsageEntry¶

An entry in the usage report, describing storage and gear usage by group

year¶

The year that this report row represents

Returns: The year of this ReportDailyUsageEntry.
Return type: integer

month¶

The month that this report row represents

Returns: The month of this ReportDailyUsageEntry.
Return type: integer

day¶

The day that this report row represents

Returns: The day of this ReportDailyUsageEntry.
Return type: integer

group¶

The group label

Returns: The group of this ReportDailyUsageEntry.
Return type: char

project¶

Unique database ID

Returns: The project of this ReportDailyUsageEntry.
Return type: char

projectLabel¶

Application-specific label

Returns: The projectLabel of this ReportDailyUsageEntry.
Return type: char

sessionCount¶

The number of sessions that existed at the last collection time

Returns: The sessionCount of this ReportDailyUsageEntry.
Return type: integer

centerJobCount¶

The number of jobs that completed during the time frame that are billable to the center

Returns: The centerJobCount of this ReportDailyUsageEntry.
Return type: integer

groupJobCount¶

The number of jobs that completed during the time frame that are billable to the group

Returns: The groupJobCount of this ReportDailyUsageEntry.
Return type: integer

centerComputeMs¶

The compute time of jobs completed during the time frame, billable to the center

Returns: The centerComputeMs of this ReportDailyUsageEntry.
Return type: integer

groupComputeMs¶

The compute time of jobs completed during the time frame, billable to the group

Returns: The groupComputeMs of this ReportDailyUsageEntry.
Return type: integer

centerStorageBytes¶

The total storage used on this day, billable to the center

Returns: The centerStorageBytes of this ReportDailyUsageEntry.
Return type: integer

groupStorageBytes¶

The total storage used on this day, billable to the group

Returns: The groupStorageBytes of this ReportDailyUsageEntry.
Return type: integer

ReportDemographicsGrid¶

class ReportDemographicsGrid¶

blackOrAfricanAmerican¶

Gets the blackOrAfricanAmerican of this ReportDemographicsGrid.

Returns: The blackOrAfricanAmerican of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

unknownOrNotReported¶

Gets the unknownOrNotReported of this ReportDemographicsGrid.

Returns: The unknownOrNotReported of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

americanIndianOrAlaskaNative¶

Gets the americanIndianOrAlaskaNative of this ReportDemographicsGrid.

Returns: The americanIndianOrAlaskaNative of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

asian¶

Gets the asian of this ReportDemographicsGrid.

Returns: The asian of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

white¶

Gets the white of this ReportDemographicsGrid.

Returns: The white of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

total¶

Gets the total of this ReportDemographicsGrid.

Returns: The total of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

nativeHawaiianOrOtherPacificIslander¶

Gets the nativeHawaiianOrOtherPacificIslander of this ReportDemographicsGrid.

Returns: The nativeHawaiianOrOtherPacificIslander of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

moreThanOneRace¶

Gets the moreThanOneRace of this ReportDemographicsGrid.

Returns: The moreThanOneRace of this ReportDemographicsGrid.
Return type: ReportEthnicityGrid

maleCount¶

Gets the maleCount of this ReportDemographicsGrid.

Returns: The maleCount of this ReportDemographicsGrid.
Return type: integer

groupLabel¶

Application-specific label

Returns: The groupLabel of this ReportDemographicsGrid.
Return type: char

over18Count¶

Gets the over18Count of this ReportDemographicsGrid.

Returns: The over18Count of this ReportDemographicsGrid.
Return type: integer

under18Count¶

Gets the under18Count of this ReportDemographicsGrid.

Returns: The under18Count of this ReportDemographicsGrid.
Return type: integer

femaleCount¶

Gets the femaleCount of this ReportDemographicsGrid.

Returns: The femaleCount of this ReportDemographicsGrid.
Return type: integer

subjectsCount¶

Gets the subjectsCount of this ReportDemographicsGrid.

Returns: The subjectsCount of this ReportDemographicsGrid.
Return type: integer

otherCount¶

Gets the otherCount of this ReportDemographicsGrid.

Returns: The otherCount of this ReportDemographicsGrid.
Return type: integer

name¶

Application-specific label

Returns: The name of this ReportDemographicsGrid.
Return type: char

sessionCount¶

Gets the sessionCount of this ReportDemographicsGrid.

Returns: The sessionCount of this ReportDemographicsGrid.
Return type: integer

admins¶

Gets the admins of this ReportDemographicsGrid.

Returns: The admins of this ReportDemographicsGrid.
Return type: vector[char]

demographicsTotal¶

Gets the demographicsTotal of this ReportDemographicsGrid.

Returns: The demographicsTotal of this ReportDemographicsGrid.
Return type: integer

ReportEthnicityGrid¶

class ReportEthnicityGrid¶

notHispanicOrLatino¶

Gets the notHispanicOrLatino of this ReportEthnicityGrid.

Returns: The notHispanicOrLatino of this ReportEthnicityGrid.
Return type: ReportGenderCount

hispanicOrLatino¶

Gets the hispanicOrLatino of this ReportEthnicityGrid.

Returns: The hispanicOrLatino of this ReportEthnicityGrid.
Return type: ReportGenderCount

unknownOrNotReported¶

Gets the unknownOrNotReported of this ReportEthnicityGrid.

Returns: The unknownOrNotReported of this ReportEthnicityGrid.
Return type: ReportGenderCount

total¶

Gets the total of this ReportEthnicityGrid.

Returns: The total of this ReportEthnicityGrid.
Return type: integer

ReportGenderCount¶

class ReportGenderCount¶

male¶

Gets the male of this ReportGenderCount.

Returns: The male of this ReportGenderCount.
Return type: integer

unknownOrNotReported¶

Gets the unknownOrNotReported of this ReportGenderCount.

Returns: The unknownOrNotReported of this ReportGenderCount.
Return type: integer

female¶

Gets the female of this ReportGenderCount.

Returns: The female of this ReportGenderCount.
Return type: integer

ReportGroupReport¶

class ReportGroupReport¶

projectCount¶

Gets the projectCount of this ReportGroupReport.

Returns: The projectCount of this ReportGroupReport.
Return type: integer

label¶

The group label

Returns: The label of this ReportGroupReport.
Return type: char

sessionCount¶

Gets the sessionCount of this ReportGroupReport.

Returns: The sessionCount of this ReportGroupReport.
Return type: integer

ReportLegacyUsageEntry¶

An entry in the usage report, describing storage and gear usage

class ReportLegacyUsageEntry¶

An entry in the usage report, describing storage and gear usage

fileMbs¶

File storage usage, in megabytes

Returns: The fileMbs of this ReportLegacyUsageEntry.
Return type: float

gearExecutionCount¶

The number of gears executed

Returns: The gearExecutionCount of this ReportLegacyUsageEntry.
Return type: integer

sessionCount¶

The number of sessions created

Returns: The sessionCount of this ReportLegacyUsageEntry.
Return type: integer

year¶

The year portion of the entry date

Returns: The year of this ReportLegacyUsageEntry.
Return type: char

month¶

The month portion of the entry date

Returns: The month of this ReportLegacyUsageEntry.
Return type: char

project¶

Gets the project of this ReportLegacyUsageEntry.

Returns: The project of this ReportLegacyUsageEntry.
Return type: ReportLegacyUsageProjectEntry

ReportLegacyUsageProjectEntry¶

The project that this entry reports on

class ReportLegacyUsageProjectEntry¶

The project that this entry reports on

id¶

Unique database ID

Returns: The id of this ReportLegacyUsageProjectEntry.
Return type: char

label¶

Application-specific label

Returns: The label of this ReportLegacyUsageProjectEntry.
Return type: char

ReportProject¶

class ReportProject¶

projects¶

Gets the projects of this ReportProject.

Returns: The projects of this ReportProject.
Return type: ReportDemographicsGrid

ReportSite¶

class ReportSite¶

groupCount¶

Gets the groupCount of this ReportSite.

Returns: The groupCount of this ReportSite.
Return type: integer

groups¶

Gets the groups of this ReportSite.

Returns: The groups of this ReportSite.
Return type: ReportGroupReport

ReportTimePeriod¶

Represents a time-period where report data is available

class ReportTimePeriod¶

Represents a time-period where report data is available

year¶

The year that this report row represents

Returns: The year of this ReportTimePeriod.
Return type: integer

month¶

The month that this report row represents

Returns: The month of this ReportTimePeriod.
Return type: integer

day¶

The day that this report row represents

Returns: The day of this ReportTimePeriod.
Return type: integer

ReportUsageEntry¶

An entry in the usage report, describing storage and gear usage by group and project

class ReportUsageEntry¶

An entry in the usage report, describing storage and gear usage by group and project

group¶

The group label

Returns: The group of this ReportUsageEntry.
Return type: char

project¶

The project id, or null if this is a group summary row

Returns: The project of this ReportUsageEntry.
Return type: char

projectLabel¶

The project label, or null if this is a group summary row

Returns: The projectLabel of this ReportUsageEntry.
Return type: char

sessionCount¶

The number of sessions that existed at the last collection time

Returns: The sessionCount of this ReportUsageEntry.
Return type: integer

centerJobCount¶

The number of jobs that completed during the time frame that are billable to the center

Returns: The centerJobCount of this ReportUsageEntry.
Return type: integer

groupJobCount¶

The number of jobs that completed during the time frame that are billable to the group

Returns: The groupJobCount of this ReportUsageEntry.
Return type: integer

totalJobCount¶

The total number of jobs completed during the time frame

Returns: The totalJobCount of this ReportUsageEntry.
Return type: integer

centerComputeMs¶

The compute time of jobs completed during the time frame, billable to the center

Returns: The centerComputeMs of this ReportUsageEntry.
Return type: integer

groupComputeMs¶

The compute time of jobs completed during the time frame, billable to the group

Returns: The groupComputeMs of this ReportUsageEntry.
Return type: integer

totalComputeMs¶

The total compute time of jobs completed during the time frame

Returns: The totalComputeMs of this ReportUsageEntry.
Return type: integer

centerStorageByteDay¶

The total storage used, in byte-days, billable to the center

Returns: The centerStorageByteDay of this ReportUsageEntry.
Return type: integer

groupStorageByteDay¶

The total storage used, in byte-days, billable to the group

Returns: The groupStorageByteDay of this ReportUsageEntry.
Return type: integer

totalStorageByteDay¶

The total storage used, in byte-days

Returns: The totalStorageByteDay of this ReportUsageEntry.
Return type: integer

days¶

The number of days collected in this report

Returns: The days of this ReportUsageEntry.
Return type: integer

ResolverInput¶

class ResolverInput¶

path¶

Gets the path of this ResolverInput.

Returns: The path of this ResolverInput.
Return type: vector[char]

ResolverNode¶

class ResolverNode¶

containerType¶

Gets the containerType of this ResolverNode.

Returns: The containerType of this ResolverNode.
Return type: char

ResolverOutput¶

class ResolverOutput¶

path¶

Gets the path of this ResolverOutput.

Returns: The path of this ResolverOutput.
Return type: ResolverNode

children¶

Gets the children of this ResolverOutput.

Returns: The children of this ResolverOutput.
Return type: ResolverNode

RolesBackwardsCompatibleRoleAssignment¶

class RolesBackwardsCompatibleRoleAssignment¶

id¶

Database ID of a user

Returns: The id of this RolesBackwardsCompatibleRoleAssignment.
Return type: char

roleIds¶

Gets the roleIds of this RolesBackwardsCompatibleRoleAssignment.

Returns: The roleIds of this RolesBackwardsCompatibleRoleAssignment.
Return type: vector[char]

access¶

Gets the access of this RolesBackwardsCompatibleRoleAssignment.

Returns: The access of this RolesBackwardsCompatibleRoleAssignment.
Return type: char

RolesGroupRolePoolInput¶

class RolesGroupRolePoolInput¶

id¶

Unique database ID

Returns: The id of this RolesGroupRolePoolInput.
Return type: char

RolesRole¶

class RolesRole¶

id¶

Unique database ID

Returns: The id of this RolesRole.
Return type: char

label¶

Application-specific label

Returns: The label of this RolesRole.
Return type: char

defaultFlywheelRole¶

Gets the defaultFlywheelRole of this RolesRole.

Returns: The defaultFlywheelRole of this RolesRole.
Return type: char

actions¶

Gets the actions of this RolesRole.

Returns: The actions of this RolesRole.
Return type: vector[char]

inUse¶

Gets the inUse of this RolesRole.

Returns: The inUse of this RolesRole.
Return type: logical

RolesRoleAssignment¶

class RolesRoleAssignment¶

id¶

Database ID of a user

Returns: The id of this RolesRoleAssignment.
Return type: char

roleIds¶

Gets the roleIds of this RolesRoleAssignment.

Returns: The roleIds of this RolesRoleAssignment.
Return type: vector[char]

RolesRoleInput¶

class RolesRoleInput¶

label¶

Application-specific label

Returns: The label of this RolesRoleInput.
Return type: char

actions¶

Gets the actions of this RolesRoleInput.

Returns: The actions of this RolesRoleInput.
Return type: vector[char]

Rule¶

class Rule¶

projectId¶

Gets the projectId of this Rule.

Returns: The projectId of this Rule.
Return type: char

gearId¶

Gets the gearId of this Rule.

Returns: The gearId of this Rule.
Return type: char

name¶

Gets the name of this Rule.

Returns: The name of this Rule.
Return type: char

config¶

Gets the config of this Rule.

Returns: The config of this Rule.
Return type: containers.Map

fixedInputs¶

Gets the fixedInputs of this Rule.

Returns: The fixedInputs of this Rule.
Return type: JobInputsArrayItem

autoUpdate¶

Gets the autoUpdate of this Rule.

Returns: The autoUpdate of this Rule.
Return type: logical

any¶

Gets the any of this Rule.

Returns: The any of this Rule.
Return type: RuleAny

all¶

Gets the all of this Rule.

Returns: The all of this Rule.
Return type: RuleAny

not¶

Gets the not of this Rule.

Returns: The not of this Rule.
Return type: RuleAny

disabled¶

Gets the disabled of this Rule.

Returns: The disabled of this Rule.
Return type: logical

computeProviderId¶

Unique database ID

Returns: The computeProviderId of this Rule.
Return type: char

id¶

Gets the id of this Rule.

Returns: The id of this Rule.
Return type: char

RuleAny¶

class RuleAny¶

type¶

Gets the type of this RuleAny.

Returns: The type of this RuleAny.
Return type: char

value¶

Gets the value of this RuleAny.

Returns: The value of this RuleAny.
Return type: char

regex¶

Gets the regex of this RuleAny.

Returns: The regex of this RuleAny.
Return type: logical

SearchAcquisitionResponse¶

Fields for acquisition search response

class SearchAcquisitionResponse¶

Fields for acquisition search response

id¶

Unique database ID

Returns: The id of this SearchAcquisitionResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchAcquisitionResponse.
Return type: char

timestamp¶

Gets the timestamp of this SearchAcquisitionResponse.

Returns: The timestamp of this SearchAcquisitionResponse.
Return type: datetime

created¶

Creation time (automatically set)

Returns: The created of this SearchAcquisitionResponse.
Return type: datetime

SearchAnalysisResponse¶

Fields for acquisition search response

class SearchAnalysisResponse¶

Fields for acquisition search response

id¶

Unique database ID

Returns: The id of this SearchAnalysisResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchAnalysisResponse.
Return type: char

user¶

Database ID of a user

Returns: The user of this SearchAnalysisResponse.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this SearchAnalysisResponse.
Return type: datetime

SearchCollectionResponse¶

Fields for collection search response

class SearchCollectionResponse¶

Fields for collection search response

id¶

Unique database ID

Returns: The id of this SearchCollectionResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchCollectionResponse.
Return type: char

curator¶

Database ID of a user

Returns: The curator of this SearchCollectionResponse.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this SearchCollectionResponse.
Return type: datetime

SearchFileResponse¶

Fields for file search response

class SearchFileResponse¶

Fields for file search response

classification¶

Gets the classification of this SearchFileResponse.

Returns: The classification of this SearchFileResponse.
Return type: CommonClassification

created¶

Creation time (automatically set)

Returns: The created of this SearchFileResponse.
Return type: datetime

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this SearchFileResponse.
Return type: char

name¶

The name of the file on disk

Returns: The name of this SearchFileResponse.
Return type: char

size¶

Size of the file, in bytes

Returns: The size of this SearchFileResponse.
Return type: integer

SearchGroupResponse¶

Fields for group search response

class SearchGroupResponse¶

Fields for group search response

id¶

Unique database ID

Returns: The id of this SearchGroupResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchGroupResponse.
Return type: char

SearchMlInput¶

class SearchMlInput¶

labels¶

Gets the labels of this SearchMlInput.

Returns: The labels of this SearchMlInput.
Return type: vector[char]

searchQuery¶

Gets the searchQuery of this SearchMlInput.

Returns: The searchQuery of this SearchMlInput.
Return type: SearchQuery

files¶

Gets the files of this SearchMlInput.

Returns: The files of this SearchMlInput.
Return type: SearchMlInputFile

output¶

Gets the output of this SearchMlInput.

Returns: The output of this SearchMlInput.
Return type: ContainerReference

SearchMlInputFile¶

class SearchMlInputFile¶

id¶

Gets the id of this SearchMlInputFile.

Returns: The id of this SearchMlInputFile.
Return type: char

SearchParentResponse¶

Fields for parent search response

class SearchParentResponse¶

Fields for parent search response

id¶

Unique database ID

Returns: The id of this SearchParentResponse.
Return type: char

type¶

The type of container (e.g. session)

Returns: The type of this SearchParentResponse.
Return type: char

SearchParseError¶

class SearchParseError¶

line¶

The line number where the error occurred

Returns: The line of this SearchParseError.
Return type: integer

pos¶

The position where the error occurred

Returns: The pos of this SearchParseError.
Return type: integer

offset¶

The absolute offset in the input (from 0) where the error occurred

Returns: The offset of this SearchParseError.
Return type: integer

message¶

The error message

Returns: The message of this SearchParseError.
Return type: char

SearchParseSearchQueryResult¶

class SearchParseSearchQueryResult¶

valid¶

Whether the structured query was valid or not

Returns: The valid of this SearchParseSearchQueryResult.
Return type: logical

errors¶

Gets the errors of this SearchParseSearchQueryResult.

Returns: The errors of this SearchParseSearchQueryResult.
Return type: SearchParseError

SearchProjectResponse¶

Fields for project search response

class SearchProjectResponse¶

Fields for project search response

id¶

Unique database ID

Returns: The id of this SearchProjectResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchProjectResponse.
Return type: char

SearchQuery¶

class SearchQuery¶

returnType¶

Sets the type of search results to return

Returns: The returnType of this SearchQuery.
Return type: char

searchString¶

Represents the plain text search query

Returns: The searchString of this SearchQuery.
Return type: char

structuredQuery¶

Represents structured query language search

Returns: The structuredQuery of this SearchQuery.
Return type: char

allData¶

When set will include all data that the user does not have access to read

Returns: The allData of this SearchQuery.
Return type: logical

filters¶

See https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html

Returns: The filters of this SearchQuery.
Return type: vector[containers.Map]

SearchQuerySuggestions¶

class SearchQuerySuggestions¶

from¶

The starting position for the auto-complete replacement

Returns: The from of this SearchQuerySuggestions.
Return type: integer

suggestions¶

The list of suggested replacements

Returns: The suggestions of this SearchQuerySuggestions.
Return type: SearchSuggestion

SearchResponse¶

Single search response entry

class SearchResponse¶

Single search response entry

returnType¶

Sets the type of search results to return

Returns: The returnType of this SearchResponse.
Return type: char

project¶

Gets the project of this SearchResponse.

Returns: The project of this SearchResponse.
Return type: SearchProjectResponse

group¶

Gets the group of this SearchResponse.

Returns: The group of this SearchResponse.
Return type: SearchGroupResponse

session¶

Gets the session of this SearchResponse.

Returns: The session of this SearchResponse.
Return type: SearchSessionResponse

acquisition¶

Gets the acquisition of this SearchResponse.

Returns: The acquisition of this SearchResponse.
Return type: SearchAcquisitionResponse

subject¶

Gets the subject of this SearchResponse.

Returns: The subject of this SearchResponse.
Return type: SearchSubjectResponse

file¶

Gets the file of this SearchResponse.

Returns: The file of this SearchResponse.
Return type: SearchFileResponse

collection¶

Gets the collection of this SearchResponse.

Returns: The collection of this SearchResponse.
Return type: SearchCollectionResponse

analysis¶

Gets the analysis of this SearchResponse.

Returns: The analysis of this SearchResponse.
Return type: SearchAnalysisResponse

parent¶

Gets the parent of this SearchResponse.

Returns: The parent of this SearchResponse.
Return type: SearchParentResponse

permissions¶

Gets the permissions of this SearchResponse.

Returns: The permissions of this SearchResponse.
Return type: RolesRoleAssignment

SearchSaveSearch¶

class SearchSaveSearch¶

label¶

Application-specific label

Returns: The label of this SearchSaveSearch.
Return type: char

search¶

Gets the search of this SearchSaveSearch.

Returns: The search of this SearchSaveSearch.
Return type: SearchQuery

parent¶

Gets the parent of this SearchSaveSearch.

Returns: The parent of this SearchSaveSearch.
Return type: SearchSaveSearchParent

id¶

Unique database ID

Returns: The id of this SearchSaveSearch.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this SearchSaveSearch.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchSaveSearch.
Return type: datetime

SearchSaveSearchInput¶

class SearchSaveSearchInput¶

label¶

Application-specific label

Returns: The label of this SearchSaveSearchInput.
Return type: char

search¶

Gets the search of this SearchSaveSearchInput.

Returns: The search of this SearchSaveSearchInput.
Return type: SearchQuery

parent¶

Gets the parent of this SearchSaveSearchInput.

Returns: The parent of this SearchSaveSearchInput.
Return type: SearchSaveSearchParent

SearchSaveSearchParent¶

class SearchSaveSearchParent¶

type¶

Gets the type of this SearchSaveSearchParent.

Returns: The type of this SearchSaveSearchParent.
Return type: char

id¶

Unique database ID

Returns: The id of this SearchSaveSearchParent.
Return type: char

SearchSaveSearchUpdate¶

class SearchSaveSearchUpdate¶

label¶

Application-specific label

Returns: The label of this SearchSaveSearchUpdate.
Return type: char

search¶

Gets the search of this SearchSaveSearchUpdate.

Returns: The search of this SearchSaveSearchUpdate.
Return type: SearchQuery

SearchSessionResponse¶

Fields for session search response

class SearchSessionResponse¶

Fields for session search response

id¶

Unique database ID

Returns: The id of this SearchSessionResponse.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchSessionResponse.
Return type: char

timestamp¶

Gets the timestamp of this SearchSessionResponse.

Returns: The timestamp of this SearchSessionResponse.
Return type: datetime

created¶

Creation time (automatically set)

Returns: The created of this SearchSessionResponse.
Return type: datetime

SearchStatus¶

class SearchStatus¶

status¶

Gets the status of this SearchStatus.

Returns: The status of this SearchStatus.
Return type: char

lastSeen¶

Last modification time (automatically updated)

Returns: The lastSeen of this SearchStatus.
Return type: datetime

SearchStructuredSearchQuery¶

class SearchStructuredSearchQuery¶

structuredQuery¶

Represents structured query language search

Returns: The structuredQuery of this SearchStructuredSearchQuery.
Return type: char

SearchSubjectResponse¶

Fields for subject search response

class SearchSubjectResponse¶

Fields for subject search response

code¶

A unique identifier for the subject

Returns: The code of this SearchSubjectResponse.
Return type: char

SearchSuggestion¶

class SearchSuggestion¶

display¶

The display value of the suggestion

Returns: The display of this SearchSuggestion.
Return type: char

value¶

The value to use for replacement

Returns: The value of this SearchSuggestion.
Return type: char

Session¶

class Session¶

operator¶

The name of the operator

Returns: The operator of this Session.
Return type: char

label¶

Application-specific label

Returns: The label of this Session.
Return type: char

info¶

Gets the info of this Session.

Returns: The info of this Session.
Return type: CommonInfo

project¶

Unique database ID

Returns: The project of this Session.
Return type: char

uid¶

A user database ID

Returns: The uid of this Session.
Return type: char

timestamp¶

Gets the timestamp of this Session.

Returns: The timestamp of this Session.
Return type: datetime

timezone¶

Gets the timezone of this Session.

Returns: The timezone of this Session.
Return type: char

subject¶

Gets the subject of this Session.

Returns: The subject of this Session.
Return type: Subject

age¶

Subject age at time of session, in seconds

Returns: The age of this Session.
Return type: integer

weight¶

Subject weight at time of session, in kilograms

Returns: The weight of this Session.
Return type: float

id¶

Unique database ID

Returns: The id of this Session.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this Session.
Return type: logical

parents¶

Gets the parents of this Session.

Returns: The parents of this Session.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this Session.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Session.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this Session.
Return type: integer

permissions¶

Gets the permissions of this Session.

Returns: The permissions of this Session.
Return type: RolesBackwardsCompatibleRoleAssignment

group¶

Gets the group of this Session.

Returns: The group of this Session.
Return type: char

projectHasTemplate¶

Gets the projectHasTemplate of this Session.

Returns: The projectHasTemplate of this Session.
Return type: logical

satisfiesTemplate¶

Gets the satisfiesTemplate of this Session.

Returns: The satisfiesTemplate of this Session.
Return type: logical

files¶

Gets the files of this Session.

Returns: The files of this Session.
Return type: FileEntry

notes¶

Gets the notes of this Session.

Returns: The notes of this Session.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this Session.
Return type: vector[char]

analyses¶

Gets the analyses of this Session.

Returns: The analyses of this Session.
Return type: AnalysisOutput

SessionJobsOutput¶

class SessionJobsOutput¶

jobs¶

Gets the jobs of this SessionJobsOutput.

Returns: The jobs of this SessionJobsOutput.
Return type: Job

containers¶

Gets the containers of this SessionJobsOutput.

Returns: The containers of this SessionJobsOutput.
Return type: containers.Map[String, containers.Map]

SessionMetadataInput¶

class SessionMetadataInput¶

label¶

Gets the label of this SessionMetadataInput.

Returns: The label of this SessionMetadataInput.
Return type: char

info¶

Gets the info of this SessionMetadataInput.

Returns: The info of this SessionMetadataInput.
Return type: containers.Map

operator¶

Gets the operator of this SessionMetadataInput.

Returns: The operator of this SessionMetadataInput.
Return type: char

uid¶

Gets the uid of this SessionMetadataInput.

Returns: The uid of this SessionMetadataInput.
Return type: char

timestamp¶

Gets the timestamp of this SessionMetadataInput.

Returns: The timestamp of this SessionMetadataInput.
Return type: datetime

timezone¶

Gets the timezone of this SessionMetadataInput.

Returns: The timezone of this SessionMetadataInput.
Return type: char

subject¶

Gets the subject of this SessionMetadataInput.

Returns: The subject of this SessionMetadataInput.
Return type: Subject

tags¶

Array of application-specific tags

Returns: The tags of this SessionMetadataInput.
Return type: vector[char]

age¶

Subject age at time of session, in seconds

Returns: The age of this SessionMetadataInput.
Return type: integer

weight¶

Subject weight at time of session, in kilograms

Returns: The weight of this SessionMetadataInput.
Return type: float

files¶

Gets the files of this SessionMetadataInput.

Returns: The files of this SessionMetadataInput.
Return type: FileEntry

SessionTemplateRecalcOutput¶

class SessionTemplateRecalcOutput¶

sessionsChanged¶

Gets the sessionsChanged of this SessionTemplateRecalcOutput.

Returns: The sessionsChanged of this SessionTemplateRecalcOutput.
Return type: vector[char]

SignedurlmetadataSignedUrlMetadataInput¶

class SignedurlmetadataSignedUrlMetadataInput¶

metadata¶

Gets the metadata of this SignedurlmetadataSignedUrlMetadataInput.

Returns: The metadata of this SignedurlmetadataSignedUrlMetadataInput.
Return type: AnalysisInput

filename¶

Gets the filename of this SignedurlmetadataSignedUrlMetadataInput.

Returns: The filename of this SignedurlmetadataSignedUrlMetadataInput.
Return type: char

Subject¶

class Subject¶

id¶

Unique database ID

Returns: The id of this Subject.
Return type: char

project¶

Unique database ID

Returns: The project of this Subject.
Return type: char

firstname¶

First name

Returns: The firstname of this Subject.
Return type: char

lastname¶

Last name

Returns: The lastname of this Subject.
Return type: char

age¶

Age at time of session, in seconds

Returns: The age of this Subject.
Return type: integer

sex¶

Gets the sex of this Subject.

Returns: The sex of this Subject.
Return type: char

cohort¶

Gets the cohort of this Subject.

Returns: The cohort of this Subject.
Return type: char

mlset¶

Gets the mlset of this Subject.

Returns: The mlset of this Subject.
Return type: char

type¶

Gets the type of this Subject.

Returns: The type of this Subject.
Return type: char

race¶

Gets the race of this Subject.

Returns: The race of this Subject.
Return type: char

ethnicity¶

Gets the ethnicity of this Subject.

Returns: The ethnicity of this Subject.
Return type: char

species¶

Gets the species of this Subject.

Returns: The species of this Subject.
Return type: char

strain¶

Gets the strain of this Subject.

Returns: The strain of this Subject.
Return type: char

label¶

A unique identifier for the subject

Returns: The label of this Subject.
Return type: char

code¶

A unique identifier for the subject

Returns: The code of this Subject.
Return type: char

masterCode¶

A unique identifier for the subject

Returns: The masterCode of this Subject.
Return type: char

tags¶

Array of application-specific tags

Returns: The tags of this Subject.
Return type: vector[char]

info¶

Gets the info of this Subject.

Returns: The info of this Subject.
Return type: CommonInfo

files¶

Gets the files of this Subject.

Returns: The files of this Subject.
Return type: FileEntry

parents¶

Gets the parents of this Subject.

Returns: The parents of this Subject.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this Subject.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this Subject.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this Subject.
Return type: integer

permissions¶

Gets the permissions of this Subject.

Returns: The permissions of this Subject.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this Subject.

Returns: The notes of this Subject.
Return type: Note

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this Subject.
Return type: logical

analyses¶

Gets the analyses of this Subject.

Returns: The analyses of this Subject.
Return type: AnalysisOutput

SubjectMetadataInput¶

class SubjectMetadataInput¶

label¶

A unique identifier for the subject

Returns: The label of this SubjectMetadataInput.
Return type: char

code¶

Gets the code of this SubjectMetadataInput.

Returns: The code of this SubjectMetadataInput.
Return type: char

masterCode¶

Gets the masterCode of this SubjectMetadataInput.

Returns: The masterCode of this SubjectMetadataInput.
Return type: char

info¶

Gets the info of this SubjectMetadataInput.

Returns: The info of this SubjectMetadataInput.
Return type: containers.Map

tags¶

Array of application-specific tags

Returns: The tags of this SubjectMetadataInput.
Return type: vector[char]

files¶

Gets the files of this SubjectMetadataInput.

Returns: The files of this SubjectMetadataInput.
Return type: FileEntry

Tag¶

class Tag¶

value¶

Gets the value of this Tag.

Returns: The value of this Tag.
Return type: char

TreeContainerRequestSpec¶

class TreeContainerRequestSpec¶

fields¶

The list of fields to include

Returns: The fields of this TreeContainerRequestSpec.
Return type: vector[char]

filter¶

The optional, comma-separated filter string

Returns: The filter of this TreeContainerRequestSpec.
Return type: char

limit¶

The optional maximum number of children to include

Returns: The limit of this TreeContainerRequestSpec.
Return type: integer

sort¶

The optional, comma-separated, sort specification

Returns: The sort of this TreeContainerRequestSpec.
Return type: char

joinOrigin¶

Whether or not to join file origins, default is false

Returns: The joinOrigin of this TreeContainerRequestSpec.
Return type: logical

TreeGraph¶

class TreeGraph¶

TreeGraphConnection¶

class TreeGraphConnection¶

local¶

Gets the local of this TreeGraphConnection.

Returns: The local of this TreeGraphConnection.
Return type: char

foreign¶

Gets the foreign of this TreeGraphConnection.

Returns: The foreign of this TreeGraphConnection.
Return type: char

collection¶

Gets the collection of this TreeGraphConnection.

Returns: The collection of this TreeGraphConnection.
Return type: char

order¶

Gets the order of this TreeGraphConnection.

Returns: The order of this TreeGraphConnection.
Return type: char

TreeGraphConnections¶

class TreeGraphConnections¶

TreeGraphNode¶

class TreeGraphNode¶

connections¶

Gets the connections of this TreeGraphNode.

Returns: The connections of this TreeGraphNode.
Return type: TreeGraphConnections

TreeRequest¶

class TreeRequest¶

groups¶

Gets the groups of this TreeRequest.

Returns: The groups of this TreeRequest.
Return type: TreeContainerRequestSpec

projects¶

Gets the projects of this TreeRequest.

Returns: The projects of this TreeRequest.
Return type: TreeContainerRequestSpec

subjects¶

Gets the subjects of this TreeRequest.

Returns: The subjects of this TreeRequest.
Return type: TreeContainerRequestSpec

sessions¶

Gets the sessions of this TreeRequest.

Returns: The sessions of this TreeRequest.
Return type: TreeContainerRequestSpec

acquisitions¶

Gets the acquisitions of this TreeRequest.

Returns: The acquisitions of this TreeRequest.
Return type: TreeContainerRequestSpec

analyses¶

Gets the analyses of this TreeRequest.

Returns: The analyses of this TreeRequest.
Return type: TreeContainerRequestSpec

jobs¶

Gets the jobs of this TreeRequest.

Returns: The jobs of this TreeRequest.
Return type: TreeContainerRequestSpec

TreeResponseItem¶

Response varies based on selected container and fields

class TreeResponseItem¶: Response varies based on selected container and fields

User¶

class User¶

id¶

Database ID of a user

Returns: The id of this User.
Return type: char

firstname¶

First name

Returns: The firstname of this User.
Return type: char

lastname¶

Last name

Returns: The lastname of this User.
Return type: char

email¶

Email address

Returns: The email of this User.
Return type: char

avatar¶

Avatar image URL

Returns: The avatar of this User.
Return type: char

avatars¶

Gets the avatars of this User.

Returns: The avatars of this User.
Return type: Avatars

roles¶

Gets the roles of this User.

Returns: The roles of this User.
Return type: vector[char]

root¶

Super admin flag

Returns: The root of this User.
Return type: logical

disabled¶

Gets the disabled of this User.

Returns: The disabled of this User.
Return type: logical

preferences¶

Gets the preferences of this User.

Returns: The preferences of this User.
Return type: UserPreferences

wechat¶

Gets the wechat of this User.

Returns: The wechat of this User.
Return type: UserWechat

firstlogin¶

Gets the firstlogin of this User.

Returns: The firstlogin of this User.
Return type: char

lastlogin¶

Gets the lastlogin of this User.

Returns: The lastlogin of this User.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this User.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this User.
Return type: datetime

apiKey¶

Gets the apiKey of this User.

Returns: The apiKey of this User.
Return type: UserApiKey

UserApiKey¶

class UserApiKey¶

key¶

Gets the key of this UserApiKey.

Returns: The key of this UserApiKey.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this UserApiKey.
Return type: datetime

lastUsed¶

Gets the lastUsed of this UserApiKey.

Returns: The lastUsed of this UserApiKey.
Return type: datetime

UserJobsOutput¶

class UserJobsOutput¶

stats¶

Gets the stats of this UserJobsOutput.

Returns: The stats of this UserJobsOutput.
Return type: JobStatsByState

total¶

Gets the total of this UserJobsOutput.

Returns: The total of this UserJobsOutput.
Return type: integer

jobs¶

Gets the jobs of this UserJobsOutput.

Returns: The jobs of this UserJobsOutput.
Return type: JobListEntry

UserPreferences¶

class UserPreferences¶

UserWechat¶

class UserWechat¶

VersionOutput¶

class VersionOutput¶

id¶

Gets the id of this VersionOutput.

Returns: The id of this VersionOutput.
Return type: char

appliedFixes¶

Collection of applied database fixes

Returns: The appliedFixes of this VersionOutput.
Return type: containers.Map[String, char]

cliVersion¶

Compatible CLI version for this server as informed by the installation recipe.env

Returns: The cliVersion of this VersionOutput.
Return type: char

database¶

Core database version

Returns: The database of this VersionOutput.
Return type: integer

flywheelRelease¶

Flywheel installer image tag as informed by the installation recipe.env

Returns: The flywheelRelease of this VersionOutput.
Return type: char

release¶

Core release version

Returns: The release of this VersionOutput.
Return type: char

ViewerApp¶

class ViewerApp¶

name¶

Unique name of this application

Returns: The name of this ViewerApp.
Return type: char

url¶

URL that points to the location where the application is hosted

Returns: The url of this ViewerApp.
Return type: char

options¶

General properties passed to the application when it connects to Flywheel

Returns: The options of this ViewerApp.
Return type: containers.Map

files¶

File types that are associated to this application

Returns: The files of this ViewerApp.
Return type: containers.Map[String, containers.Map]

containers¶

Container types that are associated to this application

Returns: The containers of this ViewerApp.
Return type: containers.Map[String, containers.Map]

ContainerAcquisitionOutput¶

class ContainerAcquisitionOutput¶

label¶

Application-specific label

Returns: The label of this ContainerAcquisitionOutput.
Return type: char

info¶

Gets the info of this ContainerAcquisitionOutput.

Returns: The info of this ContainerAcquisitionOutput.
Return type: CommonInfo

session¶

Unique database ID

Returns: The session of this ContainerAcquisitionOutput.
Return type: char

uid¶

A user database ID

Returns: The uid of this ContainerAcquisitionOutput.
Return type: char

timestamp¶

Gets the timestamp of this ContainerAcquisitionOutput.

Returns: The timestamp of this ContainerAcquisitionOutput.
Return type: datetime

timezone¶

Gets the timezone of this ContainerAcquisitionOutput.

Returns: The timezone of this ContainerAcquisitionOutput.
Return type: char

id¶

Unique database ID

Returns: The id of this ContainerAcquisitionOutput.
Return type: char

parents¶

Gets the parents of this ContainerAcquisitionOutput.

Returns: The parents of this ContainerAcquisitionOutput.
Return type: ContainerParents

collections¶

Gets the collections of this ContainerAcquisitionOutput.

Returns: The collections of this ContainerAcquisitionOutput.
Return type: vector[char]

files¶

Gets the files of this ContainerAcquisitionOutput.

Returns: The files of this ContainerAcquisitionOutput.
Return type: FileEntry

created¶

Creation time (automatically set)

Returns: The created of this ContainerAcquisitionOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerAcquisitionOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerAcquisitionOutput.
Return type: integer

infoExists¶

Gets the infoExists of this ContainerAcquisitionOutput.

Returns: The infoExists of this ContainerAcquisitionOutput.
Return type: logical

permissions¶

Gets the permissions of this ContainerAcquisitionOutput.

Returns: The permissions of this ContainerAcquisitionOutput.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this ContainerAcquisitionOutput.

Returns: The notes of this ContainerAcquisitionOutput.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ContainerAcquisitionOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this ContainerAcquisitionOutput.

Returns: The analyses of this ContainerAcquisitionOutput.
Return type: AnalysisOutput

ContainerAnalysisOutput¶

class ContainerAnalysisOutput¶

id¶

Unique database ID

Returns: The id of this ContainerAnalysisOutput.
Return type: char

inputs¶

Gets the inputs of this ContainerAnalysisOutput.

Returns: The inputs of this ContainerAnalysisOutput.
Return type: FileEntry

files¶

Gets the files of this ContainerAnalysisOutput.

Returns: The files of this ContainerAnalysisOutput.
Return type: FileEntry

job¶

Gets the job of this ContainerAnalysisOutput.

Returns: The job of this ContainerAnalysisOutput.
Return type: Job

gearInfo¶

Gets the gearInfo of this ContainerAnalysisOutput.

Returns: The gearInfo of this ContainerAnalysisOutput.
Return type: GearInfo

notes¶

Gets the notes of this ContainerAnalysisOutput.

Returns: The notes of this ContainerAnalysisOutput.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ContainerAnalysisOutput.
Return type: vector[char]

info¶

Gets the info of this ContainerAnalysisOutput.

Returns: The info of this ContainerAnalysisOutput.
Return type: CommonInfo

description¶

Gets the description of this ContainerAnalysisOutput.

Returns: The description of this ContainerAnalysisOutput.
Return type: char

label¶

Application-specific label

Returns: The label of this ContainerAnalysisOutput.
Return type: char

parent¶

Gets the parent of this ContainerAnalysisOutput.

Returns: The parent of this ContainerAnalysisOutput.
Return type: ContainerReference

parents¶

Gets the parents of this ContainerAnalysisOutput.

Returns: The parents of this ContainerAnalysisOutput.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this ContainerAnalysisOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerAnalysisOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerAnalysisOutput.
Return type: integer

ContainerCollectionOutput¶

class ContainerCollectionOutput¶

label¶

Application-specific label

Returns: The label of this ContainerCollectionOutput.
Return type: char

info¶

Gets the info of this ContainerCollectionOutput.

Returns: The info of this ContainerCollectionOutput.
Return type: CommonInfo

description¶

Gets the description of this ContainerCollectionOutput.

Returns: The description of this ContainerCollectionOutput.
Return type: char

contents¶

Gets the contents of this ContainerCollectionOutput.

Returns: The contents of this ContainerCollectionOutput.
Return type: CollectionOperation

id¶

Unique database ID

Returns: The id of this ContainerCollectionOutput.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ContainerCollectionOutput.
Return type: logical

curator¶

Database ID of a user

Returns: The curator of this ContainerCollectionOutput.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this ContainerCollectionOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerCollectionOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerCollectionOutput.
Return type: integer

permissions¶

Gets the permissions of this ContainerCollectionOutput.

Returns: The permissions of this ContainerCollectionOutput.
Return type: RolesRoleAssignment

files¶

Gets the files of this ContainerCollectionOutput.

Returns: The files of this ContainerCollectionOutput.
Return type: FileEntry

notes¶

Gets the notes of this ContainerCollectionOutput.

Returns: The notes of this ContainerCollectionOutput.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ContainerCollectionOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this ContainerCollectionOutput.

Returns: The analyses of this ContainerCollectionOutput.
Return type: AnalysisOutput

ContainerFileOutput¶

class ContainerFileOutput¶

id¶

Gets the id of this ContainerFileOutput.

Returns: The id of this ContainerFileOutput.
Return type: char

fileId¶

Unique database ID

Returns: The fileId of this ContainerFileOutput.
Return type: char

version¶

Version of the file

Returns: The version of this ContainerFileOutput.
Return type: integer

name¶

The name of the file on disk

Returns: The name of this ContainerFileOutput.
Return type: char

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this ContainerFileOutput.
Return type: char

mimetype¶

A MIME Content-Type of the file

Returns: The mimetype of this ContainerFileOutput.
Return type: char

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this ContainerFileOutput.
Return type: char

deidLogId¶

The UUID of the de-id log

Returns: The deidLogId of this ContainerFileOutput.
Return type: char

classification¶

Gets the classification of this ContainerFileOutput.

Returns: The classification of this ContainerFileOutput.
Return type: CommonClassification

tags¶

Array of application-specific tags

Returns: The tags of this ContainerFileOutput.
Return type: vector[char]

info¶

Gets the info of this ContainerFileOutput.

Returns: The info of this ContainerFileOutput.
Return type: CommonInfo

origin¶

Gets the origin of this ContainerFileOutput.

Returns: The origin of this ContainerFileOutput.
Return type: FileOrigin

hash¶

Cryptographic hash of the file

Returns: The hash of this ContainerFileOutput.
Return type: char

parents¶

Gets the parents of this ContainerFileOutput.

Returns: The parents of this ContainerFileOutput.
Return type: ContainerParents

parentRef¶

Gets the parentRef of this ContainerFileOutput.

Returns: The parentRef of this ContainerFileOutput.
Return type: ContainerReference

providerId¶

Unique database ID

Returns: The providerId of this ContainerFileOutput.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this ContainerFileOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerFileOutput.
Return type: datetime

replaced¶

Last replaced time (automatically updated)

Returns: The replaced of this ContainerFileOutput.
Return type: datetime

size¶

Size of the file, in bytes

Returns: The size of this ContainerFileOutput.
Return type: integer

infoExists¶

Gets the infoExists of this ContainerFileOutput.

Returns: The infoExists of this ContainerFileOutput.
Return type: logical

zipMemberCount¶

Number of entries in the zip archive

Returns: The zipMemberCount of this ContainerFileOutput.
Return type: integer

ContainerGroupOutput¶

class ContainerGroupOutput¶

id¶

Gets the id of this ContainerGroupOutput.

Returns: The id of this ContainerGroupOutput.
Return type: char

label¶

The group label

Returns: The label of this ContainerGroupOutput.
Return type: char

permissionsTemplate¶

Gets the permissionsTemplate of this ContainerGroupOutput.

Returns: The permissionsTemplate of this ContainerGroupOutput.
Return type: RolesRoleAssignment

roles¶

Gets the roles of this ContainerGroupOutput.

Returns: The roles of this ContainerGroupOutput.
Return type: vector[char]

permissions¶

Gets the permissions of this ContainerGroupOutput.

Returns: The permissions of this ContainerGroupOutput.
Return type: PermissionAccessPermission

created¶

Creation time (automatically set)

Returns: The created of this ContainerGroupOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerGroupOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerGroupOutput.
Return type: integer

tags¶

Array of application-specific tags

Returns: The tags of this ContainerGroupOutput.
Return type: vector[char]

providers¶

Gets the providers of this ContainerGroupOutput.

Returns: The providers of this ContainerGroupOutput.
Return type: ProviderLinks

editions¶

Gets the editions of this ContainerGroupOutput.

Returns: The editions of this ContainerGroupOutput.
Return type: CommonEditions

ContainerProjectOutput¶

class ContainerProjectOutput¶

label¶

Application-specific label

Returns: The label of this ContainerProjectOutput.
Return type: char

info¶

Gets the info of this ContainerProjectOutput.

Returns: The info of this ContainerProjectOutput.
Return type: CommonInfo

description¶

Gets the description of this ContainerProjectOutput.

Returns: The description of this ContainerProjectOutput.
Return type: char

group¶

Gets the group of this ContainerProjectOutput.

Returns: The group of this ContainerProjectOutput.
Return type: char

providers¶

Gets the providers of this ContainerProjectOutput.

Returns: The providers of this ContainerProjectOutput.
Return type: ProviderLinks

editions¶

Gets the editions of this ContainerProjectOutput.

Returns: The editions of this ContainerProjectOutput.
Return type: CommonEditions

ldapSync¶

Gets the ldapSync of this ContainerProjectOutput.

Returns: The ldapSync of this ContainerProjectOutput.
Return type: LdapSync

id¶

Unique database ID

Returns: The id of this ContainerProjectOutput.
Return type: char

parents¶

Gets the parents of this ContainerProjectOutput.

Returns: The parents of this ContainerProjectOutput.
Return type: ContainerParents

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ContainerProjectOutput.
Return type: logical

created¶

Creation time (automatically set)

Returns: The created of this ContainerProjectOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerProjectOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerProjectOutput.
Return type: integer

templates¶

Gets the templates of this ContainerProjectOutput.

Returns: The templates of this ContainerProjectOutput.
Return type: containers.Map

permissions¶

Gets the permissions of this ContainerProjectOutput.

Returns: The permissions of this ContainerProjectOutput.
Return type: RolesBackwardsCompatibleRoleAssignment

files¶

Gets the files of this ContainerProjectOutput.

Returns: The files of this ContainerProjectOutput.
Return type: FileEntry

notes¶

Gets the notes of this ContainerProjectOutput.

Returns: The notes of this ContainerProjectOutput.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ContainerProjectOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this ContainerProjectOutput.

Returns: The analyses of this ContainerProjectOutput.
Return type: AnalysisOutput

ContainerSessionOutput¶

class ContainerSessionOutput¶

operator¶

The name of the operator

Returns: The operator of this ContainerSessionOutput.
Return type: char

label¶

Application-specific label

Returns: The label of this ContainerSessionOutput.
Return type: char

info¶

Gets the info of this ContainerSessionOutput.

Returns: The info of this ContainerSessionOutput.
Return type: CommonInfo

project¶

Unique database ID

Returns: The project of this ContainerSessionOutput.
Return type: char

uid¶

A user database ID

Returns: The uid of this ContainerSessionOutput.
Return type: char

timestamp¶

Gets the timestamp of this ContainerSessionOutput.

Returns: The timestamp of this ContainerSessionOutput.
Return type: datetime

timezone¶

Gets the timezone of this ContainerSessionOutput.

Returns: The timezone of this ContainerSessionOutput.
Return type: char

subject¶

Gets the subject of this ContainerSessionOutput.

Returns: The subject of this ContainerSessionOutput.
Return type: Subject

age¶

Subject age at time of session, in seconds

Returns: The age of this ContainerSessionOutput.
Return type: integer

weight¶

Subject weight at time of session, in kilograms

Returns: The weight of this ContainerSessionOutput.
Return type: float

id¶

Unique database ID

Returns: The id of this ContainerSessionOutput.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ContainerSessionOutput.
Return type: logical

parents¶

Gets the parents of this ContainerSessionOutput.

Returns: The parents of this ContainerSessionOutput.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this ContainerSessionOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerSessionOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerSessionOutput.
Return type: integer

permissions¶

Gets the permissions of this ContainerSessionOutput.

Returns: The permissions of this ContainerSessionOutput.
Return type: RolesBackwardsCompatibleRoleAssignment

group¶

Gets the group of this ContainerSessionOutput.

Returns: The group of this ContainerSessionOutput.
Return type: char

projectHasTemplate¶

Gets the projectHasTemplate of this ContainerSessionOutput.

Returns: The projectHasTemplate of this ContainerSessionOutput.
Return type: logical

satisfiesTemplate¶

Gets the satisfiesTemplate of this ContainerSessionOutput.

Returns: The satisfiesTemplate of this ContainerSessionOutput.
Return type: logical

files¶

Gets the files of this ContainerSessionOutput.

Returns: The files of this ContainerSessionOutput.
Return type: FileEntry

notes¶

Gets the notes of this ContainerSessionOutput.

Returns: The notes of this ContainerSessionOutput.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ContainerSessionOutput.
Return type: vector[char]

analyses¶

Gets the analyses of this ContainerSessionOutput.

Returns: The analyses of this ContainerSessionOutput.
Return type: AnalysisOutput

ContainerSubjectOutput¶

class ContainerSubjectOutput¶

id¶

Unique database ID

Returns: The id of this ContainerSubjectOutput.
Return type: char

project¶

Unique database ID

Returns: The project of this ContainerSubjectOutput.
Return type: char

firstname¶

First name

Returns: The firstname of this ContainerSubjectOutput.
Return type: char

lastname¶

Last name

Returns: The lastname of this ContainerSubjectOutput.
Return type: char

age¶

Age at time of session, in seconds

Returns: The age of this ContainerSubjectOutput.
Return type: integer

sex¶

Gets the sex of this ContainerSubjectOutput.

Returns: The sex of this ContainerSubjectOutput.
Return type: char

cohort¶

Gets the cohort of this ContainerSubjectOutput.

Returns: The cohort of this ContainerSubjectOutput.
Return type: char

mlset¶

Gets the mlset of this ContainerSubjectOutput.

Returns: The mlset of this ContainerSubjectOutput.
Return type: char

type¶

Gets the type of this ContainerSubjectOutput.

Returns: The type of this ContainerSubjectOutput.
Return type: char

race¶

Gets the race of this ContainerSubjectOutput.

Returns: The race of this ContainerSubjectOutput.
Return type: char

ethnicity¶

Gets the ethnicity of this ContainerSubjectOutput.

Returns: The ethnicity of this ContainerSubjectOutput.
Return type: char

species¶

Gets the species of this ContainerSubjectOutput.

Returns: The species of this ContainerSubjectOutput.
Return type: char

strain¶

Gets the strain of this ContainerSubjectOutput.

Returns: The strain of this ContainerSubjectOutput.
Return type: char

label¶

A unique identifier for the subject

Returns: The label of this ContainerSubjectOutput.
Return type: char

code¶

A unique identifier for the subject

Returns: The code of this ContainerSubjectOutput.
Return type: char

masterCode¶

A unique identifier for the subject

Returns: The masterCode of this ContainerSubjectOutput.
Return type: char

tags¶

Array of application-specific tags

Returns: The tags of this ContainerSubjectOutput.
Return type: vector[char]

info¶

Gets the info of this ContainerSubjectOutput.

Returns: The info of this ContainerSubjectOutput.
Return type: CommonInfo

files¶

Gets the files of this ContainerSubjectOutput.

Returns: The files of this ContainerSubjectOutput.
Return type: FileEntry

parents¶

Gets the parents of this ContainerSubjectOutput.

Returns: The parents of this ContainerSubjectOutput.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this ContainerSubjectOutput.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ContainerSubjectOutput.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ContainerSubjectOutput.
Return type: integer

permissions¶

Gets the permissions of this ContainerSubjectOutput.

Returns: The permissions of this ContainerSubjectOutput.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this ContainerSubjectOutput.

Returns: The notes of this ContainerSubjectOutput.
Return type: Note

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ContainerSubjectOutput.
Return type: logical

analyses¶

Gets the analyses of this ContainerSubjectOutput.

Returns: The analyses of this ContainerSubjectOutput.
Return type: AnalysisOutput

ResolverAcquisitionNode¶

class ResolverAcquisitionNode¶

label¶

Application-specific label

Returns: The label of this ResolverAcquisitionNode.
Return type: char

info¶

Gets the info of this ResolverAcquisitionNode.

Returns: The info of this ResolverAcquisitionNode.
Return type: CommonInfo

session¶

Unique database ID

Returns: The session of this ResolverAcquisitionNode.
Return type: char

uid¶

A user database ID

Returns: The uid of this ResolverAcquisitionNode.
Return type: char

timestamp¶

Gets the timestamp of this ResolverAcquisitionNode.

Returns: The timestamp of this ResolverAcquisitionNode.
Return type: datetime

timezone¶

Gets the timezone of this ResolverAcquisitionNode.

Returns: The timezone of this ResolverAcquisitionNode.
Return type: char

id¶

Unique database ID

Returns: The id of this ResolverAcquisitionNode.
Return type: char

parents¶

Gets the parents of this ResolverAcquisitionNode.

Returns: The parents of this ResolverAcquisitionNode.
Return type: ContainerParents

collections¶

Gets the collections of this ResolverAcquisitionNode.

Returns: The collections of this ResolverAcquisitionNode.
Return type: vector[char]

files¶

Gets the files of this ResolverAcquisitionNode.

Returns: The files of this ResolverAcquisitionNode.
Return type: FileEntry

created¶

Creation time (automatically set)

Returns: The created of this ResolverAcquisitionNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverAcquisitionNode.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ResolverAcquisitionNode.
Return type: integer

infoExists¶

Gets the infoExists of this ResolverAcquisitionNode.

Returns: The infoExists of this ResolverAcquisitionNode.
Return type: logical

permissions¶

Gets the permissions of this ResolverAcquisitionNode.

Returns: The permissions of this ResolverAcquisitionNode.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this ResolverAcquisitionNode.

Returns: The notes of this ResolverAcquisitionNode.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ResolverAcquisitionNode.
Return type: vector[char]

analyses¶

Gets the analyses of this ResolverAcquisitionNode.

Returns: The analyses of this ResolverAcquisitionNode.
Return type: AnalysisOutput

ResolverAnalysisNode¶

class ResolverAnalysisNode¶

id¶

Unique database ID

Returns: The id of this ResolverAnalysisNode.
Return type: char

inputs¶

Gets the inputs of this ResolverAnalysisNode.

Returns: The inputs of this ResolverAnalysisNode.
Return type: FileEntry

files¶

Gets the files of this ResolverAnalysisNode.

Returns: The files of this ResolverAnalysisNode.
Return type: FileEntry

job¶

Gets the job of this ResolverAnalysisNode.

Returns: The job of this ResolverAnalysisNode.
Return type: Job

gearInfo¶

Gets the gearInfo of this ResolverAnalysisNode.

Returns: The gearInfo of this ResolverAnalysisNode.
Return type: GearInfo

notes¶

Gets the notes of this ResolverAnalysisNode.

Returns: The notes of this ResolverAnalysisNode.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ResolverAnalysisNode.
Return type: vector[char]

info¶

Gets the info of this ResolverAnalysisNode.

Returns: The info of this ResolverAnalysisNode.
Return type: CommonInfo

description¶

Gets the description of this ResolverAnalysisNode.

Returns: The description of this ResolverAnalysisNode.
Return type: char

label¶

Application-specific label

Returns: The label of this ResolverAnalysisNode.
Return type: char

parent¶

Gets the parent of this ResolverAnalysisNode.

Returns: The parent of this ResolverAnalysisNode.
Return type: ContainerReference

parents¶

Gets the parents of this ResolverAnalysisNode.

Returns: The parents of this ResolverAnalysisNode.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this ResolverAnalysisNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverAnalysisNode.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ResolverAnalysisNode.
Return type: integer

ResolverFileNode¶

class ResolverFileNode¶

id¶

Gets the id of this ResolverFileNode.

Returns: The id of this ResolverFileNode.
Return type: char

fileId¶

Unique database ID

Returns: The fileId of this ResolverFileNode.
Return type: char

version¶

Version of the file

Returns: The version of this ResolverFileNode.
Return type: integer

name¶

The name of the file on disk

Returns: The name of this ResolverFileNode.
Return type: char

type¶

A descriptive file type (e.g. dicom, image, document, …)

Returns: The type of this ResolverFileNode.
Return type: char

mimetype¶

A MIME Content-Type of the file

Returns: The mimetype of this ResolverFileNode.
Return type: char

modality¶

The type of instrument that originated the file (e.g. MR, CT, …)

Returns: The modality of this ResolverFileNode.
Return type: char

deidLogId¶

The UUID of the de-id log

Returns: The deidLogId of this ResolverFileNode.
Return type: char

classification¶

Gets the classification of this ResolverFileNode.

Returns: The classification of this ResolverFileNode.
Return type: CommonClassification

tags¶

Array of application-specific tags

Returns: The tags of this ResolverFileNode.
Return type: vector[char]

info¶

Gets the info of this ResolverFileNode.

Returns: The info of this ResolverFileNode.
Return type: CommonInfo

origin¶

Gets the origin of this ResolverFileNode.

Returns: The origin of this ResolverFileNode.
Return type: FileOrigin

hash¶

Cryptographic hash of the file

Returns: The hash of this ResolverFileNode.
Return type: char

parents¶

Gets the parents of this ResolverFileNode.

Returns: The parents of this ResolverFileNode.
Return type: ContainerParents

parentRef¶

Gets the parentRef of this ResolverFileNode.

Returns: The parentRef of this ResolverFileNode.
Return type: ContainerReference

providerId¶

Unique database ID

Returns: The providerId of this ResolverFileNode.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this ResolverFileNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverFileNode.
Return type: datetime

replaced¶

Last replaced time (automatically updated)

Returns: The replaced of this ResolverFileNode.
Return type: datetime

size¶

Size of the file, in bytes

Returns: The size of this ResolverFileNode.
Return type: integer

infoExists¶

Gets the infoExists of this ResolverFileNode.

Returns: The infoExists of this ResolverFileNode.
Return type: logical

zipMemberCount¶

Number of entries in the zip archive

Returns: The zipMemberCount of this ResolverFileNode.
Return type: integer

ResolverGearNode¶

class ResolverGearNode¶

id¶

Unique database ID

Returns: The id of this ResolverGearNode.
Return type: char

category¶

The gear category

Returns: The category of this ResolverGearNode.
Return type: char

gear¶

Gets the gear of this ResolverGearNode.

Returns: The gear of this ResolverGearNode.
Return type: Gear

exchange¶

Gets the exchange of this ResolverGearNode.

Returns: The exchange of this ResolverGearNode.
Return type: GearExchange

created¶

Creation time (automatically set)

Returns: The created of this ResolverGearNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverGearNode.
Return type: datetime

ResolverGroupNode¶

class ResolverGroupNode¶

id¶

Gets the id of this ResolverGroupNode.

Returns: The id of this ResolverGroupNode.
Return type: char

label¶

The group label

Returns: The label of this ResolverGroupNode.
Return type: char

permissionsTemplate¶

Gets the permissionsTemplate of this ResolverGroupNode.

Returns: The permissionsTemplate of this ResolverGroupNode.
Return type: RolesRoleAssignment

roles¶

Gets the roles of this ResolverGroupNode.

Returns: The roles of this ResolverGroupNode.
Return type: vector[char]

permissions¶

Gets the permissions of this ResolverGroupNode.

Returns: The permissions of this ResolverGroupNode.
Return type: PermissionAccessPermission

created¶

Creation time (automatically set)

Returns: The created of this ResolverGroupNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverGroupNode.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ResolverGroupNode.
Return type: integer

tags¶

Array of application-specific tags

Returns: The tags of this ResolverGroupNode.
Return type: vector[char]

providers¶

Gets the providers of this ResolverGroupNode.

Returns: The providers of this ResolverGroupNode.
Return type: ProviderLinks

editions¶

Gets the editions of this ResolverGroupNode.

Returns: The editions of this ResolverGroupNode.
Return type: CommonEditions

ResolverProjectNode¶

class ResolverProjectNode¶

label¶

Application-specific label

Returns: The label of this ResolverProjectNode.
Return type: char

info¶

Gets the info of this ResolverProjectNode.

Returns: The info of this ResolverProjectNode.
Return type: CommonInfo

description¶

Gets the description of this ResolverProjectNode.

Returns: The description of this ResolverProjectNode.
Return type: char

group¶

Gets the group of this ResolverProjectNode.

Returns: The group of this ResolverProjectNode.
Return type: char

providers¶

Gets the providers of this ResolverProjectNode.

Returns: The providers of this ResolverProjectNode.
Return type: ProviderLinks

editions¶

Gets the editions of this ResolverProjectNode.

Returns: The editions of this ResolverProjectNode.
Return type: CommonEditions

ldapSync¶

Gets the ldapSync of this ResolverProjectNode.

Returns: The ldapSync of this ResolverProjectNode.
Return type: LdapSync

id¶

Unique database ID

Returns: The id of this ResolverProjectNode.
Return type: char

parents¶

Gets the parents of this ResolverProjectNode.

Returns: The parents of this ResolverProjectNode.
Return type: ContainerParents

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ResolverProjectNode.
Return type: logical

created¶

Creation time (automatically set)

Returns: The created of this ResolverProjectNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverProjectNode.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ResolverProjectNode.
Return type: integer

templates¶

Gets the templates of this ResolverProjectNode.

Returns: The templates of this ResolverProjectNode.
Return type: containers.Map

permissions¶

Gets the permissions of this ResolverProjectNode.

Returns: The permissions of this ResolverProjectNode.
Return type: RolesBackwardsCompatibleRoleAssignment

files¶

Gets the files of this ResolverProjectNode.

Returns: The files of this ResolverProjectNode.
Return type: FileEntry

notes¶

Gets the notes of this ResolverProjectNode.

Returns: The notes of this ResolverProjectNode.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ResolverProjectNode.
Return type: vector[char]

analyses¶

Gets the analyses of this ResolverProjectNode.

Returns: The analyses of this ResolverProjectNode.
Return type: AnalysisOutput

ResolverSessionNode¶

class ResolverSessionNode¶

operator¶

The name of the operator

Returns: The operator of this ResolverSessionNode.
Return type: char

label¶

Application-specific label

Returns: The label of this ResolverSessionNode.
Return type: char

info¶

Gets the info of this ResolverSessionNode.

Returns: The info of this ResolverSessionNode.
Return type: CommonInfo

project¶

Unique database ID

Returns: The project of this ResolverSessionNode.
Return type: char

uid¶

A user database ID

Returns: The uid of this ResolverSessionNode.
Return type: char

timestamp¶

Gets the timestamp of this ResolverSessionNode.

Returns: The timestamp of this ResolverSessionNode.
Return type: datetime

timezone¶

Gets the timezone of this ResolverSessionNode.

Returns: The timezone of this ResolverSessionNode.
Return type: char

subject¶

Gets the subject of this ResolverSessionNode.

Returns: The subject of this ResolverSessionNode.
Return type: Subject

age¶

Subject age at time of session, in seconds

Returns: The age of this ResolverSessionNode.
Return type: integer

weight¶

Subject weight at time of session, in kilograms

Returns: The weight of this ResolverSessionNode.
Return type: float

id¶

Unique database ID

Returns: The id of this ResolverSessionNode.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ResolverSessionNode.
Return type: logical

parents¶

Gets the parents of this ResolverSessionNode.

Returns: The parents of this ResolverSessionNode.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this ResolverSessionNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverSessionNode.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ResolverSessionNode.
Return type: integer

permissions¶

Gets the permissions of this ResolverSessionNode.

Returns: The permissions of this ResolverSessionNode.
Return type: RolesBackwardsCompatibleRoleAssignment

group¶

Gets the group of this ResolverSessionNode.

Returns: The group of this ResolverSessionNode.
Return type: char

projectHasTemplate¶

Gets the projectHasTemplate of this ResolverSessionNode.

Returns: The projectHasTemplate of this ResolverSessionNode.
Return type: logical

satisfiesTemplate¶

Gets the satisfiesTemplate of this ResolverSessionNode.

Returns: The satisfiesTemplate of this ResolverSessionNode.
Return type: logical

files¶

Gets the files of this ResolverSessionNode.

Returns: The files of this ResolverSessionNode.
Return type: FileEntry

notes¶

Gets the notes of this ResolverSessionNode.

Returns: The notes of this ResolverSessionNode.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this ResolverSessionNode.
Return type: vector[char]

analyses¶

Gets the analyses of this ResolverSessionNode.

Returns: The analyses of this ResolverSessionNode.
Return type: AnalysisOutput

ResolverSubjectNode¶

class ResolverSubjectNode¶

id¶

Unique database ID

Returns: The id of this ResolverSubjectNode.
Return type: char

project¶

Unique database ID

Returns: The project of this ResolverSubjectNode.
Return type: char

firstname¶

First name

Returns: The firstname of this ResolverSubjectNode.
Return type: char

lastname¶

Last name

Returns: The lastname of this ResolverSubjectNode.
Return type: char

age¶

Age at time of session, in seconds

Returns: The age of this ResolverSubjectNode.
Return type: integer

sex¶

Gets the sex of this ResolverSubjectNode.

Returns: The sex of this ResolverSubjectNode.
Return type: char

cohort¶

Gets the cohort of this ResolverSubjectNode.

Returns: The cohort of this ResolverSubjectNode.
Return type: char

mlset¶

Gets the mlset of this ResolverSubjectNode.

Returns: The mlset of this ResolverSubjectNode.
Return type: char

type¶

Gets the type of this ResolverSubjectNode.

Returns: The type of this ResolverSubjectNode.
Return type: char

race¶

Gets the race of this ResolverSubjectNode.

Returns: The race of this ResolverSubjectNode.
Return type: char

ethnicity¶

Gets the ethnicity of this ResolverSubjectNode.

Returns: The ethnicity of this ResolverSubjectNode.
Return type: char

species¶

Gets the species of this ResolverSubjectNode.

Returns: The species of this ResolverSubjectNode.
Return type: char

strain¶

Gets the strain of this ResolverSubjectNode.

Returns: The strain of this ResolverSubjectNode.
Return type: char

label¶

A unique identifier for the subject

Returns: The label of this ResolverSubjectNode.
Return type: char

code¶

A unique identifier for the subject

Returns: The code of this ResolverSubjectNode.
Return type: char

masterCode¶

A unique identifier for the subject

Returns: The masterCode of this ResolverSubjectNode.
Return type: char

tags¶

Array of application-specific tags

Returns: The tags of this ResolverSubjectNode.
Return type: vector[char]

info¶

Gets the info of this ResolverSubjectNode.

Returns: The info of this ResolverSubjectNode.
Return type: CommonInfo

files¶

Gets the files of this ResolverSubjectNode.

Returns: The files of this ResolverSubjectNode.
Return type: FileEntry

parents¶

Gets the parents of this ResolverSubjectNode.

Returns: The parents of this ResolverSubjectNode.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this ResolverSubjectNode.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this ResolverSubjectNode.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this ResolverSubjectNode.
Return type: integer

permissions¶

Gets the permissions of this ResolverSubjectNode.

Returns: The permissions of this ResolverSubjectNode.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this ResolverSubjectNode.

Returns: The notes of this ResolverSubjectNode.
Return type: Note

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this ResolverSubjectNode.
Return type: logical

analyses¶

Gets the analyses of this ResolverSubjectNode.

Returns: The analyses of this ResolverSubjectNode.
Return type: AnalysisOutput

SearchParentAcquisition¶

class SearchParentAcquisition¶

label¶

Application-specific label

Returns: The label of this SearchParentAcquisition.
Return type: char

info¶

Gets the info of this SearchParentAcquisition.

Returns: The info of this SearchParentAcquisition.
Return type: CommonInfo

session¶

Unique database ID

Returns: The session of this SearchParentAcquisition.
Return type: char

uid¶

A user database ID

Returns: The uid of this SearchParentAcquisition.
Return type: char

timestamp¶

Gets the timestamp of this SearchParentAcquisition.

Returns: The timestamp of this SearchParentAcquisition.
Return type: datetime

timezone¶

Gets the timezone of this SearchParentAcquisition.

Returns: The timezone of this SearchParentAcquisition.
Return type: char

id¶

Unique database ID

Returns: The id of this SearchParentAcquisition.
Return type: char

parents¶

Gets the parents of this SearchParentAcquisition.

Returns: The parents of this SearchParentAcquisition.
Return type: ContainerParents

collections¶

Gets the collections of this SearchParentAcquisition.

Returns: The collections of this SearchParentAcquisition.
Return type: vector[char]

files¶

Gets the files of this SearchParentAcquisition.

Returns: The files of this SearchParentAcquisition.
Return type: FileEntry

created¶

Creation time (automatically set)

Returns: The created of this SearchParentAcquisition.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchParentAcquisition.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this SearchParentAcquisition.
Return type: integer

infoExists¶

Gets the infoExists of this SearchParentAcquisition.

Returns: The infoExists of this SearchParentAcquisition.
Return type: logical

permissions¶

Gets the permissions of this SearchParentAcquisition.

Returns: The permissions of this SearchParentAcquisition.
Return type: RolesBackwardsCompatibleRoleAssignment

notes¶

Gets the notes of this SearchParentAcquisition.

Returns: The notes of this SearchParentAcquisition.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this SearchParentAcquisition.
Return type: vector[char]

analyses¶

Gets the analyses of this SearchParentAcquisition.

Returns: The analyses of this SearchParentAcquisition.
Return type: AnalysisOutput

SearchParentAnalysis¶

class SearchParentAnalysis¶

id¶

Unique database ID

Returns: The id of this SearchParentAnalysis.
Return type: char

inputs¶

Gets the inputs of this SearchParentAnalysis.

Returns: The inputs of this SearchParentAnalysis.
Return type: FileEntry

files¶

Gets the files of this SearchParentAnalysis.

Returns: The files of this SearchParentAnalysis.
Return type: FileEntry

job¶

Gets the job of this SearchParentAnalysis.

Returns: The job of this SearchParentAnalysis.
Return type: Job

gearInfo¶

Gets the gearInfo of this SearchParentAnalysis.

Returns: The gearInfo of this SearchParentAnalysis.
Return type: GearInfo

notes¶

Gets the notes of this SearchParentAnalysis.

Returns: The notes of this SearchParentAnalysis.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this SearchParentAnalysis.
Return type: vector[char]

info¶

Gets the info of this SearchParentAnalysis.

Returns: The info of this SearchParentAnalysis.
Return type: CommonInfo

description¶

Gets the description of this SearchParentAnalysis.

Returns: The description of this SearchParentAnalysis.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchParentAnalysis.
Return type: char

parent¶

Gets the parent of this SearchParentAnalysis.

Returns: The parent of this SearchParentAnalysis.
Return type: ContainerReference

parents¶

Gets the parents of this SearchParentAnalysis.

Returns: The parents of this SearchParentAnalysis.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this SearchParentAnalysis.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchParentAnalysis.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this SearchParentAnalysis.
Return type: integer

SearchParentCollection¶

class SearchParentCollection¶

label¶

Application-specific label

Returns: The label of this SearchParentCollection.
Return type: char

info¶

Gets the info of this SearchParentCollection.

Returns: The info of this SearchParentCollection.
Return type: CommonInfo

description¶

Gets the description of this SearchParentCollection.

Returns: The description of this SearchParentCollection.
Return type: char

contents¶

Gets the contents of this SearchParentCollection.

Returns: The contents of this SearchParentCollection.
Return type: CollectionOperation

id¶

Unique database ID

Returns: The id of this SearchParentCollection.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this SearchParentCollection.
Return type: logical

curator¶

Database ID of a user

Returns: The curator of this SearchParentCollection.
Return type: char

created¶

Creation time (automatically set)

Returns: The created of this SearchParentCollection.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchParentCollection.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this SearchParentCollection.
Return type: integer

permissions¶

Gets the permissions of this SearchParentCollection.

Returns: The permissions of this SearchParentCollection.
Return type: RolesRoleAssignment

files¶

Gets the files of this SearchParentCollection.

Returns: The files of this SearchParentCollection.
Return type: FileEntry

notes¶

Gets the notes of this SearchParentCollection.

Returns: The notes of this SearchParentCollection.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this SearchParentCollection.
Return type: vector[char]

analyses¶

Gets the analyses of this SearchParentCollection.

Returns: The analyses of this SearchParentCollection.
Return type: AnalysisOutput

SearchParentGroup¶

class SearchParentGroup¶

id¶

Gets the id of this SearchParentGroup.

Returns: The id of this SearchParentGroup.
Return type: char

label¶

The group label

Returns: The label of this SearchParentGroup.
Return type: char

permissionsTemplate¶

Gets the permissionsTemplate of this SearchParentGroup.

Returns: The permissionsTemplate of this SearchParentGroup.
Return type: RolesRoleAssignment

roles¶

Gets the roles of this SearchParentGroup.

Returns: The roles of this SearchParentGroup.
Return type: vector[char]

permissions¶

Gets the permissions of this SearchParentGroup.

Returns: The permissions of this SearchParentGroup.
Return type: PermissionAccessPermission

created¶

Creation time (automatically set)

Returns: The created of this SearchParentGroup.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchParentGroup.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this SearchParentGroup.
Return type: integer

tags¶

Array of application-specific tags

Returns: The tags of this SearchParentGroup.
Return type: vector[char]

providers¶

Gets the providers of this SearchParentGroup.

Returns: The providers of this SearchParentGroup.
Return type: ProviderLinks

editions¶

Gets the editions of this SearchParentGroup.

Returns: The editions of this SearchParentGroup.
Return type: CommonEditions

SearchParentProject¶

class SearchParentProject¶

label¶

Application-specific label

Returns: The label of this SearchParentProject.
Return type: char

info¶

Gets the info of this SearchParentProject.

Returns: The info of this SearchParentProject.
Return type: CommonInfo

description¶

Gets the description of this SearchParentProject.

Returns: The description of this SearchParentProject.
Return type: char

group¶

Gets the group of this SearchParentProject.

Returns: The group of this SearchParentProject.
Return type: char

providers¶

Gets the providers of this SearchParentProject.

Returns: The providers of this SearchParentProject.
Return type: ProviderLinks

editions¶

Gets the editions of this SearchParentProject.

Returns: The editions of this SearchParentProject.
Return type: CommonEditions

ldapSync¶

Gets the ldapSync of this SearchParentProject.

Returns: The ldapSync of this SearchParentProject.
Return type: LdapSync

id¶

Unique database ID

Returns: The id of this SearchParentProject.
Return type: char

parents¶

Gets the parents of this SearchParentProject.

Returns: The parents of this SearchParentProject.
Return type: ContainerParents

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this SearchParentProject.
Return type: logical

created¶

Creation time (automatically set)

Returns: The created of this SearchParentProject.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchParentProject.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this SearchParentProject.
Return type: integer

templates¶

Gets the templates of this SearchParentProject.

Returns: The templates of this SearchParentProject.
Return type: containers.Map

permissions¶

Gets the permissions of this SearchParentProject.

Returns: The permissions of this SearchParentProject.
Return type: RolesBackwardsCompatibleRoleAssignment

files¶

Gets the files of this SearchParentProject.

Returns: The files of this SearchParentProject.
Return type: FileEntry

notes¶

Gets the notes of this SearchParentProject.

Returns: The notes of this SearchParentProject.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this SearchParentProject.
Return type: vector[char]

analyses¶

Gets the analyses of this SearchParentProject.

Returns: The analyses of this SearchParentProject.
Return type: AnalysisOutput

SearchParentSession¶

class SearchParentSession¶

operator¶

The name of the operator

Returns: The operator of this SearchParentSession.
Return type: char

label¶

Application-specific label

Returns: The label of this SearchParentSession.
Return type: char

info¶

Gets the info of this SearchParentSession.

Returns: The info of this SearchParentSession.
Return type: CommonInfo

project¶

Unique database ID

Returns: The project of this SearchParentSession.
Return type: char

uid¶

A user database ID

Returns: The uid of this SearchParentSession.
Return type: char

timestamp¶

Gets the timestamp of this SearchParentSession.

Returns: The timestamp of this SearchParentSession.
Return type: datetime

timezone¶

Gets the timezone of this SearchParentSession.

Returns: The timezone of this SearchParentSession.
Return type: char

subject¶

Gets the subject of this SearchParentSession.

Returns: The subject of this SearchParentSession.
Return type: Subject

age¶

Subject age at time of session, in seconds

Returns: The age of this SearchParentSession.
Return type: integer

weight¶

Subject weight at time of session, in kilograms

Returns: The weight of this SearchParentSession.
Return type: float

id¶

Unique database ID

Returns: The id of this SearchParentSession.
Return type: char

infoExists¶

Flag that indicates whether or not info exists on this container

Returns: The infoExists of this SearchParentSession.
Return type: logical

parents¶

Gets the parents of this SearchParentSession.

Returns: The parents of this SearchParentSession.
Return type: ContainerParents

created¶

Creation time (automatically set)

Returns: The created of this SearchParentSession.
Return type: datetime

modified¶

Last modification time (automatically updated)

Returns: The modified of this SearchParentSession.
Return type: datetime

revision¶

An incremental document revision number

Returns: The revision of this SearchParentSession.
Return type: integer

permissions¶

Gets the permissions of this SearchParentSession.

Returns: The permissions of this SearchParentSession.
Return type: RolesBackwardsCompatibleRoleAssignment

group¶

Gets the group of this SearchParentSession.

Returns: The group of this SearchParentSession.
Return type: char

projectHasTemplate¶

Gets the projectHasTemplate of this SearchParentSession.

Returns: The projectHasTemplate of this SearchParentSession.
Return type: logical

satisfiesTemplate¶

Gets the satisfiesTemplate of this SearchParentSession.

Returns: The satisfiesTemplate of this SearchParentSession.
Return type: logical

files¶

Gets the files of this SearchParentSession.

Returns: The files of this SearchParentSession.
Return type: FileEntry

notes¶

Gets the notes of this SearchParentSession.

Returns: The notes of this SearchParentSession.
Return type: Note

tags¶

Array of application-specific tags

Returns: The tags of this SearchParentSession.
Return type: vector[char]

analyses¶

Gets the analyses of this SearchParentSession.

Returns: The analyses of this SearchParentSession.
Return type: AnalysisOutput