Project

Create new Project

POST https://your.host.lab/projects

Request Body

Name

Type

Description

name*

String

description*

String

document_link*

String

key*

String

labeling_type*

is_public*

Boolean

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637640802,
    "data": {
        "id": "91eaceca-3586-4f5f-b49d-0f41e876571d",
        "name":"test",
        "description":"test",
        "created_by":"test",
        "created": 1637640802,
        "modified": 1637640802,
        "label_group_id": "00000000-0000-0000-0000-000000000000",
        "document_link": "",
        "key": "TP2",
        "labeling_type": "MEDICAL_3D",
        "is_public": false,
        "is_enabled": true
    }
}OldOld

Get all Projects

GET https://your.host.lab/projects

Get all projects that an user can fetch, depend on their role and permission

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637641256,
    "data": [
        {
            "id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "name":"test",
            "description":"test",
            "created_by":"test",
            "created": 1637140320,
            "modified": 1637140320,
            "label_group_id": "00000000-0000-0000-0000-000000000000",
            "document_link": "",
            "key": "TP1",
            "labeling_type": "MEDICAL_2D",
            "is_public": true,
            "is_enabled": true
        },
        {
            "id": "91eaceca-3586-4f5f-b49d-0f41e876571d",
            "name":"test",
            "description":"test",
            "created_by":"test",
            "created": 1637640802,
            "modified": 1637640802,
            "label_group_id": "00000000-0000-0000-0000-000000000000",
            "document_link": "",
            "key": "TP2",
            "labeling_type": "MEDICAL_3D",
            "is_public": false,
            "is_enabled": true
        }
    ]
}

Get Projects as Manager

GET https://your.host.lab/projects/as-manager

Old:

/stats/projects_by_role?_offset=0&_limit=25&role=PROJECT_OWNER

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637740069,
    "data": [
        {
            "id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "name":"test",
            "description":"test",
            "key": "TP1",
            "meta": {
                "REVIEWING": 1,
                "TO_REVIEW": 1
            }
        },
        {
            "id": "91eaceca-3586-4f5f-b49d-0f41e876571d",
            "name":"test",
            "description":"test",
            "key": "TP2"
        }
    ]
}

Get Projects as Labeler

GET https://your.host.lab/projects/as-labeler

Old:

/stats/projects_by_role?_offset=0&_limit=25&role=ANNOTATOR&role=REVIEWER

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637740069,
    "data": [
        {
            "id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "name":"test",
            "description":"test",
            "key": "TP1",
            "meta": {
                "NEW": 1,
                "DOING": 1
            }
        },
        {
            "id": "91eaceca-3586-4f5f-b49d-0f41e876571d",
            "name":"test",
            "description":"test",
            "key": "TP2"
        }
    ]
}

Get all public Projects for guest

GET https://your.host.lab/projects/as-guest

Get projects for guest

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637641344,
    "data": [
        {
            "id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "name":"test",
            "description":"test",
            "key": "TP1"
        },
        {
            "id": "91eaceca-3586-4f5f-b49d-0f41e876571d",
            "name":"test",
            "description":"test",
            "key": "TP2"
        }
    ]
}

Get all projects created by you

GET https://your.host.lab/projects/as-creator

Get projects for guest

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637641344,
    "data": [
        {
            "id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "name":"test",
            "description":"test",
            "key": "TP1"
        },
        {
            "id": "91eaceca-3586-4f5f-b49d-0f41e876571d",
            "name":"test",
            "description":"test",
            "key": "TP2"
        }
    ]
}

Get default value of Enums

GET https://your.host.lab/projects/bootstrap-static

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637641462,
    "data": {
        "label_types": [
            "MEDICAL_2D",
            "MEDICAL_3D"
        ],
        "project_roles": [
            "UNSET",
            "MEMBER",
            "OWNER"
        ],
        "task_assign_strategy": [
            "ALL",
            "EQUALLY"
        ],
        "tasks_assign_source_type": [
            "FILE",
            "SEARCH",
            "SELECTED"
        ]
    }
}

Get Project detail

