Dominances

Dominances

APIDescription
GET dominances?rpp={rpp}&page={page}

Gets a list of dominances.

GET dominances/{id}

Gets the information of the dominance with the specified identifier.

Files

Supported file formats are: DICOM (Digital Imaging and Communications in Medicine), MetaImage, Analyze, Niftii, and HDF5 (Hierarchical Data Format).

APIDescription
GET files/{id}?include={include}

Gets the information of the file with the specified identifier.

GET files/{id}/download

Downloads the file with the specified identifier.

GET files/{id}/objects?rpp={rpp}&page={page}

Gets the objects of the specified file.

FolderRights

Permission rights related to folders.

APIDescription
GET folder_rights?rpp={rpp}&page={page}

Gets a list of folder rights.

GET folder_rights/{id}

Gets the information of the folder right with the specified identifier.

GET folder_right_sets?rpp={rpp}&page={page}&include={include}

Gets a list of folder right sets.

GET folder_right_sets/{id}?include={include}

Gets the information of the folder right set with the specified identifier.

GET folder-user-rights?rpp={rpp}&page={page}&include={include}

Gets a list of folder user rights.

GET folder-user-rights/{id}?include={include}

Gets the information of the folder user right with the specified identifier.

POST folder-user-rights

Creates a new or updates an existing folder user right.

PUT folder-user-rights

Updates an existing folder user right.

DELETE folder-user-rights/{id}

Deletes the folder user right.

GET folder-group-rights?rpp={rpp}&page={page}&include={include}

Gets a list of folder group rights.

GET folder-group-rights/{id}?include={include}

Gets the information of the folder group right with the specified identifier.

POST folder-group-rights

Creates a new or updates an existing folder group right.

PUT folder-group-rights

Updates an existing folder group right.

DELETE folder-group-rights/{id}

Deletes the folder group right.

Folders

A folder can be used to organize data and sharing thereof.

APIDescription
GET folders?rpp={rpp}&page={page}&include={include}

Gets a list of folders.

GET folders/{id}?include={include}

Gets the information of the folder with the specified identifier.

POST folders

Creates a new folder.

PUT folders

Updates or moves an existing folder.

DELETE folders/{id}

Deletes the specified folder if it is empty.

Genders

Genders

APIDescription
GET genders?rpp={rpp}&page={page}

Gets a list of genders.

GET genders/{id}

Gets the information of the gender with the specified identifier.

Groups

Groups of the repository.

APIDescription
GET groups?rpp={rpp}&page={page}&include={include}

Gets a list of groups.

GET groups/{id}?include={include}

Gets the information of the group with the specified identifier.

Licenses

Licenses.

APIDescription
GET licenses?rpp={rpp}&page={page}

Gets a list of licenses.

GET licenses/{id}

Gets the information of the license with the specified identifier.

Modalities

Medical imaging modalities.

APIDescription
GET modalities?rpp={rpp}&page={page}

Gets a list of modalities.

GET modalities/{id}

Gets the information of the modality with the specified identifier.

Represents a relation between two objects.

APIDescription
GET object-links/{id}

Gets the relation representing a link between two objects.

POST object-links

Creates a link between the provided objects.

DELETE object-links/{id}

Deletes the relation with the specified identifier representing a link between two objects.

ObjectOntologies

Represents a relation between an object and an ontology item.

APIDescription
GET object-ontologies/{type}/{id}

Gets the relation between an object and an ontology item.

POST object-ontologies/{type}

Creates a relation between the object and the ontology item.

PUT object-ontologies/{type}/{id}

Updates the relation between the object and the ontology item.

ObjectRights

Permission rights related to objects.

APIDescription
GET object_rights?rpp={rpp}&page={page}

Gets a list of object rights.

GET object_rights/{id}

Gets the information of the object right with the specified identifier.

GET object_right_sets?rpp={rpp}&page={page}&include={include}

Gets a list of object right sets.

GET object_right_sets/{id}?include={include}

Gets the information of the object right set with the specified identifier.

