vsdConnect.models module¶

INFOS¶

python version: 3.5
connectVSD 0.8.1
module: models
@author: Michael Kistler 2016, Livia B.

CHANGES¶

implemented objects as jsonmodels

class models.APIBase(**kwargs)[source]¶

Bases: jsonmodels.models.Base

Basic for all classes with selfUrl

get()[source]¶

get the object as json readable structure (dict)

Returns:	json
Return type:	json

save(fp='object.json')[source]¶

save the object as json to the given filepath

Params Path fp:	the filepath to the file
Returns:	the path to the stored file
Return type:	Path

selfUrl¶: String field.

set(data)[source]¶

set the object content

Parameters:	data (json) – the data for the object in json format
Returns:	json
Return type:	json

show()[source]¶: show the object as json readable structure (dict), nicely formated

class models.APIBaseExt(**kwargs)[source]¶

Bases: models.APIBaseID

id, name, display name and selfUrl

displayName¶: String field.

name¶: String field.

class models.APIBaseID(**kwargs)[source]¶

Bases: models.APIBase

id and selfUrl

id¶: Integer field.

class models.APIBaseN3(**kwargs)[source]¶

Bases: models.APIBase

for semantic triple storage

object¶: Field for embedded models.

predicate¶: Field for embedded models.

subject¶: Field for embedded models.

class models.APIObject(**kwargs)[source]¶

Bases: models.APIBaseID

base object class

createdDate¶: String field.

description¶: String field.

downloadUrl¶

files¶: Field for embedded models.

license¶: Field for embedded models.

linkedObjectRelations¶: Field for embedded models.

linkedObjects¶: Field for embedded models.

name¶: String field.

objectGroupRights¶: List field.

objectPreviews¶: List field.

objectUserRights¶: List field.

ontologyCount¶: Integer field.

ontologyItemRelations¶: Field for embedded models.

ontologyItems¶: Field for embedded models.

type¶: Field for embedded models.

class models.APIVersion(**kwargs)[source]¶

Bases: jsonmodels.models.Base

the api version view model

build¶: Integer field.

major¶: Integer field.

majorRevision¶: Integer field.

minor¶: Integer field.

minorRevision¶: Integer field.

revision¶: Integer field.

class models.ClincalStudyDefinitionData(**kwargs)[source]¶

Bases: jsonmodels.models.Base

attributes for clinical study definition

metaDataVersionName¶: String field.

metaDataVersionOID¶: String field.

protocolName¶: String field.

studyDescription¶: String field.

studyName¶: String field.

studyOID¶: String field.

class models.ClinicalStudyDataObject(**kwargs)[source]¶

Bases: models.APIObject

API class for clinical trial data view model - empty

clinicalStudyDefinition¶: Field for embedded models.

subject¶: Field for embedded models.

class models.ClinicalStudyDefinitionObject(**kwargs)[source]¶

Bases: models.APIObject

API class for clinical trail definition view model

clincalStudyDefinition¶: Field for embedded models.

class models.DynamicSearchComparisonOperator(**kwargs)[source]¶

Bases: jsonmodels.models.Base

docstring

displayName¶: String field.

name¶: String field.

position¶: Integer field.

typeaheadUrl¶: String field.

class models.DynamicSearchCondition(**kwargs)[source]¶

Bases: jsonmodels.models.Base

docstring

comparisonOperator¶: Field for embedded models.

inputItem¶: Field for embedded models.

sourceField¶: Field for embedded models.

class models.DynamicSearchGroup(**kwargs)[source]¶

Bases: jsonmodels.models.Base

docstring

conditions¶: List field.

groups¶: List field.

logicalOperator¶: Field for embedded models.

sourceType¶: Field for embedded models.

class models.DynamicSearchInputItem(**kwargs)[source]¶

Bases: jsonmodels.models.Base

docstring

data¶: Field for embedded models.

displayName¶: String field.

isTypeahead¶: Bool field.

class models.DynamicSearchLogicalOperator(**kwargs)[source]¶

Bases: jsonmodels.models.Base

logical operator view model

displayName¶: String field.

name¶: String field.

position¶: Integer field.

class models.DynamicSearchOptions(**kwargs)[source]¶

Bases: jsonmodels.models.Base

for DynamicSearchOptions

logicalOperators¶: List field.

sourceTypes¶: List field.

class models.DynamicSearchSourceField(**kwargs)[source]¶

Bases: jsonmodels.models.Base

fiels view model for dynamic search

comparisonOperators¶: List field.

displayName¶: String field.

name¶: String field.

position¶: Integer field.

class models.DynamicSearchSourceType(**kwargs)[source]¶

Bases: jsonmodels.models.Base

source type view model for search

displayName¶: String field.

name¶: String field.

position¶: Integer field.

sourceFields¶: List field.

class models.File(**kwargs)[source]¶

Bases: models.APIBaseID

anonymizedFileHashCode¶: String field.

createdDate¶: String field.

downloadUrl¶

fileHashCode¶: String field.

objects¶: Field for embedded models.

originalFileName¶: String field.

size¶: Integer field.

