Dataset

Create dataset for project

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

Path Parameters

Name	Type	Description
project_id*	String	ID of Project

Request Body

Name	Type	Description
storage_id*	String
connection_type	Integer	1 means LOCAL, 2 means CLOUD, default is 1

200: OK

{
    "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",
        "labeling_type": "MEDICAL_2D",
        "current_owner": true
    }
}

// Some code
{
    "storage_id":"446300fc-632c-4f61-8e24-6f91fcc81bb7"
}

Get list datasets of Project

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

Path Parameters

Name	Type	Description
project_id*	String

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1657078231,
    "count": 3,
    "data": [
        //if dataset is not synced, last_sync is unavailable
        {
            "id": "c9d7f1d9-9a8a-4764-b7f5-03710e4860a5",
            "storage_id": "b5e056c2-b498-4268-ac89-1b2aaf87f23e",
            "project_id": "55bf091d-0f7a-4d61-9431-ba9c676697d4",
            "creator_username":"test",
            "created": 1656666149 
        },
        {
            "id": "34e933da-efed-4b8a-bd48-68743fbd7700",
            "storage_id": "0bf26d54-5327-4f88-aa47-855739bcedaf",
            "project_id": "55bf091d-0f7a-4d61-9431-ba9c676697d4",
            "creator_username":"test",
            "created": 1657008075,
            "last_sync": 1657591384
        },
        {
            "id": "43c7491c-3bb8-4c79-bf89-b7a9f4954c16",
            "storage_id": "446300fc-632c-4f61-8e24-6f91fcc81bb7",
            "project_id": "55bf091d-0f7a-4d61-9431-ba9c676697d4",
            "creator_username":"test",
            "created": 1657023293,
            "last_sync": 1657591384
        }
    ]
}

Get dataset info

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

Path Parameters

Name	Type	Description
project_id*	String
dataset_id*	String

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1657511508,
    "data": {
        "id": "3d3fd092-1c90-46d1-8618-cc01da388ce5",
        "storage_id": "446300fc-632c-4f61-8e24-6f91fcc81bb7",
        "project_id": "55bf091d-0f7a-4d61-9431-ba9c676697d4",
        "creator_username":"test",
        "created": 1657166959
    }
}

Revoke a dataset of project

DELETE https://your.host.lab/projects/:project_id/datasets/:dataset_id/revoke

Path Parameters

Name	Type	Description
project_id*	String
dataset_id*	String

200: OK Return project_id as confirmation

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

Sync a dataset of project

PUT https://your.host.lab/projects/:project_id/datasets/:dataset_id/sync

Path Parameters

Name	Type	Description
project_id*	String
dataset_id*	String

Request Body

Name	Type	Description
file	String	link to your preset file, form data, required if sync type is full cloud hosted

200: OK Return project_id as confirmation

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

Toggle linking status of dataset

PUT https://your.host.lab/projects/:project_id/datasets/:dataset_id/toggle-link

Path Parameters

Name	Type	Description
project_id*	String
dataset_id*	String

Request Body

Name	Type	Description
is_linked*	Boolean

200: OK Return project_id as confirmation

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

List sync orders of dataset

GET https://your.host.lab/projects/:project_id/datasets/:dataset_id/sync-orders

Path Parameters

Name	Type	Description
project_id*	String
dataset_id*	String

200: OK

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1657681993,
    "count": 3,
    "data": [
        {
            "id": "a31e3d43-0b94-4d3c-907d-12b4a0231979",
            "dataset_id": "00000000-0000-0000-0000-000000000000",
            "project_id": "00000000-0000-0000-0000-000000000000",
            "storage_id": "446300fc-632c-4f61-8e24-6f91fcc81bb7",
            "creator_username":"test",
            "created": 1657591377,
            "status": 1,
            "job_status": {
                "-1": 10
            }
        },
        {
            "id": "af7e94ed-fefa-43cd-ae73-d3b72ac9850b",
            "dataset_id": "00000000-0000-0000-0000-000000000000",
            "project_id": "00000000-0000-0000-0000-000000000000",
            "storage_id": "446300fc-632c-4f61-8e24-6f91fcc81bb7",
            "creator_username":"test",
            "created": 1657590284,
            "status": 1,
            "job_status": {
                "-1": 8,
                "2": 2
            }
        },
        {
            "id": "d4beb2c4-31c6-4f45-96d0-bb74fb513237",
            "dataset_id": "00000000-0000-0000-0000-000000000000",
            "project_id": "00000000-0000-0000-0000-000000000000",
            "storage_id": "446300fc-632c-4f61-8e24-6f91fcc81bb7",
            "creator_username":"test",
            "created": 1657591384,
            "status": 1,
            "job_status": {
                "-1": 8,
                "2": 2
            }
        }
    ],
    "meta": {
        "dictionary": {
            "-1": "FAILED",
            "0": "NEW",
            "1": "PROCESSING",
            "2": "DONE"
        }
    }
}

List sync history of dataset

GET https://your.host.lab/projects/:project_id/datasets/:ds_id/sync-orders/:ds_order_id/history

return a CSV file

Path Parameters

Name	Type	Description
project_id*	String
dataset_id*	String

200: OK

creator,file_path,error_msg,modified,status
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11250153.3103695687/DICOM/1.2.276.0.7230010.3.0.3.5.1.11250155.987537833.dcm,,20 Jul 22 17:10 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11278809.2448538337/DICOM/1.2.276.0.7230010.3.0.3.5.1.11278809.2698530050.dcm,,20 Jul 22 17:10 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11057701.1458450208/DICOM/1.2.276.0.7230010.3.0.3.5.1.11057702.1097846324.dcm,,20 Jul 22 17:10 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11057701.1458450208/DICOM/1.2.276.0.7230010.3.0.3.5.1.11057702.1097846324.dcm,,20 Jul 22 17:07 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11278809.2448538337/DICOM/1.2.276.0.7230010.3.0.3.5.1.11278809.2698530050.dcm,,20 Jul 22 17:07 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11250153.3103695687/DICOM/1.2.276.0.7230010.3.0.3.5.1.11250155.987537833.dcm,,20 Jul 22 17:07 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11278809.2448538337/DICOM/1.2.276.0.7230010.3.0.3.5.1.11278809.2698530050.dcm,,20 Jul 22 16:38 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11057701.1458450208/DICOM/1.2.276.0.7230010.3.0.3.5.1.11057702.1097846324.dcm,,20 Jul 22 16:38 +0700,2
test1,sample-data/1.2.276.0.7230010.3.0.3.5.1.11250153.3103695687/DICOM/1.2.276.0.7230010.3.0.3.5.1.11250155.987537833.dcm,,20 Jul 22 16:38 +0700,2
test1,sample-data/,,20 Jul 22 16:38 +0700,-1
test1,,,20 Jul 22 15:02 +0700,-1

Cancel sync order

PATCH https://your.host.lab/projects/:project_id/datasets/:ds_id/sync-orders/:ds_order_id/cancel

API that allow user to cancel sync order

200: OK

{
  error_code: 0,
  error_message: "OK",
  server_time: 1669281276,
  data: {
  },
}