×

List projects

Get statements

Get dataset

Returns a dataset.

Request:

GET /api/public/v1/dataset/:datasetId

The datasetId identifies the dataset which must belong to a project to which the user must have read access.

Response:

{
    payload: {
        datasetId: string,
        projectId: string,
        name: string,
        description?: string,
        sampleCount: number,
        featureCount: number,
        sizeInBytes: number
    },
    status: "success"
}

The datasetId is the same as in the request. The projectId identifies the project to which the dataset belongs. The name and optional description fields name and describe the dataset, respectively. The sampleCount and featureCount provide the dimensions of the dataset, while sizeInBytes provides an indication of the storage space occupied by the dataset, in bytes.

Example

$ http --body https://jadapi.jadbio.com/api/public/v1/dataset/57 \
       "Authorization: Bearer $(cat ~/.jadtoken)"
{
    "payload": {
        "datasetId": "57",
        "description": "Cohorte 42, full",
        "featureCount": 504,
        "name": "Data42",
        "projectId: "16",
        "sampleCount": 70,
        "sizeInBytes": 406241
    },
    "status": "success"
}

Get datasets

Returns a sublist of the datasets in a project.

Request:

GET /api/public/v1/datasets/:projectId/:offset/:count

The projectId identifies the project to which the user must have read permissions. Datasets form an ordered list from which the request extracts the sublist starting at offset and containing at most count elements. The list uses zero-based indexing, meaning the first element is at offset 0.

Constraints: Both offset and count must be non-negative integers and count can be at most 100.

Response:

{
    payload: {
        projectId: string,
        offset: number,
        totalCount: number,
        data: {
            datasetId: string,
            projectId: string,
            name: string,
            description?: string,
            sampleCount: number,
            featureCount: number,
            sizeInBytes: number
        }[]
    },
    status: "success"
}

The projectId and offset are the parameters given in the request. The totalCount is the total number of datasets available in the project. The data array contains the datasets requested. The length of data will be the smaller of count and totalCount − offset. If the latter value is negative, the length will be zero. The datasetId identifies each dataset returned. The name and optional description fields name and describe each dataset, respectively. The sampleCount ad featureCount provide the dimensions of each dataset, while sizeInBytes provides an indication of the storage space occupied by the dataset, in bytes.

Example

$ http --body https://jadapi.jadbio.com/api/public/v1/datasets/16/0/10 \
       "Authorization: Bearer $(cat ~/.jadtoken)"
{
    "payload": {
        "data": [{
            "datasetId": "57",
            "description": "Cohorte 42, full",
            "featureCount": 504,
            "name": "Data42",
            "projectId: "16",
            "sampleCount": 70,
            "sizeInBytes": 406241
        }, {
            "datasetId": "58",
            "featureCount": 1237,
            "name": "Data43",
            "projectId: "16",
            "sampleCount": 35,
            "sizeInBytes": 2980337
        }],
        "offset": 0,
        "projectId: "16",
        "totalCount": 2
    },
    "status": "success"
}

Delete dataset

Allows clients to delete a specified dataset. Beware that this operation silently deletes all associated analyses and model uses.

Request:

POST /api/public/v1/dataset/:datasetId/delete

The datasetId identifies the dataset. It must belong to a project to which the user has write permissions.

Response:

{
    payload: {
        datasetId: string,
        projectId: string,
        name: string,
        description?: string,
        sampleCount: number,
        featureCount: number,
        sizeInBytes: number
    },
    status: "success"
}

The datasetId is the same as in the request. The projectId identifies the project of which the dataset belonged. The name and optional description fields name and describe the deleted dataset, respectively. The sampleCount ad featureCount provide the dimensions of the dataset, while sizeInBytes provides an indication of the storage space occupied by the dataset, in bytes, just before deletion.

Example

$ http --body POST https://jadapi.jadbio.com/api/public/v1/dataset/57/delete \
       "Authorization: Bearer $(cat ~/.jadtoken)"
{
    "payload": {
        "datasetId": "57",
        "description": "Cohorte 42, full",
        "featureCount": 504,
        "name": "Data42",
        "projectId: "16",
        "sampleCount": 70,
        "sizeInBytes": 406241
    },
    "status": "success"
}

---

Note of appreciation to JADBio users

We constantly make changes in the software and do our best to update these materials, but you may notice some differences. We welcome your feedback on how to make this more useful for you and requests for future tutorials.