×

Get statements

Get project

Returns a project.

Request:

GET /api/public/v1/project/:projectId

The projectId identifies the project to which the user must have read access.

Response:

{
    payload: { projectId: string, name: string, description?: string },
    status: "success"
}

The projectId is the same as in the request. The name and optional description fields name and describe the project, respectively.

Example

$ http --body https://jadapi.jadbio.com/api/public/v1/project/16 \
       "Authorization: Bearer $(cat ~/.jadtoken)"
{
    "payload": { "projectId": "16", "name": "First cohorte" },
    "status": "success"
}

Get projects

Returns a sublist of projects owned by the user.

Request:

GET /api/public/v1/projects/owned/:offset/:count

Projects 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: {
        offset: number,
        totalCount: number,
        data: { projectId: string, name: string, description?: string }[]
    },
    status: "success"
}

The offset is the parameter given in the request. The totalCount is the total number of projects available. The data array contains the projects 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 projectId identifies each project returned. The name and optional description fields name and describe each project, respectively.

Example

$ http --body https://jadapi.jadbio.com/api/public/v1/projects/owned/0/10 \
       "Authorization: Bearer $(cat ~/.jadtoken)"
{
    "payload": {
        "data": [
            { "projectId": "16", "name": "First cohorte" },
            { "projectId": "17", "name": "Second cohorte", "description": "Pending" }
        ],
        "offset": 0,
        "totalCount": 2
    },
    "status": "success"
}

Delete a project

Allows clients to delete a specified project. Beware that this operation silently deletes all contained datasets, analyses, and model uses.

Request:

POST /api/public/v1/project/:projectId/delete

The projectId identifies the project. It must be owned by the user.

Response:

{
    payload: { projectId: string, name: string, description?: string },
    status: "success"
}

The projectId is the same as in the request. The name and optional description fields name and describe the deleted project, respectively.

Example

$ http --body POST https://jadapi.jadbio.com/api/public/v1/project/16/delete \
       "Authorization: Bearer $(cat ~/.jadtoken)"
{
    "payload": { "projectId": "16", "name": "First cohorte" },
    "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.

---

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.