Label

Get Labels of a Group

GET https://your.host.lab/label-groups/:label_group_id/labels

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

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637655036,
    "data": [
        {
            "id": "36e8d3d4-e936-4644-87e4-feb715302410",
            "name": "Test L 2",
            "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 L",
            "color": "#ffffff",
            "family_select_type": "",
            "order": 2
        },
        {
            "id": "d6a853d0-338c-4266-a4d1-5388ad0ca3af",
            "name": "Test L 2.1",
            "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 L",
            "color": "#ffffff",
            "family_select_type": "",
            "order": 2.1
        },
        {
            "id": "d1e7999b-9b92-47cb-ba95-9fba832b16f8",
            "name": "Test L 2.2",
            "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 L",
            "color": "#ffffff",
            "family_select_type": "",
            "order": 2.2
        }
    ]
}

Create Label

POST https://your.host.lab/label-groups/:label_group_id/labels

Request Body

Name	Type	Description
name*	string
short_name	string
type*	string
scope*	string
annotation_type*	string
description	string
color*	string
family_select_type	string
order	float32
parent_id	string

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637655036,
    "data": "36e8d3d4-e936-4644-87e4-feb715302410"
}

// Some code
{
    "name": "Test L 2.3",
    "short_name": "",
    "type": "IMPRESSION",
    "scope": "IMAGE",
    "annotation_type": "TAG",
    "description": "Test L",
    "color": "#ffffff",
    "family_select_type": "",
    "order":2,
    "parent_id":"36e8d3d4-e936-4644-87e4-feb715302410"
}    

Get Label

GET https://your.host.lab/label-groups/:label_group_id/labels/:label_id/info

200

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

Edit Label

PUT https://your.host.lab/label-groups/:label_group_id/labels/:label_id/info

/labels/6a9c306c-b283-48f1-8719-a443e1cf596a

Request Body

Name	Type	Description
name*	string
short_name	string
description	string
color*	string

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637655036,
    "data": "36e8d3d4-e936-4644-87e4-feb715302410"
}

Delete Label

DELETE https://your.host.lab/label-groups/:label_group_id/labels/:label_id

/labels/6a9c306c-b283-48f1-8719-a443e1cf596a

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637655036,
    "data": "36e8d3d4-e936-4644-87e4-feb715302410"
}

Import labels from CSV file

POST https://your.host.lab/label-groups/:label_group_id/labels/import

Request Body

Name	Type	Description
file*	file	Multipart Form data

200

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637655036,
    "data": "36e8d3d4-e936-4644-87e4-feb715302410"
}

Name,Type,Scope,AnnotationType,ShortName,Description,Color,ChildrenSelectType,ParentName,Order
Series 2,IMPRESSION,TAG,SERIES,,,#ffeb3b,CHECKBOX,,0.0
Reading,IMPRESSION,TAG,STUDY,,,#ffeb3b,CHECKBOX,,0.0
Car,IMPRESSION,TAG,IMAGE,,,#ffeb3b,CHECKBOX,,0.0
Study 1,IMPRESSION,STUDY,TAG,Study Impres,,#4caf50,CHECKBOX,,1.0
Box2,IMPRESSION,SERIES,TAG,B,,#4caf50,CHECKBOX,,3.0

Export labels to CSV file

GET https://your.host.lab/label-groups/:label_group_id/labels/export

Request Body

Name	Type	Description
file*	file	Multipart Form data

200

Name,Type,Scope,AnnotationType,ShortName,Description,Color,ChildrenSelectType,ParentName,Order
Series 2,IMPRESSION,TAG,SERIES,,,#ffeb3b,CHECKBOX,,0.0
Reading,IMPRESSION,TAG,STUDY,,,#ffeb3b,CHECKBOX,,0.0
Car,IMPRESSION,TAG,IMAGE,,,#ffeb3b,CHECKBOX,,0.0
Study 1,IMPRESSION,STUDY,TAG,Study Impres,,#4caf50,CHECKBOX,,1.0
Box2,IMPRESSION,SERIES,TAG,B,,#4caf50,CHECKBOX,,3.0