GET https://your.host.lab/projects/:project_id/info

Old:

/projects/d4702175-0403-48e5-bbba-e98716722d4d

Path Parameters

Name

Type

Description

project_id*

String

ID of Project

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637642133,
    "data": {
        "id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
        "name":"test",
        "description":"test",
        "created_by":"test",
        "label_group_id": "00000000-0000-0000-0000-000000000000",
        "document_link":"test",
        "key": "TP1",
        "is_public": false,
        "labeling_type": "MEDICAL_2D",
        "current_owner": true
    }
}

Edit a Project

PUT https://your.host.lab/projects/:project_id/info

/projects/d4702175-0403-48e5-bbba-e98716722d4d

Path Parameters

Name

Type

Description

project_id*

String

Request Body

Name

Type

Description

name

String

description

String

document_link

String

labeling_type

is_public

Boolean

label_group_id

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637640802,
    "data": "91eaceca-3586-4f5f-b49d-0f41e876571d"
}

Update Project

PUT https://your.host.lab/projects/:project_id/archive

projects/d4702175-0403-48e5-bbba-e98716722d4d

Path Parameters

Name

Type

Description

project_id*

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637640802,
    "data": "91eaceca-3586-4f5f-b49d-0f41e876571d"
}

Delete Project

DELETE https://your.host.lab/projects/:project_id

projects/d4702175-0403-48e5-bbba-e98716722d4d

Path Parameters

Name

Type

Description

project_id*

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637640802,
    "data": "91eaceca-3586-4f5f-b49d-0f41e876571d"
}

Get Project

GET https://your.host.lab/projects/:project_id/contribs

projects/d4702175-0403-48e5-bbba-e98716722d4d

Path Parameters

Name

Type

Description

project_id*

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637644418,
    "data": [
        {
            "role": "OWNER",
            "users": [
                "test1",
                "test2"
            ]
        },
        {
            "role": "UNSET",
            "users": [
                "test3"
            ]
        }
    ]
}

Get Project

PUT https://your.host.lab/projects/:project_id/contribs

/projects/d4702175-0403-48e5-bbba-e98716722d4d/people

Request Body

Name

Type

Description

contribs*

JSON Array

contribs.username*

String

contribs.action*

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637640802,
    "data": "91eaceca-3586-4f5f-b49d-0f41e876571d"
}

Edit role of Project

PUT https://your.host.lab/projects/:project_id/contribs-role

projects/d4702175-0403-48e5-bbba-e98716722d4d

Request Body

Name

Type

Description

contribs*

JSON Array

contribs.username*

String

contribs.role*

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637640802,
    "data": "91eaceca-3586-4f5f-b49d-0f41e876571d"
}

Auto create label group, labels for project from default data

PUT https://your.host.lab/projects/:project_id/sample-labels

Path Parameters

Name

Type

Description

project_id*

String

Project ID

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1671425137,
    "data": "3a49922b-af60-40aa-8447-b0c9c78b90e4" 
}

Get Labels of a Project

GET https://your.host.lab/projects/:project_id/labels

/labels?label_group_id=d93b41ab-9522-4b25-a6ca-2d617e195e89

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637655036,
    "data": [
        {
            "id": "36e8d3d4-e936-4644-87e4-feb715302410",
            "name":"test",
            "label_group_id": "e3028ad4-556e-4d32-b232-1034d02022b8",
            "short_name": "",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "parent_id": "00000000-0000-0000-0000-000000000000",
            "description":"test",
            "color": "#ffffff",
            "family_select_type": "",
            "order": 2
        },
        {
            "id": "d6a853d0-338c-4266-a4d1-5388ad0ca3af",
            "name":"test",
            "label_group_id": "e3028ad4-556e-4d32-b232-1034d02022b8",
            "short_name": "",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "parent_id": "36e8d3d4-e936-4644-87e4-feb715302410",
            "description":"test",
            "color": "#ffffff",
            "family_select_type": "",
            "order": 2.1
        },
        {
            "id": "d1e7999b-9b92-47cb-ba95-9fba832b16f8",
            "name":"test",
            "label_group_id": "e3028ad4-556e-4d32-b232-1034d02022b8",
            "short_name": "",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "parent_id": "36e8d3d4-e936-4644-87e4-feb715302410",
            "description":"test",
            "color": "#ffffff",
            "family_select_type": "",
            "order": 2.2
        }
    ]
}