GET object-user-rights?rpp={rpp}&page={page}&include={include}

Gets a list of object user rights.

GET object-user-rights/{id}?include={include}

Gets the information of the object user right with the specified identifier.

POST object-user-rights

Creates a new or updates an existing object user right.

PUT object-user-rights

Updates an existing object user right.

DELETE object-user-rights/{id}

Deletes the object user right.

GET object-group-rights?rpp={rpp}&page={page}&include={include}

Gets a list of object group rights.

GET object-group-rights/{id}?include={include}

Gets the information of the object group right with the specified identifier.

POST object-group-rights

Creates a new or updates an existing object group right.

PUT object-group-rights

Updates an existing object group right.

DELETE object-group-rights/{id}

Deletes the object group right.

Objects

An object represents a collection of files and other information. Important: See 'OPTIONS objects' for possible response object types.

APIDescription
GET objects?rpp={rpp}&page={page}&include={include}

Gets a list of objects.

GET objects/published?rpp={rpp}&page={page}&include={include}

Gets a list of published objects of the current user.

GET objects/unpublished?rpp={rpp}&page={page}&include={include}

Gets a list of unpublished objects of the current user.

OPTIONS objects

Returns the available options for this resource. It includes information about enum types.

GET objects/{id}?include={include}

Gets the information of the object with the specified identifier.

DELETE objects/{id}

Deletes the unpublished object with the specified identifier.

GET objects/{id}/download

Downloads the object with the specified identifier.

PUT objects/{id}/publish

Publishes the object with the specified identifier.

PUT objects/{id}?include={include}

Updates the object with the specified identifier. The request body must contain an ObjectViewModel or a derivation of it.

GET objects/{id}/previews

Gets a list of previews of the object with the specified identifier.

GET objects/{id}/previews/{preview_id}

Gets the preview of the object with the specified identifier.

GET objects/{id}/previews/{preview_id}/image

Gets the image of the preview and object with the specified identifiers.

GET objects/{id}/previews/{preview_id}/thumbnail

Gets the thumbnail of the preview and object with the specified identifiers.

GET objects/{id}/files?rpp={rpp}&page={page}

Gets the files of the specified object.

GET objects/{id}/objects?rpp={rpp}&page={page}

Gets the related objects of the specified object.

GET objects/{id}/object-links?rpp={rpp}&page={page}

Gets the relations between another object and the specified object.

GET objects/{id}/ontologies?rpp={rpp}&page={page}

Gets the ontology items of the specified object.

GET objects/{id}/object-ontologies?rpp={rpp}&page={page}

Gets the relations between an ontology item and the specified object.

ObjectTypes

APIDescription
GET object_types?rpp={rpp}&page={page}

Gets a list of object types.

GET object_types/{name}

Gets the information of the object type with the specified name.

Ontologies

Supported ontologies are: FMA (Foundational Model of Anatomy).

APIDescription
OPTIONS ontologies

Returns the available options for this resource. It includes information about enum types.

GET ontologies/{type}?rpp={rpp}&page={page}

Gets a list of ontology items of the specified ontology.

GET ontologies/{type}/{id}

Gets the information of the ontology item with the specified identifier.

Enables to conduct sophisticated search queries.

APIDescription
OPTIONS dynamic_search

Returns the available options for this resource.

SegmentationMethods

Segmentation methods.

APIDescription
GET segmentation_methods?rpp={rpp}&page={page}

Gets a list of segmentation methods.

GET segmentation_methods/{id}

Gets the information of the segmentation method with the specified identifier.

Tokens

Tokens for authentication.

APIDescription
GET tokens/jwt

Gets a JSON Web Token.

Upload

Upload a supported file format.

APIDescription
POST upload

Uploads a supported file.

POST chunked_upload?chunk={chunk}

Uploads a supported file in chunks.

POST chunked_upload/commit?filename={filename}

Commits the chunked upload.

Users

Users of the repository.

APIDescription
GET users/{id}

Gets the information of the user with the specified identifier.