class models.Folder(**kwargs)[source]¶

Bases: models.APIBaseID

childFolders¶: List field.

containedObjects¶: List field.

folderGroupRights¶: List field.

folderUserRights¶: List field.

level¶: Integer field.

name¶: String field.

parentFolder¶: Field for embedded models.

class models.FolderGroupRight(**kwargs)[source]¶

Bases: models.APIBaseID

relations between folder, group and right (permission)

relatedFolder¶: Field for embedded models.

relatedGroup¶: Field for embedded models.

relatedRights¶: List field.

class models.FolderGroupRightPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing folder group rights

items¶: List field.

class models.FolderPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for Pagination results containing folders

items¶: List field.

class models.FolderRight(**kwargs)[source]¶

Bases: models.APIBaseID

represents a folder right

name¶: String field.

rightValue¶: Integer field.

class models.FolderRightPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing folder rights

items¶: List field.

class models.FolderRightSet(**kwargs)[source]¶

Bases: models.APIBaseID

folder rights set

folderRights¶: List field.

name¶: String field.

class models.FolderRightSetPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing folder rights

items¶: List field.

class models.FolderUserRight(**kwargs)[source]¶

Bases: models.APIBaseID

relations between folder, user and right (permission)

relatedFolder¶: Field for embedded models.

relatedRights¶: List field.

relatedUser¶: Field for embedded models.

class models.FolderUserRightPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing folder userrights

items¶: List field.

class models.GenomicPlatformObject(**kwargs)[source]¶

Bases: models.APIObject

API class for genomic platform view model - empty

class models.GenomicSampleObject(**kwargs)[source]¶

Bases: models.APIObject

API class for genomic sample view model - empty

class models.GenomicSeriesObject(**kwargs)[source]¶

Bases: models.APIObject

API class for genomic series view model - empty

class models.Group(**kwargs)[source]¶

Bases: models.APIBaseID

class for groups

chief¶: Field for embedded models.

name¶: String field.

class models.GroupPagination(**kwargs)[source]¶

Bases: models.Pagination

class for pagination results containing groups

items¶: List field.

class models.HttpContent(**kwargs)[source]¶

Bases: jsonmodels.models.Base

header content

headers¶: String field.

class models.HttpMethod(**kwargs)[source]¶

Bases: jsonmodels.models.Base

http request method

method¶: Integer field.

class models.HttpRequestMessage(**kwargs)[source]¶

Bases: jsonmodels.models.Base

Http request view model

content¶: Field for embedded models.

headers¶: String field.

method¶: Field for embedded models.

proertiews¶: Field for embedded models.

requestUri¶

version¶: Field for embedded models.

class models.HttpResponseMessage(**kwargs)[source]¶

Bases: jsonmodels.models.Base

http response message view model

content¶: Field for embedded models.

headers¶: String field.

isSuccessStatusCode¶: Bool field.

reasonPhrase¶: String field.

requestMessage¶: Field for embedded models.

statusCode¶: Integer field.

version¶: Field for embedded models.

class models.License(**kwargs)[source]¶

Bases: models.APIBase

class for licenses

description¶: String field.

name¶: String field.

class models.LicensePagination(**kwargs)[source]¶

Bases: models.Pagination

class for pagination results containing groups

items¶: List field.

class models.ListValidator(itemlist)[source]¶

Bases: object

Validator for a list.

modify_schema(field_schema)[source]¶: Modify field schema.

validate(value)[source]¶: Validate value.

class models.Modality(**kwargs)[source]¶

Bases: models.APIBaseID

description¶: String field.

name¶: String field.

class models.ModalityPagination(**kwargs)[source]¶

Bases: models.Pagination

class for pagination results containing modalities

items¶: List field.

class models.ObjectGroupRight(**kwargs)[source]¶

Bases: models.APIBaseID

relations between object, group and right (permission)

relatedGroup¶: Field for embedded models.

relatedObject¶: Field for embedded models.

relatedRights¶: List field.

class models.ObjectGroupRightPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing object group rights

items¶: List field.

class models.ObjectLinks(**kwargs)[source]¶

Bases: models.APIBaseID

a link betwen two objects

description¶: String field.

object1¶: Field for embedded models.

object2¶: Field for embedded models.

class models.ObjectOntology(**kwargs)[source]¶

Bases: models.APIBaseID

A relation between an object and an ontology item

object¶: Field for embedded models.

ontologyItem¶: Field for embedded models.

position¶: Integer field.

type¶: Integer field.

class models.ObjectOptions(**kwargs)[source]¶

Bases: jsonmodels.models.Base

class for additional information of the API objects

clinicalStudyData¶: Field for embedded models.

clinicalStudyDefinition¶: Field for embedded models.

genomicPlatform¶: Field for embedded models.

genomicSample¶: Field for embedded models.

genomicSeries¶: Field for embedded models.

rawImage¶: Field for embedded models.

segmentationImage¶: Field for embedded models.

statisticalModel¶: Field for embedded models.

study¶: Field for embedded models.

subject¶: Field for embedded models.