Get stats about current Project

GET https://your.host.lab/projects/:project_id/agg-labels

/stats/agg_labels?project_id=c7dc2b7c-7195-4d82-94df-da3b8ecf876a&task_status=COMPLETED&study_status=COMPLETED

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637838464,
    "data": [
        {
            "id": "36e8d3d4-e936-4644-87e4-feb715302410",
            "name":"test",
            "total": 1
        }
    ]
}

Get stats about current Project

GET https://your.host.lab/projects/:project_id/agg-labelers

tasks?_offset=0&_limit=0&_agg=status&_agg=assignee_id&project_id=d4702175-0403-48e5-bbba-e98716722d4d&_role=PROJECT_OWNER

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1638336228,
    "data": [
        {
            "first_name": "T",
            "last_name": "111111",
            "total": 9,
            "username":"test"
        },
        {
            "first_name": "T",
            "last_name": "2",
            "total": 2,
            "username":"test"
        },
        {
            "first_name": "T",
            "last_name": "3",
            "total": 1,
            "username":"test"
        }
    ]
}

Send an invitation to other accounts/emails

POST https://your.host.lab/projects/:project_id/contribs/invitation

{
    "error_code": 0,
    "error_message": "1 invitation(s) has been sent",
    "server_time": 1672893697
}

Resend the invitation to an user/account

POST https://your.host.lab/projects/:project_id/contribs/invitation/resend

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1672893697
}

Retrieves existing accounts to invite to the project (Max 10)

GET https://your.host.lab/projects/:project_id/contribs/invitation/fetch

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1672893991,
    "count": 1,
    "data": [
        {
            "username": "aaaa",
            "first_name": "A",
            "last_name": "B",
            "email": "[email protected]"
        }
    ]
}

Previousdata NextStudy

Last updated 3 years ago

hashtagCreate new Project

hashtagRequest Body

hashtagGet all Projects

hashtagQuery Parameters

hashtagGet Projects as Manager

hashtagQuery Parameters

hashtagGet Projects as Labeler

hashtagQuery Parameters

hashtagGet all public Projects for guest

hashtagQuery Parameters

hashtagGet all projects created by you

hashtagQuery Parameters

hashtagGet default value of Enums

hashtagGet Project detail

hashtagPath Parameters

hashtagEdit a Project

hashtagPath Parameters

hashtagRequest Body

hashtagUpdate Project

hashtagPath Parameters

hashtagDelete Project

hashtagPath Parameters

hashtagGet Project

hashtagPath Parameters

hashtagGet Project

hashtagRequest Body

hashtagEdit role of Project

hashtagRequest Body

hashtagAuto create label group, labels for project from default data

hashtagPath Parameters

hashtagGet Labels of a Project

hashtagGet stats about current Project

hashtagGet stats about current Project

hashtagSend an invitation to other accounts/emails

hashtagResend the invitation to an user/account

hashtagRetrieves existing accounts to invite to the project (Max 10)

Create new Project

Request Body

Get all Projects

Query Parameters

Get Projects as Manager

Query Parameters

Get Projects as Labeler

Query Parameters

Get all public Projects for guest

Query Parameters

Get all projects created by you

Query Parameters

Get default value of Enums

Get Project detail

Path Parameters

Edit a Project

Path Parameters

Request Body

Update Project

Path Parameters

Delete Project

Path Parameters

Get Project

Path Parameters

Get Project

Request Body

Edit role of Project

Request Body

Auto create label group, labels for project from default data

Path Parameters

Get Labels of a Project

Get stats about current Project

Get stats about current Project

Send an invitation to other accounts/emails

Resend the invitation to an user/account

Retrieves existing accounts to invite to the project (Max 10)