Resources
get /vdi-datasets
Returns a list of datasets available to the requesting user, optionally filtered by query parameters.
Results are sorted by creation date in reverse order. This means the most recently created datasets will be first and the oldest dataset will be last in the list.
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Query | ||
| project_id Project ID | string | ID of the VEuPathDB project that results should be filtered to. This means only datasets that are relevant to the project ID given will be returned. Additionally, this controls the sites on which the dataset installation status will be checked. Meaning, if this parameter is specified and set to, for example, Inherits: string |
| ownership Dataset Ownership Filter | string | Ownership status filter. Enum of:
If set to If set to If set to Default value: "any" |
| offset Result Offset | integer | This many results will be skipped before the first result returned. Used to implement result pagination. |
| limit Result Count Limit | integer | Limits the number of results returned to this count. Used to implement result pagination. Min. value: 1 Max. value: 100 Default value: 100 |
| sort_field Sorting Field | string | Field used to sort the results of this endpoint. Valid options are:
By default, results are sorted by This means that given the URI However, given the URI Default value: "creation_timestamp" |
| sort_order* Sorting Order | string | Sort ordering of the results of this endpoint. Valid options are:
By default, results are sorted by the This means that given the URI However, given the URI |
curl -X GET \
+ Resources
get /vdi-datasets
List Datasets Returns a list of datasets available to the requesting user, optionally filtered by query parameters.
Results are sorted by creation date in reverse order. This means the most recently created datasets will be first and the oldest dataset will be last in the list.
Parameters chevron_right expand_more
Parameter Type Description Query project_id Project ID string ID of the VEuPathDB project that results should be filtered to.
This means only datasets that are relevant to the project ID given will be returned.
Additionally, this controls the sites on which the dataset installation status will be checked. Meaning, if this parameter is specified and set to, for example, PlasmoDB, the status block in the response objects will only include installation status details for PlasmoDB and not any other sites that the dataset may have been installed into.
Inherits: string
ownership Dataset Ownership Filter string Ownership status filter.
Enum of:
anyownedshared
If set to any the results are not filtered.
If set to owned, the results will be filtered to only results that are owned by the requesting user.
If set to shared, the results will be filtered to only results that are shared with the requesting user.
Default value: "any"
offset Result Offset integer This many results will be skipped before the first result returned.
Used to implement result pagination.
limit Result Count Limit integer Limits the number of results returned to this count.
Used to implement result pagination.
Min. value: 1
Max. value: 100
Default value: 100
sort_field Sorting Field string Field used to sort the results of this endpoint.
Valid options are:
creation_timestampname
By default, results are sorted by creation_timestamp with a sort_order query param value of descending, however if the sort field is changed, then the default value of the sort_order query param will be ascending.
This means that given the URI {site}/vdi-datasets the results will be returned in descending order by the creation timestamp of the results.
However, given the URI {site}/vdi-datasets?sort_field=name the results will be returned in ascending order by the user provided name for the datasets.
Default value: "creation_timestamp"
sort_order* Sorting Order string Sort ordering of the results of this endpoint.
Valid options are:
- asc
- desc
By default, results are sorted by the sort_field value "creation_timestamp" in "desc" order, however if the sort field is changed then the default value of this query parameter becomes "asc" by default.
This means that given the URI {site}/vdi-datasets the results will be returned in descending order by the creation timestamp of the results.
However, given the URI {site}/vdi-datasets?sort_field=name the results will be returned in ascending order by the user provided name for the datasets.
curl -X GET \
undefined/vdi-datasets?ProjectID=<value>&ownership=<value>&offset=<value>&limit=<value>&sort_field=<value>&sort_order=<value>
200 OK chevron_right expand_more
Success.
This response means that all checks passed and zero or more dataset records were found for the requesting user.
application/json
application/json
Parameter Type Description [] Dataset List Item object Short entry with basic details about a dataset.
Inherits: object
[].datasetID* Dataset ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
[].owner* Owner Details object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
[].owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
[].owner.firstName Owner First Name string [].owner.lastName Owner Last Name string [].owner.email Owner Email string [].owner.organization Owner Organization string [].datasetType* Dataset Type object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
[].datasetType.name* Type Name string [].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
[].datasetType.version* Type Version string [].visibility* Dataset Visibility string Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
[].name* Dataset Name string User provided name for the dataset.
[].summary Dataset Summary string User provided summary of the dataset.
[].description Dataset Description string User provided description of the dataset.
[].sourceUrl Source URL string URL of the dataset data source, if the dataset was uploaded via URL.
[].origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
[].projectIDs* Project IDs array Project IDs for projects the dataset record was submitted to.
[].projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
[].status* Status Info object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
[].status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
[].status.install array [].status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
[].status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
[].status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
[].status.install[].metaMessage string [].status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
[].status.install[].dataMessage string [].shares* Shared With array [].shares[] object Inherits: object
[].shares[].userID* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
[].shares[].firstName* string [].shares[].lastName* string [].shares[].organization* string [].shares[].accepted* boolean [].fileCount* File Count integer Number of files uploaded for this dataset.
[].fileSizeTotal* File Size Total integer Sum of the sizes of all the files uploaded for this dataset.
Format: int64
[].created* Creation Timestamp datetime Timestamp of the creation of this dataset.
Response Body
[
{
"datasetID": "zaZqAAGLGJhBgg",
@@ -1341,7 +1341,9 @@
"status": "server-error",
"message": "Dataset store is unreachable",
"requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
-}
get /vdi-datasets/admin/list-broken
List Broken Installs Lists datasets that failed installation due to non-user error.
Parameters chevron_right expand_more
Parameter Type Description Query expanded Expanded Dataset List boolean Whether the returned broken dataset install list should be expanded to include additional details about each dataset or should be just a simple list of dataset IDs.
Default value: true
Headers chevron_right expand_more
Parameter Type Description Admin-Token* Admin Auth Secret Key string Secret key used to authenticate admin endpoint requests.
curl -X GET \
+}
get /vdi-datasets/admin/failed-imports
Lists datasets that failed to import.
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Query | ||
| user VEuPathDB User ID | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: integer |
| before | string | Filter results to only those records created before the given date-time value. Examples:
If no timezone is provided, the service will assume its local zone. |
| after | string | Filter results to only those records created after the given date-time value. Examples:
If no timezone is provided, the service will assume its local zone. |
| limit | integer | Max. value: 250 Default value: 100 |
| offset | integer | |
| sort | string | One of:
Default value: "date" |
| order | string | One of:
Default value: "desc" |
Headers chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Admin-Token* Admin Auth Secret Key | string | Secret key used to authenticate admin endpoint requests. |
curl -X GET \
+ -H "Admin-Token: <value>" \
+ undefined/vdi-datasets/admin/failed-imports?User-ID=<value>&before=<value>&after=<value>&limit=<value>&offset=<value>&sort=<value>&order=<value>200 OK chevron_right expand_more
Broken Import Listing BrokenImportListing
application/json
Inherits: object
| Parameter | Type | Description |
|---|---|---|
| meta* | object | Inherits: lib.BrokenImportListingMeta |
| meta.count* | integer | |
| meta.before | string | |
| meta.after | string | |
| meta.user | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| meta.limit | integer | |
| meta.offset | integer | |
| results* | array | |
| results[] Broken Import Details | object | Inherits: lib.BrokenImportDetails |
| results[].datasetId* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| results[].owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| results[].datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo |
| results[].datasetType.name* Type Name | string | |
| results[].datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. |
| results[].datasetType.version* Type Version | string | |
| results[].projectIds* | array | |
| results[].projectIds[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| results[].messages* | array | |
| results[].messages[] | string |
get /vdi-datasets/admin/list-broken
Lists datasets that failed installation due to non-user error.
Parameters chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Query | ||
| expanded Expanded Dataset List | boolean | Whether the returned broken dataset install list should be expanded to include additional details about each dataset or should be just a simple list of dataset IDs. Default value: true |
Headers chevron_right expand_more
| Parameter | Type | Description |
|---|---|---|
| Admin-Token* Admin Auth Secret Key | string | Secret key used to authenticate admin endpoint requests. |
curl -X GET \
-H "Admin-Token: <value>" \
undefined/vdi-datasets/admin/list-broken?expanded=<value>200 OK chevron_right expand_more
Success.
Broken dataset install list successfully generated.
Broken Dataset Listing BrokenDatasetListing
application/json
Inherits: object
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| details | array | |||||||||||||
| details[] Broken Dataset Details | object | Inherits: lib.BrokenDatasetDetails | ||||||||||||
| details[].datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| details[].owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| details[].datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| details[].datasetType.name* Type Name | string | |||||||||||||
| details[].datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| details[].datasetType.version* Type Version | string | |||||||||||||
| details[].projectIDs* | array | |||||||||||||
| details[].projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| details[].status* | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| details[].status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| details[].status.install | array | |||||||||||||
| details[].status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| details[].status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| details[].status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| details[].status.install[].metaMessage | string | |||||||||||||
| details[].status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| details[].status.install[].dataMessage | string | |||||||||||||
| ids | array | |||||||||||||
| ids[] VDI ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
401 Unauthorized chevron_right expand_more
Unauthorized
Unauthorized UnauthorizedError
application/json
Unauthenticated client requested a resource that requires authentication.
Discriminator: status
Discriminator value: unauthorized
Inherits: lib.Error
| Parameter | Type | Description |
|---|---|---|
| status* | string | Enum:
Inherits: lib.ErrorType |
| message* | string |
Response Body
{
"status": "unauthorized",
@@ -1641,7 +1643,7 @@
"message": "Datastore connection lost",
"requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}get /metrics
Prometheus metrics for the service.
curl -X GET \
- undefined/metrics200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Types
Type BrokenDatasetListing (object)
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| details | array | |||||||||||||
| details[] Broken Dataset Details | object | Inherits: lib.BrokenDatasetDetails | ||||||||||||
| details[].datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| details[].owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| details[].datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| details[].datasetType.name* Type Name | string | |||||||||||||
| details[].datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| details[].datasetType.version* Type Version | string | |||||||||||||
| details[].projectIDs* | array | |||||||||||||
| details[].projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| details[].status* | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| details[].status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| details[].status.install | array | |||||||||||||
| details[].status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| details[].status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| details[].status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| details[].status.install[].metaMessage | string | |||||||||||||
| details[].status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| details[].status.install[].dataMessage | string | |||||||||||||
| ids | array | |||||||||||||
| ids[] VDI ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
Type BrokenDatasetDetails (object)
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| datasetType.name* Type Name | string | |||||||||||||
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| datasetType.version* Type Version | string | |||||||||||||
| projectIDs* | array | |||||||||||||
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status* | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| status.install | array | |||||||||||||
| status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].metaMessage | string | |||||||||||||
| status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].dataMessage | string |
Type InstallCleanupRequest (object)
Object controlling the install cleanup process and what datasets it should target.
Requesters should specify one of the fields all or targets to control what datasets will be cleaned up. If neither is specified the endpoint will do nothing.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| all | boolean | |
| targets | array | Unique items: Yes |
| targets[] Install Cleanup Target | object | Inherits: lib.InstallCleanupTarget |
| targets[].datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| targets[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
Type InstallCleanupTarget (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
Type DatasetListShareUser (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| userID* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| firstName* | string | |
| lastName* | string | |
| organization* | string | |
| accepted* | boolean |
Type DatasetListEntry (object)
Short entry with basic details about a dataset.
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datasetID* Dataset ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| owner* Owner Details | object | Details about the owner of a VDI dataset. Inherits: lib.DatasetOwner | ||||||||||||
| owner.userID* Owner User ID | integer | VEuPathDB user ID of the owner of the dataset. Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| owner.firstName Owner First Name | string | |||||||||||||
| owner.lastName Owner Last Name | string | |||||||||||||
| owner.email Owner Email | string | |||||||||||||
| owner.organization Owner Organization | string | |||||||||||||
| datasetType* Dataset Type | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| datasetType.name* Type Name | string | |||||||||||||
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| datasetType.version* Type Version | string | |||||||||||||
| visibility* Dataset Visibility | string | Enum:
Inherits: lib.DatasetVisibility | ||||||||||||
| name* Dataset Name | string | User provided name for the dataset. | ||||||||||||
| summary Dataset Summary | string | User provided summary of the dataset. | ||||||||||||
| description Dataset Description | string | User provided description of the dataset. | ||||||||||||
| sourceUrl Source URL | string | URL of the dataset data source, if the dataset was uploaded via URL. | ||||||||||||
| origin* Dataset Origin | string | String representing the origin of the dataset. Examples include | ||||||||||||
| projectIDs* Project IDs | array | Project IDs for projects the dataset record was submitted to. | ||||||||||||
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status* Status Info | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| status.install | array | |||||||||||||
| status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].metaMessage | string | |||||||||||||
| status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].dataMessage | string | |||||||||||||
| shares* Shared With | array | |||||||||||||
| shares[] | object | Inherits: object | ||||||||||||
| shares[].userID* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| shares[].firstName* | string | |||||||||||||
| shares[].lastName* | string | |||||||||||||
| shares[].organization* | string | |||||||||||||
| shares[].accepted* | boolean | |||||||||||||
| fileCount* File Count | integer | Number of files uploaded for this dataset. | ||||||||||||
| fileSizeTotal* File Size Total | integer | Sum of the sizes of all the files uploaded for this dataset. Format: int64 | ||||||||||||
| created* Creation Timestamp | datetime | Timestamp of the creation of this dataset. |
Type DatasetPostRequest (object)
HTTP POST request body requesting the creation of a dataset from the components included in the request.
For a request to be considered valid, it must contain exactly 1 of the optional parameters file or url. If a request body contains both a file and a url field value, the service will return a 400 error.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| meta* Dataset Meta | object | Metadata about the dataset being submitted. Inherits: lib.DatasetPostMeta |
| meta.datasetType* Dataset Type | object | Type of the dataset that is being uploaded. Inherits: lib.DatasetPostType |
| meta.datasetType.name* | string | |
| meta.datasetType.version* | string | |
| meta.name* Dataset Name | string | User provided name for the dataset. |
| meta.visibility Dataset Visibility | string | Default value: "private" Enum:
Inherits: lib.DatasetVisibility |
| meta.summary Dataset Summary | string | User provided summary for the dataset. |
| meta.description Dataset Description | string | User provided description for the dataset. |
| meta.origin* Dataset Origin | string | String representing the origin of the dataset. Examples include |
| meta.projects* Project IDs | array | IDs of the projects this dataset is being submitted to. |
| meta.projects[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| meta.dependencies* Dataset Dependencies | array | |
| meta.dependencies[] | object | Inherits: lib.DatasetDependency |
| meta.dependencies[].resourceIdentifier* | string | |
| meta.dependencies[].resourceDisplayName* | string | |
| meta.dependencies[].resourceVersion* | string | |
| file Dataset File | file | Dataset file to upload. This field is incompatible with the |
| url Dataset URL | string | URL to a dataset file to upload. This field is incompatible with the |
Type DatasetPostMeta (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetType* Dataset Type | object | Type of the dataset that is being uploaded. Inherits: lib.DatasetPostType |
| datasetType.name* | string | |
| datasetType.version* | string | |
| name* Dataset Name | string | User provided name for the dataset. |
| visibility Dataset Visibility | string | Default value: "private" Enum:
Inherits: lib.DatasetVisibility |
| summary Dataset Summary | string | User provided summary for the dataset. |
| description Dataset Description | string | User provided description for the dataset. |
| origin* Dataset Origin | string | String representing the origin of the dataset. Examples include |
| projects* Project IDs | array | IDs of the projects this dataset is being submitted to. |
| projects[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| dependencies* Dataset Dependencies | array | |
| dependencies[] | object | Inherits: lib.DatasetDependency |
| dependencies[].resourceIdentifier* | string | |
| dependencies[].resourceDisplayName* | string | |
| dependencies[].resourceVersion* | string |
Type DatasetPostType (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| version* | string |
Type DatasetDependency (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| resourceIdentifier* | string | |
| resourceDisplayName* | string | |
| resourceVersion* | string |
Type DatasetPostResponse (object)
Response object returned on successful upload of a dataset.
Note that this response does not mean the uploaded dataset has been made available on the target site(s). The upload must first be processed and installed into the target sites before the dataset will become available for use.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
Type ShareOfferEntry (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| owner* | object | Details about the owner of a VDI dataset. Inherits: lib.DatasetOwner |
| owner.userID* Owner User ID | integer | VEuPathDB user ID of the owner of the dataset. Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| owner.firstName Owner First Name | string | |
| owner.lastName Owner Last Name | string | |
| owner.email Owner Email | string | |
| owner.organization Owner Organization | string | |
| shareStatus* | string | Enum:
Inherits: lib.ShareOfferStatus |
| datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo |
| datasetType.name* Type Name | string | |
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. |
| datasetType.version* Type Version | string | |
| projectIDs* | array | |
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
Type ShareOfferStatus (string)
- open
- accepted
- rejected
Inherits: string
Type DatasetFileListing (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| uploadFiles* | array | |
| uploadFiles[] Dataset File Details | object | Inherits: lib.DatasetFileDetails |
| uploadFiles[].name* File Name | string | |
| uploadFiles[].size* File Size | integer | Size of the file in bytes. Format: int64 |
| dataFiles* | array | |
| dataFiles[] Dataset File Details | object | Inherits: lib.DatasetFileDetails |
| dataFiles[].name* File Name | string | |
| dataFiles[].size* File Size | integer | Size of the file in bytes. Format: int64 |
Type DatasetFileDetails (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* File Name | string | |
| size* File Size | integer | Size of the file in bytes. Format: int64 |
Type DatasetDetails (object)
Details about a specific singular dataset.
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datasetID* Dataset ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| owner* Owner Details | object | Details about the owner of a VDI dataset. Inherits: lib.DatasetOwner | ||||||||||||
| owner.userID* Owner User ID | integer | VEuPathDB user ID of the owner of the dataset. Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| owner.firstName Owner First Name | string | |||||||||||||
| owner.lastName Owner Last Name | string | |||||||||||||
| owner.email Owner Email | string | |||||||||||||
| owner.organization Owner Organization | string | |||||||||||||
| datasetType* Dataset Type Info | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| datasetType.name* Type Name | string | |||||||||||||
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| datasetType.version* Type Version | string | |||||||||||||
| name* Dataset Name | string | |||||||||||||
| summary Dataset Summary | string | |||||||||||||
| description Dataset Description | string | |||||||||||||
| sourceUrl Source URL | string | URL of the dataset data source, if the dataset was uploaded via URL. | ||||||||||||
| origin* Dataset Origin | string | String representing the origin of the dataset. Examples include | ||||||||||||
| projectIDs* Project IDs | array | Project IDs for projects the user dataset record was submitted to. | ||||||||||||
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| visibility* Dataset Visibility | string | Enum:
Inherits: lib.DatasetVisibility | ||||||||||||
| importMessages Import Messages | array | Log lines from the import process. These messages will be warnings and/or validation errors. Default value: [] | ||||||||||||
| importMessages[] | string | |||||||||||||
| status* Dataset Status Info | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| status.install | array | |||||||||||||
| status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].metaMessage | string | |||||||||||||
| status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].dataMessage | string | |||||||||||||
| shares Shares | array | Array of share offers that have been created by the owner of this dataset to share it with other users. | ||||||||||||
| shares[] Share Offer | object | Inherits: lib.ShareOffer | ||||||||||||
| shares[].recipient* | object | I AM A UNION! Inherits: lib.ShareOfferRecipient | ||||||||||||
| shares[].recipient.firstName First Name | string | |||||||||||||
| shares[].recipient.lastName Last Name | string | |||||||||||||
| shares[].recipient.organization Organization | string | |||||||||||||
| shares[].recipient.email Email | string | |||||||||||||
| shares[].status* | string | Enum:
Inherits: lib.ShareOfferAction | ||||||||||||
| files* Files | array | List of files uploaded to the dataset import service. | ||||||||||||
| files[] File Summary | object | Inherits: lib.FileSummary | ||||||||||||
| files[].name* | string | |||||||||||||
| files[].size* | integer | Format: int64 | ||||||||||||
| created* Creation Timestamp | datetime | Timestamp for when this dataset was created. |
Type FileSummary (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| size* | integer | Format: int64 |
Type ShareOffer (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| recipient* | object | I AM A UNION! Inherits: lib.ShareOfferRecipient |
| recipient.firstName First Name | string | |
| recipient.lastName Last Name | string | |
| recipient.organization Organization | string | |
| recipient.email Email | string | |
| status* | string | Enum:
Inherits: lib.ShareOfferAction |
Examples
{
+ undefined/metrics200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Types
Type BrokenDatasetListing (object)
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| details | array | |||||||||||||
| details[] Broken Dataset Details | object | Inherits: lib.BrokenDatasetDetails | ||||||||||||
| details[].datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| details[].owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| details[].datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| details[].datasetType.name* Type Name | string | |||||||||||||
| details[].datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| details[].datasetType.version* Type Version | string | |||||||||||||
| details[].projectIDs* | array | |||||||||||||
| details[].projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| details[].status* | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| details[].status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| details[].status.install | array | |||||||||||||
| details[].status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| details[].status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| details[].status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| details[].status.install[].metaMessage | string | |||||||||||||
| details[].status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| details[].status.install[].dataMessage | string | |||||||||||||
| ids | array | |||||||||||||
| ids[] VDI ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
Type BrokenDatasetDetails (object)
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| datasetType.name* Type Name | string | |||||||||||||
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| datasetType.version* Type Version | string | |||||||||||||
| projectIDs* | array | |||||||||||||
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status* | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| status.install | array | |||||||||||||
| status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].metaMessage | string | |||||||||||||
| status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].dataMessage | string |
Type BrokenImportListing (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| meta* | object | Inherits: lib.BrokenImportListingMeta |
| meta.count* | integer | |
| meta.before | string | |
| meta.after | string | |
| meta.user | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| meta.limit | integer | |
| meta.offset | integer | |
| results* | array | |
| results[] Broken Import Details | object | Inherits: lib.BrokenImportDetails |
| results[].datasetId* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| results[].owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| results[].datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo |
| results[].datasetType.name* Type Name | string | |
| results[].datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. |
| results[].datasetType.version* Type Version | string | |
| results[].projectIds* | array | |
| results[].projectIds[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| results[].messages* | array | |
| results[].messages[] | string |
Type BrokenImportListingMeta (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| count* | integer | |
| before | string | |
| after | string | |
| user | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| limit | integer | |
| offset | integer |
Type BrokenImportDetails (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetId* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| owner* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo |
| datasetType.name* Type Name | string | |
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. |
| datasetType.version* Type Version | string | |
| projectIds* | array | |
| projectIds[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| messages* | array | |
| messages[] | string |
Type InstallCleanupRequest (object)
Object controlling the install cleanup process and what datasets it should target.
Requesters should specify one of the fields all or targets to control what datasets will be cleaned up. If neither is specified the endpoint will do nothing.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| all | boolean | |
| targets | array | Unique items: Yes |
| targets[] Install Cleanup Target | object | Inherits: lib.InstallCleanupTarget |
| targets[].datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| targets[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
Type InstallCleanupTarget (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
Type DatasetListShareUser (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| userID* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| firstName* | string | |
| lastName* | string | |
| organization* | string | |
| accepted* | boolean |
Type DatasetListEntry (object)
Short entry with basic details about a dataset.
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datasetID* Dataset ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| owner* Owner Details | object | Details about the owner of a VDI dataset. Inherits: lib.DatasetOwner | ||||||||||||
| owner.userID* Owner User ID | integer | VEuPathDB user ID of the owner of the dataset. Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| owner.firstName Owner First Name | string | |||||||||||||
| owner.lastName Owner Last Name | string | |||||||||||||
| owner.email Owner Email | string | |||||||||||||
| owner.organization Owner Organization | string | |||||||||||||
| datasetType* Dataset Type | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| datasetType.name* Type Name | string | |||||||||||||
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| datasetType.version* Type Version | string | |||||||||||||
| visibility* Dataset Visibility | string | Enum:
Inherits: lib.DatasetVisibility | ||||||||||||
| name* Dataset Name | string | User provided name for the dataset. | ||||||||||||
| summary Dataset Summary | string | User provided summary of the dataset. | ||||||||||||
| description Dataset Description | string | User provided description of the dataset. | ||||||||||||
| sourceUrl Source URL | string | URL of the dataset data source, if the dataset was uploaded via URL. | ||||||||||||
| origin* Dataset Origin | string | String representing the origin of the dataset. Examples include | ||||||||||||
| projectIDs* Project IDs | array | Project IDs for projects the dataset record was submitted to. | ||||||||||||
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status* Status Info | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| status.install | array | |||||||||||||
| status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].metaMessage | string | |||||||||||||
| status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].dataMessage | string | |||||||||||||
| shares* Shared With | array | |||||||||||||
| shares[] | object | Inherits: object | ||||||||||||
| shares[].userID* | integer | Unique user identifier Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| shares[].firstName* | string | |||||||||||||
| shares[].lastName* | string | |||||||||||||
| shares[].organization* | string | |||||||||||||
| shares[].accepted* | boolean | |||||||||||||
| fileCount* File Count | integer | Number of files uploaded for this dataset. | ||||||||||||
| fileSizeTotal* File Size Total | integer | Sum of the sizes of all the files uploaded for this dataset. Format: int64 | ||||||||||||
| created* Creation Timestamp | datetime | Timestamp of the creation of this dataset. |
Type DatasetPostRequest (object)
HTTP POST request body requesting the creation of a dataset from the components included in the request.
For a request to be considered valid, it must contain exactly 1 of the optional parameters file or url. If a request body contains both a file and a url field value, the service will return a 400 error.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| meta* Dataset Meta | object | Metadata about the dataset being submitted. Inherits: lib.DatasetPostMeta |
| meta.datasetType* Dataset Type | object | Type of the dataset that is being uploaded. Inherits: lib.DatasetPostType |
| meta.datasetType.name* | string | |
| meta.datasetType.version* | string | |
| meta.name* Dataset Name | string | User provided name for the dataset. |
| meta.visibility Dataset Visibility | string | Default value: "private" Enum:
Inherits: lib.DatasetVisibility |
| meta.summary Dataset Summary | string | User provided summary for the dataset. |
| meta.description Dataset Description | string | User provided description for the dataset. |
| meta.origin* Dataset Origin | string | String representing the origin of the dataset. Examples include |
| meta.projects* Project IDs | array | IDs of the projects this dataset is being submitted to. |
| meta.projects[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| meta.dependencies* Dataset Dependencies | array | |
| meta.dependencies[] | object | Inherits: lib.DatasetDependency |
| meta.dependencies[].resourceIdentifier* | string | |
| meta.dependencies[].resourceDisplayName* | string | |
| meta.dependencies[].resourceVersion* | string | |
| file Dataset File | file | Dataset file to upload. This field is incompatible with the |
| url Dataset URL | string | URL to a dataset file to upload. This field is incompatible with the |
Type DatasetPostMeta (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetType* Dataset Type | object | Type of the dataset that is being uploaded. Inherits: lib.DatasetPostType |
| datasetType.name* | string | |
| datasetType.version* | string | |
| name* Dataset Name | string | User provided name for the dataset. |
| visibility Dataset Visibility | string | Default value: "private" Enum:
Inherits: lib.DatasetVisibility |
| summary Dataset Summary | string | User provided summary for the dataset. |
| description Dataset Description | string | User provided description for the dataset. |
| origin* Dataset Origin | string | String representing the origin of the dataset. Examples include |
| projects* Project IDs | array | IDs of the projects this dataset is being submitted to. |
| projects[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
| dependencies* Dataset Dependencies | array | |
| dependencies[] | object | Inherits: lib.DatasetDependency |
| dependencies[].resourceIdentifier* | string | |
| dependencies[].resourceDisplayName* | string | |
| dependencies[].resourceVersion* | string |
Type DatasetPostType (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| version* | string |
Type DatasetDependency (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| resourceIdentifier* | string | |
| resourceDisplayName* | string | |
| resourceVersion* | string |
Type DatasetPostResponse (object)
Response object returned on successful upload of a dataset.
Note that this response does not mean the uploaded dataset has been made available on the target site(s). The upload must first be processed and installed into the target sites before the dataset will become available for use.
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
Type ShareOfferEntry (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| datasetID* | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID |
| owner* | object | Details about the owner of a VDI dataset. Inherits: lib.DatasetOwner |
| owner.userID* Owner User ID | integer | VEuPathDB user ID of the owner of the dataset. Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID |
| owner.firstName Owner First Name | string | |
| owner.lastName Owner Last Name | string | |
| owner.email Owner Email | string | |
| owner.organization Owner Organization | string | |
| shareStatus* | string | Enum:
Inherits: lib.ShareOfferStatus |
| datasetType* | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo |
| datasetType.name* Type Name | string | |
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. |
| datasetType.version* Type Version | string | |
| projectIDs* | array | |
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID |
Type ShareOfferStatus (string)
- open
- accepted
- rejected
Inherits: string
Type DatasetFileListing (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| uploadFiles* | array | |
| uploadFiles[] Dataset File Details | object | Inherits: lib.DatasetFileDetails |
| uploadFiles[].name* File Name | string | |
| uploadFiles[].size* File Size | integer | Size of the file in bytes. Format: int64 |
| dataFiles* | array | |
| dataFiles[] Dataset File Details | object | Inherits: lib.DatasetFileDetails |
| dataFiles[].name* File Name | string | |
| dataFiles[].size* File Size | integer | Size of the file in bytes. Format: int64 |
Type DatasetFileDetails (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* File Name | string | |
| size* File Size | integer | Size of the file in bytes. Format: int64 |
Type DatasetDetails (object)
Details about a specific singular dataset.
Inherits: object
Model
| Parameter | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datasetID* Dataset ID | string | Unique VDI Dataset identifier string. Pattern: ^[a-zA-Z0-9_-]{14}$ Min. length: 14 Max. length: 14 Inherits: lib.VDI-ID | ||||||||||||
| owner* Owner Details | object | Details about the owner of a VDI dataset. Inherits: lib.DatasetOwner | ||||||||||||
| owner.userID* Owner User ID | integer | VEuPathDB user ID of the owner of the dataset. Min. value: 1 Max. value: 9223372036854776000 Format: int64 Inherits: lib.User-ID | ||||||||||||
| owner.firstName Owner First Name | string | |||||||||||||
| owner.lastName Owner Last Name | string | |||||||||||||
| owner.email Owner Email | string | |||||||||||||
| owner.organization Owner Organization | string | |||||||||||||
| datasetType* Dataset Type Info | object | Information about a specific dataset type. Inherits: lib.DatasetTypeInfo | ||||||||||||
| datasetType.name* Type Name | string | |||||||||||||
| datasetType.displayName Type Display Name | string | Display name for the type. This field is ignored in requests and will always be present in responses. | ||||||||||||
| datasetType.version* Type Version | string | |||||||||||||
| name* Dataset Name | string | |||||||||||||
| summary Dataset Summary | string | |||||||||||||
| description Dataset Description | string | |||||||||||||
| sourceUrl Source URL | string | URL of the dataset data source, if the dataset was uploaded via URL. | ||||||||||||
| origin* Dataset Origin | string | String representing the origin of the dataset. Examples include | ||||||||||||
| projectIDs* Project IDs | array | Project IDs for projects the user dataset record was submitted to. | ||||||||||||
| projectIDs[] Project ID | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| visibility* Dataset Visibility | string | Enum:
Inherits: lib.DatasetVisibility | ||||||||||||
| importMessages Import Messages | array | Log lines from the import process. These messages will be warnings and/or validation errors. Default value: [] | ||||||||||||
| importMessages[] | string | |||||||||||||
| status* Dataset Status Info | object | Information about the import and install status of a dataset. Inherits: lib.DatasetStatusInfo | ||||||||||||
| status.import* | string | Import status of the dataset.
Enum:
Inherits: lib.DatasetImportStatus | ||||||||||||
| status.install | array | |||||||||||||
| status.install[] Dataset Install Status Entry | object | Entry in a list of install statuses for a dataset. Inherits: lib.DatasetInstallStatusEntry | ||||||||||||
| status.install[].projectID* | string | Name or ID of a target VEuPathDB project. Valid project IDs are:
Inherits: lib.ProjectID | ||||||||||||
| status.install[].metaStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].metaMessage | string | |||||||||||||
| status.install[].dataStatus | string | Enum:
Inherits: lib.DatasetInstallStatus | ||||||||||||
| status.install[].dataMessage | string | |||||||||||||
| shares Shares | array | Array of share offers that have been created by the owner of this dataset to share it with other users. | ||||||||||||
| shares[] Share Offer | object | Inherits: lib.ShareOffer | ||||||||||||
| shares[].recipient* | object | I AM A UNION! Inherits: lib.ShareOfferRecipient | ||||||||||||
| shares[].recipient.firstName First Name | string | |||||||||||||
| shares[].recipient.lastName Last Name | string | |||||||||||||
| shares[].recipient.organization Organization | string | |||||||||||||
| shares[].recipient.email Email | string | |||||||||||||
| shares[].status* | string | Enum:
Inherits: lib.ShareOfferAction | ||||||||||||
| files* Files | array | List of files uploaded to the dataset import service. | ||||||||||||
| files[] File Summary | object | Inherits: lib.FileSummary | ||||||||||||
| files[].name* | string | |||||||||||||
| files[].size* | integer | Format: int64 | ||||||||||||
| created* Creation Timestamp | datetime | Timestamp for when this dataset was created. |
Type FileSummary (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| name* | string | |
| size* | integer | Format: int64 |
Type ShareOffer (object)
Inherits: object
Model
| Parameter | Type | Description |
|---|---|---|
| recipient* | object | I AM A UNION! Inherits: lib.ShareOfferRecipient |
| recipient.firstName First Name | string | |
| recipient.lastName Last Name | string | |
| recipient.organization Organization | string | |
| recipient.email Email | string | |
| status* | string | Enum:
Inherits: lib.ShareOfferAction |
Examples
{
"recipient": {
"firstName": "Joe",
"lastName": "User",
diff --git a/modules/rest-service/src/main/resources/api.html b/modules/rest-service/src/main/resources/api.html
index 2a1c2cf4..776fe898 100644
--- a/modules/rest-service/src/main/resources/api.html
+++ b/modules/rest-service/src/main/resources/api.html
@@ -1222,7 +1222,7 @@
bindFilters();
});
- Resources
get /vdi-datasets
List Datasets Returns a list of datasets available to the requesting user, optionally filtered by query parameters.
Results are sorted by creation date in reverse order. This means the most recently created datasets will be first and the oldest dataset will be last in the list.
Parameters chevron_right expand_more
Parameter Type Description Query project_id Project ID string ID of the VEuPathDB project that results should be filtered to.
This means only datasets that are relevant to the project ID given will be returned.
Additionally, this controls the sites on which the dataset installation status will be checked. Meaning, if this parameter is specified and set to, for example, PlasmoDB, the status block in the response objects will only include installation status details for PlasmoDB and not any other sites that the dataset may have been installed into.
Inherits: string
ownership Dataset Ownership Filter string Ownership status filter.
Enum of:
anyownedshared
If set to any the results are not filtered.
If set to owned, the results will be filtered to only results that are owned by the requesting user.
If set to shared, the results will be filtered to only results that are shared with the requesting user.
Default value: "any"
offset Result Offset integer This many results will be skipped before the first result returned.
Used to implement result pagination.
limit Result Count Limit integer Limits the number of results returned to this count.
Used to implement result pagination.
Min. value: 1
Max. value: 100
Default value: 100
sort_field Sorting Field string Field used to sort the results of this endpoint.
Valid options are:
creation_timestampname
By default, results are sorted by creation_timestamp with a sort_order query param value of descending, however if the sort field is changed, then the default value of the sort_order query param will be ascending.
This means that given the URI {site}/vdi-datasets the results will be returned in descending order by the creation timestamp of the results.
However, given the URI {site}/vdi-datasets?sort_field=name the results will be returned in ascending order by the user provided name for the datasets.
Default value: "creation_timestamp"
sort_order* Sorting Order string Sort ordering of the results of this endpoint.
Valid options are:
- ascending
- descending
By default, results are sorted by the sort_field value "creation_timestamp" in "descending" order, however if the sort field is changed then the default value of this query parameter becomes "ascending" by default.
This means that given the URI {site}/vdi-datasets the results will be returned in descending order by the creation timestamp of the results.
However, given the URI {site}/vdi-datasets?sort_field=name the results will be returned in ascending order by the user provided name for the datasets.
curl -X GET \
+ Resources
get /vdi-datasets
List Datasets Returns a list of datasets available to the requesting user, optionally filtered by query parameters.
Results are sorted by creation date in reverse order. This means the most recently created datasets will be first and the oldest dataset will be last in the list.
Parameters chevron_right expand_more
Parameter Type Description Query project_id Project ID string ID of the VEuPathDB project that results should be filtered to.
This means only datasets that are relevant to the project ID given will be returned.
Additionally, this controls the sites on which the dataset installation status will be checked. Meaning, if this parameter is specified and set to, for example, PlasmoDB, the status block in the response objects will only include installation status details for PlasmoDB and not any other sites that the dataset may have been installed into.
Inherits: string
ownership Dataset Ownership Filter string Ownership status filter.
Enum of:
anyownedshared
If set to any the results are not filtered.
If set to owned, the results will be filtered to only results that are owned by the requesting user.
If set to shared, the results will be filtered to only results that are shared with the requesting user.
Default value: "any"
offset Result Offset integer This many results will be skipped before the first result returned.
Used to implement result pagination.
limit Result Count Limit integer Limits the number of results returned to this count.
Used to implement result pagination.
Min. value: 1
Max. value: 100
Default value: 100
sort_field Sorting Field string Field used to sort the results of this endpoint.
Valid options are:
creation_timestampname
By default, results are sorted by creation_timestamp with a sort_order query param value of descending, however if the sort field is changed, then the default value of the sort_order query param will be ascending.
This means that given the URI {site}/vdi-datasets the results will be returned in descending order by the creation timestamp of the results.
However, given the URI {site}/vdi-datasets?sort_field=name the results will be returned in ascending order by the user provided name for the datasets.
Default value: "creation_timestamp"
sort_order* Sorting Order string Sort ordering of the results of this endpoint.
Valid options are:
- asc
- desc
By default, results are sorted by the sort_field value "creation_timestamp" in "desc" order, however if the sort field is changed then the default value of this query parameter becomes "asc" by default.
This means that given the URI {site}/vdi-datasets the results will be returned in descending order by the creation timestamp of the results.
However, given the URI {site}/vdi-datasets?sort_field=name the results will be returned in ascending order by the user provided name for the datasets.
curl -X GET \
undefined/vdi-datasets?ProjectID=<value>&ownership=<value>&offset=<value>&limit=<value>&sort_field=<value>&sort_order=<value>
200 OK chevron_right expand_more
Success.
This response means that all checks passed and zero or more dataset records were found for the requesting user.
application/json
application/json
Parameter Type Description [] Dataset List Item object Short entry with basic details about a dataset.
Inherits: object
[].datasetID* Dataset ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
[].owner* Owner Details object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
[].owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
[].owner.firstName Owner First Name string [].owner.lastName Owner Last Name string [].owner.email Owner Email string [].owner.organization Owner Organization string [].datasetType* Dataset Type object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
[].datasetType.name* Type Name string [].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
[].datasetType.version* Type Version string [].visibility* Dataset Visibility string Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
[].name* Dataset Name string User provided name for the dataset.
[].summary Dataset Summary string User provided summary of the dataset.
[].description Dataset Description string User provided description of the dataset.
[].sourceUrl Source URL string URL of the dataset data source, if the dataset was uploaded via URL.
[].origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
[].projectIDs* Project IDs array Project IDs for projects the dataset record was submitted to.
[].projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
[].status* Status Info object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
[].status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
[].status.install array [].status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
[].status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
[].status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
[].status.install[].metaMessage string [].status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
[].status.install[].dataMessage string [].shares* Shared With array [].shares[] object Inherits: object
[].shares[].userID* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
[].shares[].firstName* string [].shares[].lastName* string [].shares[].organization* string [].shares[].accepted* boolean [].fileCount* File Count integer Number of files uploaded for this dataset.
[].fileSizeTotal* File Size Total integer Sum of the sizes of all the files uploaded for this dataset.
Format: int64
[].created* Creation Timestamp datetime Timestamp of the creation of this dataset.
Response Body
[
{
"datasetID": "zaZqAAGLGJhBgg",
@@ -1341,7 +1341,9 @@
"status": "server-error",
"message": "Dataset store is unreachable",
"requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
-}
get /vdi-datasets/admin/list-broken
List Broken Installs Lists datasets that failed installation due to non-user error.
Parameters chevron_right expand_more
Parameter Type Description Query expanded Expanded Dataset List boolean Whether the returned broken dataset install list should be expanded to include additional details about each dataset or should be just a simple list of dataset IDs.
Default value: true
Headers chevron_right expand_more
Parameter Type Description Admin-Token* Admin Auth Secret Key string Secret key used to authenticate admin endpoint requests.
curl -X GET \
+}
get /vdi-datasets/admin/failed-imports
List Lists datasets that failed to import.
Parameters chevron_right expand_more
Parameter Type Description Query user VEuPathDB User ID integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: integer
before string Filter results to only those records created before the given date-time value.
Examples:
- 2023
- 2023-10
- 2023-10-02
- 2023-10-02T17:10
- 2023-10-02T17:10:00
- 2023-10-02T17:10:00.000
- 2023-10-02T17:10:00.000Z
If no timezone is provided, the service will assume its local zone.
after string Filter results to only those records created after the given date-time value.
Examples:
- 2023
- 2023-10
- 2023-10-02
- 2023-10-02T17:10
- 2023-10-02T17:10:00
- 2023-10-02T17:10:00.000
- 2023-10-02T17:10:00.000Z
If no timezone is provided, the service will assume its local zone.
limit integer Max. value: 250
Default value: 100
offset integer sort string One of:
- date
Default value: "date"
order string One of:
- asc
- desc
Default value: "desc"
Headers chevron_right expand_more
Parameter Type Description Admin-Token* Admin Auth Secret Key string Secret key used to authenticate admin endpoint requests.
curl -X GET \
+ -H "Admin-Token: <value>" \
+ undefined/vdi-datasets/admin/failed-imports?User-ID=<value>&before=<value>&after=<value>&limit=<value>&offset=<value>&sort=<value>&order=<value>
200 OK chevron_right expand_more
Broken Import Listing BrokenImportListing
application/json
Inherits: object
Parameter Type Description meta* object Inherits: lib.BrokenImportListingMeta
meta.count* integer meta.before string meta.after string meta.user integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
meta.limit integer meta.offset integer results* array results[] Broken Import Details object Inherits: lib.BrokenImportDetails
results[].datasetId* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
results[].owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
results[].datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
results[].datasetType.name* Type Name string results[].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
results[].datasetType.version* Type Version string results[].projectIds* array results[].projectIds[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
results[].messages* array results[].messages[] string
get /vdi-datasets/admin/list-broken
List Broken Installs Lists datasets that failed installation due to non-user error.
Parameters chevron_right expand_more
Parameter Type Description Query expanded Expanded Dataset List boolean Whether the returned broken dataset install list should be expanded to include additional details about each dataset or should be just a simple list of dataset IDs.
Default value: true
Headers chevron_right expand_more
Parameter Type Description Admin-Token* Admin Auth Secret Key string Secret key used to authenticate admin endpoint requests.
curl -X GET \
-H "Admin-Token: <value>" \
undefined/vdi-datasets/admin/list-broken?expanded=<value>
200 OK chevron_right expand_more
Success.
Broken dataset install list successfully generated.
Broken Dataset Listing BrokenDatasetListing
application/json
Inherits: object
Parameter Type Description details array details[] Broken Dataset Details object Inherits: lib.BrokenDatasetDetails
details[].datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
details[].owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
details[].datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
details[].datasetType.name* Type Name string details[].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
details[].datasetType.version* Type Version string details[].projectIDs* array details[].projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
details[].status* object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
details[].status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
details[].status.install array details[].status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
details[].status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
details[].status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
details[].status.install[].metaMessage string details[].status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
details[].status.install[].dataMessage string ids array ids[] VDI ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
401 Unauthorized chevron_right expand_more
Unauthorized
Unauthorized UnauthorizedError
application/json
Unauthenticated client requested a resource that requires authentication.
Discriminator: status
Discriminator value: unauthorized
Inherits: lib.Error
Parameter Type Description status* string Enum:- bad-request
- unauthorized
- forbidden
- not-found
- bad-method
- invalid-input
- server-error
Inherits: lib.ErrorType
message* string
Response Body
{
"status": "unauthorized",
@@ -1641,7 +1643,7 @@
"message": "Datastore connection lost",
"requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}
get /metrics
Prometheus metrics for the service.
curl -X GET \
- undefined/metrics
200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Types
Type BrokenDatasetListing (object)
Broken Dataset ListingInherits: object
Model
Parameter Type Description details array details[] Broken Dataset Details object Inherits: lib.BrokenDatasetDetails
details[].datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
details[].owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
details[].datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
details[].datasetType.name* Type Name string details[].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
details[].datasetType.version* Type Version string details[].projectIDs* array details[].projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
details[].status* object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
details[].status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
details[].status.install array details[].status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
details[].status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
details[].status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
details[].status.install[].metaMessage string details[].status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
details[].status.install[].dataMessage string ids array ids[] VDI ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
Type BrokenDatasetDetails (object)
Broken Dataset DetailsInherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string projectIDs* array projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status* object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
status.install array status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].metaMessage string status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].dataMessage string
Type InstallCleanupRequest (object)
Install Cleanup RequestObject controlling the install cleanup process and what datasets it should target.
Requesters should specify one of the fields all or targets to control what datasets will be cleaned up. If neither is specified the endpoint will do nothing.
Inherits: object
Model
Parameter Type Description all boolean targets array Unique items: Yes
targets[] Install Cleanup Target object Inherits: lib.InstallCleanupTarget
targets[].datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
targets[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
Type InstallCleanupTarget (object)
Install Cleanup TargetInherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
Type DatasetListShareUser (object)
DatasetListShareUserInherits: object
Model
Parameter Type Description userID* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
firstName* string lastName* string organization* string accepted* boolean
Type DatasetListEntry (object)
Dataset List ItemShort entry with basic details about a dataset.
Inherits: object
Model
Parameter Type Description datasetID* Dataset ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* Owner Details object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
owner.firstName Owner First Name string owner.lastName Owner Last Name string owner.email Owner Email string owner.organization Owner Organization string datasetType* Dataset Type object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string visibility* Dataset Visibility string Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
name* Dataset Name string User provided name for the dataset.
summary Dataset Summary string User provided summary of the dataset.
description Dataset Description string User provided description of the dataset.
sourceUrl Source URL string URL of the dataset data source, if the dataset was uploaded via URL.
origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
projectIDs* Project IDs array Project IDs for projects the dataset record was submitted to.
projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status* Status Info object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
status.install array status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].metaMessage string status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].dataMessage string shares* Shared With array shares[] object Inherits: object
shares[].userID* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
shares[].firstName* string shares[].lastName* string shares[].organization* string shares[].accepted* boolean fileCount* File Count integer Number of files uploaded for this dataset.
fileSizeTotal* File Size Total integer Sum of the sizes of all the files uploaded for this dataset.
Format: int64
created* Creation Timestamp datetime Timestamp of the creation of this dataset.
Type DatasetPostRequest (object)
Dataset Post RequestHTTP POST request body requesting the creation of a dataset from the components included in the request.
For a request to be considered valid, it must contain exactly 1 of the optional parameters file or url. If a request body contains both a file and a url field value, the service will return a 400 error.
Inherits: object
Model
Parameter Type Description meta* Dataset Meta object Metadata about the dataset being submitted.
Inherits: lib.DatasetPostMeta
meta.datasetType* Dataset Type object Type of the dataset that is being uploaded.
Inherits: lib.DatasetPostType
meta.datasetType.name* string meta.datasetType.version* string meta.name* Dataset Name string User provided name for the dataset.
meta.visibility Dataset Visibility string Default value: "private"
Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
meta.summary Dataset Summary string User provided summary for the dataset.
meta.description Dataset Description string User provided description for the dataset.
meta.origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
meta.projects* Project IDs array IDs of the projects this dataset is being submitted to.
meta.projects[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
meta.dependencies* Dataset Dependencies array meta.dependencies[] object Inherits: lib.DatasetDependency
meta.dependencies[].resourceIdentifier* string meta.dependencies[].resourceDisplayName* string meta.dependencies[].resourceVersion* string file Dataset File file Dataset file to upload.
This field is incompatible with the url field.
url Dataset URL string URL to a dataset file to upload.
This field is incompatible with the file field.
Type DatasetPostMeta (object)
DatasetPostMetaInherits: object
Model
Parameter Type Description datasetType* Dataset Type object Type of the dataset that is being uploaded.
Inherits: lib.DatasetPostType
datasetType.name* string datasetType.version* string name* Dataset Name string User provided name for the dataset.
visibility Dataset Visibility string Default value: "private"
Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
summary Dataset Summary string User provided summary for the dataset.
description Dataset Description string User provided description for the dataset.
origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
projects* Project IDs array IDs of the projects this dataset is being submitted to.
projects[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
dependencies* Dataset Dependencies array dependencies[] object Inherits: lib.DatasetDependency
dependencies[].resourceIdentifier* string dependencies[].resourceDisplayName* string dependencies[].resourceVersion* string
Type DatasetPostType (object)
DatasetPostTypeInherits: object
Model
Parameter Type Description name* string version* string
Type DatasetDependency (object)
DatasetDependencyInherits: object
Model
Parameter Type Description resourceIdentifier* string resourceDisplayName* string resourceVersion* string
Type DatasetPostResponse (object)
Dataset Upload ResponseResponse object returned on successful upload of a dataset.
Note that this response does not mean the uploaded dataset has been made available on the target site(s). The upload must first be processed and installed into the target sites before the dataset will become available for use.
Inherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
Type ShareOfferEntry (object)
Share OfferInherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
owner.firstName Owner First Name string owner.lastName Owner Last Name string owner.email Owner Email string owner.organization Owner Organization string shareStatus* string Enum:- open
- accepted
- rejected
Inherits: lib.ShareOfferStatus
datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string projectIDs* array projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
Type ShareOfferStatus (string)
Share Offer StatusEnum:- open
- accepted
- rejected
Inherits: string
Type DatasetFileListing (object)
Dataset File ListingInherits: object
Model
Parameter Type Description uploadFiles* array uploadFiles[] Dataset File Details object Inherits: lib.DatasetFileDetails
uploadFiles[].name* File Name string uploadFiles[].size* File Size integer Size of the file in bytes.
Format: int64
dataFiles* array dataFiles[] Dataset File Details object Inherits: lib.DatasetFileDetails
dataFiles[].name* File Name string dataFiles[].size* File Size integer Size of the file in bytes.
Format: int64
Type DatasetFileDetails (object)
Dataset File DetailsInherits: object
Model
Parameter Type Description name* File Name string size* File Size integer Size of the file in bytes.
Format: int64
Type DatasetDetails (object)
Dataset DetailsDetails about a specific singular dataset.
Inherits: object
Model
Parameter Type Description datasetID* Dataset ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* Owner Details object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
owner.firstName Owner First Name string owner.lastName Owner Last Name string owner.email Owner Email string owner.organization Owner Organization string datasetType* Dataset Type Info object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string name* Dataset Name string summary Dataset Summary string description Dataset Description string sourceUrl Source URL string URL of the dataset data source, if the dataset was uploaded via URL.
origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
projectIDs* Project IDs array Project IDs for projects the user dataset record was submitted to.
projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
visibility* Dataset Visibility string Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
importMessages Import Messages array Log lines from the import process.
These messages will be warnings and/or validation errors.
Default value: []
importMessages[] string status* Dataset Status Info object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
status.install array status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].metaMessage string status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].dataMessage string shares Shares array Array of share offers that have been created by the owner of this dataset to share it with other users.
shares[] Share Offer object Inherits: lib.ShareOffer
shares[].recipient* object I AM A UNION!
Inherits: lib.ShareOfferRecipient
shares[].recipient.firstName First Name string shares[].recipient.lastName Last Name string shares[].recipient.organization Organization string shares[].recipient.email Email string shares[].status* string Enum:- grant
- revoke
Inherits: lib.ShareOfferAction
files* Files array List of files uploaded to the dataset import service.
files[] File Summary object Inherits: lib.FileSummary
files[].name* string files[].size* integer Format: int64
created* Creation Timestamp datetime Timestamp for when this dataset was created.
Type FileSummary (object)
File SummaryInherits: object
Model
Parameter Type Description name* string size* integer Format: int64
Type ShareOffer (object)
Share OfferInherits: object
Model
Parameter Type Description recipient* object I AM A UNION!
Inherits: lib.ShareOfferRecipient
recipient.firstName First Name string recipient.lastName Last Name string recipient.organization Organization string recipient.email Email string status* string Enum:- grant
- revoke
Inherits: lib.ShareOfferAction
Examples
{
+ undefined/metrics
200 OK chevron_right expand_more
text/plain
text/plain
Security Schemes
Types
Type BrokenDatasetListing (object)
Broken Dataset ListingInherits: object
Model
Parameter Type Description details array details[] Broken Dataset Details object Inherits: lib.BrokenDatasetDetails
details[].datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
details[].owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
details[].datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
details[].datasetType.name* Type Name string details[].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
details[].datasetType.version* Type Version string details[].projectIDs* array details[].projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
details[].status* object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
details[].status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
details[].status.install array details[].status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
details[].status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
details[].status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
details[].status.install[].metaMessage string details[].status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
details[].status.install[].dataMessage string ids array ids[] VDI ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
Type BrokenDatasetDetails (object)
Broken Dataset DetailsInherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string projectIDs* array projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status* object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
status.install array status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].metaMessage string status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].dataMessage string
Type BrokenImportListing (object)
Broken Import ListingInherits: object
Model
Parameter Type Description meta* object Inherits: lib.BrokenImportListingMeta
meta.count* integer meta.before string meta.after string meta.user integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
meta.limit integer meta.offset integer results* array results[] Broken Import Details object Inherits: lib.BrokenImportDetails
results[].datasetId* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
results[].owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
results[].datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
results[].datasetType.name* Type Name string results[].datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
results[].datasetType.version* Type Version string results[].projectIds* array results[].projectIds[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
results[].messages* array results[].messages[] string
Type BrokenImportListingMeta (object)
BrokenImportListingMetaInherits: object
Model
Parameter Type Description count* integer before string after string user integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
limit integer offset integer
Type BrokenImportDetails (object)
Broken Import DetailsInherits: object
Model
Parameter Type Description datasetId* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string projectIds* array projectIds[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
messages* array messages[] string
Type InstallCleanupRequest (object)
Install Cleanup RequestObject controlling the install cleanup process and what datasets it should target.
Requesters should specify one of the fields all or targets to control what datasets will be cleaned up. If neither is specified the endpoint will do nothing.
Inherits: object
Model
Parameter Type Description all boolean targets array Unique items: Yes
targets[] Install Cleanup Target object Inherits: lib.InstallCleanupTarget
targets[].datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
targets[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
Type InstallCleanupTarget (object)
Install Cleanup TargetInherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
Type DatasetListShareUser (object)
DatasetListShareUserInherits: object
Model
Parameter Type Description userID* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
firstName* string lastName* string organization* string accepted* boolean
Type DatasetListEntry (object)
Dataset List ItemShort entry with basic details about a dataset.
Inherits: object
Model
Parameter Type Description datasetID* Dataset ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* Owner Details object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
owner.firstName Owner First Name string owner.lastName Owner Last Name string owner.email Owner Email string owner.organization Owner Organization string datasetType* Dataset Type object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string visibility* Dataset Visibility string Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
name* Dataset Name string User provided name for the dataset.
summary Dataset Summary string User provided summary of the dataset.
description Dataset Description string User provided description of the dataset.
sourceUrl Source URL string URL of the dataset data source, if the dataset was uploaded via URL.
origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
projectIDs* Project IDs array Project IDs for projects the dataset record was submitted to.
projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status* Status Info object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
status.install array status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].metaMessage string status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].dataMessage string shares* Shared With array shares[] object Inherits: object
shares[].userID* integer Unique user identifier
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
shares[].firstName* string shares[].lastName* string shares[].organization* string shares[].accepted* boolean fileCount* File Count integer Number of files uploaded for this dataset.
fileSizeTotal* File Size Total integer Sum of the sizes of all the files uploaded for this dataset.
Format: int64
created* Creation Timestamp datetime Timestamp of the creation of this dataset.
Type DatasetPostRequest (object)
Dataset Post RequestHTTP POST request body requesting the creation of a dataset from the components included in the request.
For a request to be considered valid, it must contain exactly 1 of the optional parameters file or url. If a request body contains both a file and a url field value, the service will return a 400 error.
Inherits: object
Model
Parameter Type Description meta* Dataset Meta object Metadata about the dataset being submitted.
Inherits: lib.DatasetPostMeta
meta.datasetType* Dataset Type object Type of the dataset that is being uploaded.
Inherits: lib.DatasetPostType
meta.datasetType.name* string meta.datasetType.version* string meta.name* Dataset Name string User provided name for the dataset.
meta.visibility Dataset Visibility string Default value: "private"
Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
meta.summary Dataset Summary string User provided summary for the dataset.
meta.description Dataset Description string User provided description for the dataset.
meta.origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
meta.projects* Project IDs array IDs of the projects this dataset is being submitted to.
meta.projects[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
meta.dependencies* Dataset Dependencies array meta.dependencies[] object Inherits: lib.DatasetDependency
meta.dependencies[].resourceIdentifier* string meta.dependencies[].resourceDisplayName* string meta.dependencies[].resourceVersion* string file Dataset File file Dataset file to upload.
This field is incompatible with the url field.
url Dataset URL string URL to a dataset file to upload.
This field is incompatible with the file field.
Type DatasetPostMeta (object)
DatasetPostMetaInherits: object
Model
Parameter Type Description datasetType* Dataset Type object Type of the dataset that is being uploaded.
Inherits: lib.DatasetPostType
datasetType.name* string datasetType.version* string name* Dataset Name string User provided name for the dataset.
visibility Dataset Visibility string Default value: "private"
Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
summary Dataset Summary string User provided summary for the dataset.
description Dataset Description string User provided description for the dataset.
origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
projects* Project IDs array IDs of the projects this dataset is being submitted to.
projects[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
dependencies* Dataset Dependencies array dependencies[] object Inherits: lib.DatasetDependency
dependencies[].resourceIdentifier* string dependencies[].resourceDisplayName* string dependencies[].resourceVersion* string
Type DatasetPostType (object)
DatasetPostTypeInherits: object
Model
Parameter Type Description name* string version* string
Type DatasetDependency (object)
DatasetDependencyInherits: object
Model
Parameter Type Description resourceIdentifier* string resourceDisplayName* string resourceVersion* string
Type DatasetPostResponse (object)
Dataset Upload ResponseResponse object returned on successful upload of a dataset.
Note that this response does not mean the uploaded dataset has been made available on the target site(s). The upload must first be processed and installed into the target sites before the dataset will become available for use.
Inherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
Type ShareOfferEntry (object)
Share OfferInherits: object
Model
Parameter Type Description datasetID* string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
owner.firstName Owner First Name string owner.lastName Owner Last Name string owner.email Owner Email string owner.organization Owner Organization string shareStatus* string Enum:- open
- accepted
- rejected
Inherits: lib.ShareOfferStatus
datasetType* object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string projectIDs* array projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
Type ShareOfferStatus (string)
Share Offer StatusEnum:- open
- accepted
- rejected
Inherits: string
Type DatasetFileListing (object)
Dataset File ListingInherits: object
Model
Parameter Type Description uploadFiles* array uploadFiles[] Dataset File Details object Inherits: lib.DatasetFileDetails
uploadFiles[].name* File Name string uploadFiles[].size* File Size integer Size of the file in bytes.
Format: int64
dataFiles* array dataFiles[] Dataset File Details object Inherits: lib.DatasetFileDetails
dataFiles[].name* File Name string dataFiles[].size* File Size integer Size of the file in bytes.
Format: int64
Type DatasetFileDetails (object)
Dataset File DetailsInherits: object
Model
Parameter Type Description name* File Name string size* File Size integer Size of the file in bytes.
Format: int64
Type DatasetDetails (object)
Dataset DetailsDetails about a specific singular dataset.
Inherits: object
Model
Parameter Type Description datasetID* Dataset ID string Unique VDI Dataset identifier string.
Pattern: ^[a-zA-Z0-9_-]{14}$
Min. length: 14
Max. length: 14
Inherits: lib.VDI-ID
owner* Owner Details object Details about the owner of a VDI dataset.
Inherits: lib.DatasetOwner
owner.userID* Owner User ID integer VEuPathDB user ID of the owner of the dataset.
Min. value: 1
Max. value: 9223372036854776000
Format: int64
Inherits: lib.User-ID
owner.firstName Owner First Name string owner.lastName Owner Last Name string owner.email Owner Email string owner.organization Owner Organization string datasetType* Dataset Type Info object Information about a specific dataset type.
Inherits: lib.DatasetTypeInfo
datasetType.name* Type Name string datasetType.displayName Type Display Name string Display name for the type. This field is ignored in requests and will always be present in responses.
datasetType.version* Type Version string name* Dataset Name string summary Dataset Summary string description Dataset Description string sourceUrl Source URL string URL of the dataset data source, if the dataset was uploaded via URL.
origin* Dataset Origin string String representing the origin of the dataset. Examples include direct-upload, nephele, or galaxy.
projectIDs* Project IDs array Project IDs for projects the user dataset record was submitted to.
projectIDs[] Project ID string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
visibility* Dataset Visibility string Enum:- private
- protected
- public
Inherits: lib.DatasetVisibility
importMessages Import Messages array Log lines from the import process.
These messages will be warnings and/or validation errors.
Default value: []
importMessages[] string status* Dataset Status Info object Information about the import and install status of a dataset.
Inherits: lib.DatasetStatusInfo
status.import* string Import status of the dataset.
Value Description queuedThe dataset has not yet been processed and is waiting in the queue. in-progressThe dataset is currently being import processed. completeThe dataset has been processed and imported for installation. invalidThe dataset failed import validation. failedThe dataset import failed due to an internal server error.
Enum:- queued
- in-progress
- complete
- invalid
- failed
Inherits: lib.DatasetImportStatus
status.install array status.install[] Dataset Install Status Entry object Entry in a list of install statuses for a dataset.
Inherits: lib.DatasetInstallStatusEntry
status.install[].projectID* string Name or ID of a target VEuPathDB project.
Valid project IDs are:
- AmoebaDB
- CryptoDB
- FungiDB
- GiardiaDB
- HostDB
- MicrosporidiaDB
- PiroplasmaDB
- PlasmoDB
- ToxoDB
- TrichDB
- TriTrypDB
- VectorBase
- VEuPathDB
Inherits: lib.ProjectID
status.install[].metaStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].metaMessage string status.install[].dataStatus string Enum:- running
- complete
- failed-validation
- failed-installation
- ready-for-reinstall
- missing-dependency
Inherits: lib.DatasetInstallStatus
status.install[].dataMessage string shares Shares array Array of share offers that have been created by the owner of this dataset to share it with other users.
shares[] Share Offer object Inherits: lib.ShareOffer
shares[].recipient* object I AM A UNION!
Inherits: lib.ShareOfferRecipient
shares[].recipient.firstName First Name string shares[].recipient.lastName Last Name string shares[].recipient.organization Organization string shares[].recipient.email Email string shares[].status* string Enum:- grant
- revoke
Inherits: lib.ShareOfferAction
files* Files array List of files uploaded to the dataset import service.
files[] File Summary object Inherits: lib.FileSummary
files[].name* string files[].size* integer Format: int64
created* Creation Timestamp datetime Timestamp for when this dataset was created.
Type FileSummary (object)
File SummaryInherits: object
Model
Parameter Type Description name* string size* integer Format: int64
Type ShareOffer (object)
Share OfferInherits: object
Model
Parameter Type Description recipient* object I AM A UNION!
Inherits: lib.ShareOfferRecipient
recipient.firstName First Name string recipient.lastName Last Name string recipient.organization Organization string recipient.email Email string status* string Enum:- grant
- revoke
Inherits: lib.ShareOfferAction
Examples
{
"recipient": {
"firstName": "Joe",
"lastName": "User",