surfaceModel¶: Field for embedded models.

class models.ObjectPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for Pagination results containing objects

items¶: List field.

class models.ObjectRight(**kwargs)[source]¶

Bases: models.APIBase

Represents an object right.

name¶: String field.

rightValue¶: Integer field.

class models.ObjectRightPagination(**kwargs)[source]¶

Bases: models.Pagination

class for pagination results containing object rights

items¶: List field.

class models.ObjectRightSet(**kwargs)[source]¶

Bases: models.APIBaseID

object rights set

name¶: String field.

objectRights¶: List field.

class models.ObjectRightSetPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing object rights

items¶: List field.

class models.ObjectType(**kwargs)[source]¶

Bases: models.APIBase

for semantic triple storage

displayName¶: String field.

displayNameShort¶: String field.

name¶: String field.

class models.ObjectUserRight(**kwargs)[source]¶

Bases: models.APIBaseID

relations between object, user and right (permission)

relatedObject¶: Field for embedded models.

relatedRights¶: List field.

relatedUser¶: Field for embedded models.

class models.ObjectUserRightPagination(**kwargs)[source]¶

Bases: models.Pagination

API class for pagination result containing object userrights

items¶: List field.

class models.OntologyItem(**kwargs)[source]¶

Bases: models.APIBaseID

An ontology item

term¶: String field.

type¶: Integer field.

class models.OntologyItemPagination(**kwargs)[source]¶

Bases: models.Pagination

class for pagination results containing ontology items

items¶: List field.

class models.OntologyOptions(**kwargs)[source]¶

Bases: jsonmodels.models.Base

additional information for the ontologies resource.

types¶: List field.

class models.Pagination(**kwargs)[source]¶

Bases: jsonmodels.models.Base

API class for Pagination results

firstUrlInPage()[source]¶

get the selfurl of the first item in the paginated list

Returns:	selfUrl
Return type:	string

items¶: List field.

nextPageUrl¶

pagination¶: Field for embedded models.

totalCount¶: Integer field.

class models.PaginationParameter(**kwargs)[source]¶

Bases: jsonmodels.models.Base

pagination parameters

page¶: Integer field.

rpp¶: Integer field.

class models.PlainObject(**kwargs)[source]¶

Bases: models.APIObject

API class for plain (undefined object) model view model

class models.PlainSubjectObject(**kwargs)[source]¶

Bases: models.APIObject

API class for plain subject (undefined subject object) model view model

class models.Preview(**kwargs)[source]¶

Bases: models.APIBaseID

imageUrl¶

thumbnailUrl¶

class models.RawImageData(**kwargs)[source]¶

Bases: jsonmodels.models.Base

raw image attributes

kilovoltPeak¶: Float field.

modality¶: Field for embedded models.

sliceThickness¶: Float field.

spaceBetweenSlices¶: Float field.

class models.RawImageObject(**kwargs)[source]¶

Bases: models.APIObject

API class for raw image view model

rawImage¶: Field for embedded models.

class models.SegmentationImageData(**kwargs)[source]¶

Bases: jsonmodels.models.Base

segmentation specific attributes

methodDescription¶: String field.

segmentationMethod¶: Field for embedded models.

class models.SegmentationImageObject(**kwargs)[source]¶

Bases: models.APIObject

API class for segmenation image view model

segmentationImage¶: Field for embedded models.

class models.SegmentationMethod(**kwargs)[source]¶

Bases: models.APIBaseID

segmentation methods view model

displayName¶: String field.

name¶: String field.

class models.StatisticalModelObject(**kwargs)[source]¶

Bases: models.APIObject

API class for Statistical model view model - empty

class models.StudyObject(**kwargs)[source]¶

Bases: models.APIObject

API class for study

class models.SubjectData(**kwargs)[source]¶

Bases: models.APIObject

attributes for subject data

subjectKey¶: String field.

class models.SubjectObject(**kwargs)[source]¶

Bases: models.APIObject

API class for Subject view model

subject¶: Field for embedded models.

class models.SurfaceModelData(**kwargs)[source]¶

Bases: models.APIObject

attributes of surface model

maxX¶: Float field.

maxY¶: Float field.

maxZ¶: Float field.

minX¶: Float field.

minY¶: Float field.

minZ¶: Float field.

vectorCount¶: Integer field.

class models.SurfaceModelObject(**kwargs)[source]¶

Bases: models.APIObject

API class for surface model view model

surfaceModel¶: Field for embedded models.

class models.Token(**kwargs)[source]¶

Bases: jsonmodels.models.Base

API class to work with the tokens Supported token: JWT

tokenType¶: String field.

tokenValue¶: String field.

class models.URLField(required=False, help_text=None, validators=None)[source]¶: Bases: jsonmodels.fields.StringField

class models.UploadResponse(**kwargs)[source]¶

Bases: jsonmodels.models.Base

a response consisting of a combination between a file and an object after the upload

file¶: Field for embedded models.

relatedObject¶: Field for embedded models.

class models.User(**kwargs)[source]¶

Bases: models.APIBaseID

Users of the repository

username¶: String field.