Task

Documents của APIs dành cho phần Tasks

Get Tasks of A Study

GET https://your.host.lab/projects/:project_id/studies/:study_id/tasks

This endpoint allows you to manage tasks.

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637652710,
    "data": [
        {
            "id": "56dba03f-23bd-4259-a99d-fda63fec4e5b",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
            "code": "TSK-67",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "NEW",
            "created": 1637209603,
            "modified": 1637223548,
            "comment": "",
            "is_archived": false,
            "study_code": "TP1-4"
        }
    ]
}

Update Task

PUT https://your.host.vinlab/projects/:project_id/tasks/change-status

Request Body

Name

Type

Description

ids*

[]string

to_status*

string

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637653148,
    "data":{
        "30469a2e-2b79-426e-96ef-887170848c66": true,
        "dc319f71-f60d-43ef-8269-b35d05ef5c40": false
    }
}

// Demo body
{
    "ids":[
        "30469a2e-2b79-426e-96ef-887170848c66",
        "dc319f71-f60d-43ef-8269-b35d05ef5c40"
    ],
    "to_status":"SUBMITTED"
}

Renew Task

PUT https://your.host.vinlab/projects/:project_id/studies/:study_id/tasks/renew-status

Request Body

Name

Type

Description

ids*

[]string

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637653148,
    "data":{
        "30469a2e-2b79-426e-96ef-887170848c66": true,
        "dc319f71-f60d-43ef-8269-b35d05ef5c40": false
    }
}

Renew Task

PUT https://your.host.vinlab/projects/:project_id/tasks/renew-status

Request Body

Name

Type

Description

ids*

[]string

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637653148,
    "data":{
        "30469a2e-2b79-426e-96ef-887170848c66": true,
        "dc319f71-f60d-43ef-8269-b35d05ef5c40": false
    }
}

Get Task

GET https://your.host.lab/projects/:project_id/studies/:study_id/tasks/:task_id/info

Path Parameters

Name

Type

Description

study_id

string

Study ID

task_id

string

Task ID

project_id

string

Project ID

Headers

Name

Type

Description

Authentication

string

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637653455,
    "data": {
        "id": "56dba03f-23bd-4259-a99d-fda63fec4e5b",
        "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
        "study_id": "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
        "code": "TSK-67",
        "creator_username":"test",
        "assignee_username":"test",
        "status": "NEW",
        "created": 1637209603,
        "modified": 1637223548,
        "comment": "",
        "is_archived": false,
        "study_code": "TP1-4"
    }
}

Mark a Task is DOING

PUT https://your.host.lab/projects/:project_id/studies/:study_id/tasks/:task_id/mark-seen

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

Mark a Task is SUBMITTED

PUT https://your.host.lab/projects/:project_id/studies/:study_id/tasks/:task_id/submit

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

Toggle Task archived or not

PUT https://your.host.lab/projects/:project_id/studies/:study_id/tasks/:task_id/archive

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

Get Tasks of a Project

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

/tasks?_offset=0&_limit=25&project_id=d4702175-0403-48e5-bbba-e98716722d4d&_role=PROJECT_OWNER

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

_sort

String

status

String

assignee

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637830388,
    "count": 6,
    "data": [
        {
            "id": "dc319f71-f60d-43ef-8269-b35d05ef5c40",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
            "code": "TSK-70",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637220779,
            "modified": 1637220895,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
                "modified": 1637220897,
                "created": 1637207625,
                "creator_username":"test",
                "code": "TP1-6",
                "status": "REVIEWING",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019647"
            },
            "study_code": "TP1-6"
        },
        {
            "id": "30469a2e-2b79-426e-96ef-887170848c66",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
            "code": "TSK-69",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637210271,
            "modified": 1637220895,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
                "modified": 1637220897,
                "created": 1637207625,
                "creator_username":"test",
                "code": "TP1-6",
                "status": "REVIEWING",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019647"
            },
            "study_code": "TP1-6"
        },
        {
            "id": "9b8dff2b-c424-4042-8161-cca950296e9f",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "58da95a9-5a3c-48a2-9204-12211bf73a17",
            "code": "TSK-68",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "NEW",
            "created": 1637210271,
            "modified": 1637210271,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "58da95a9-5a3c-48a2-9204-12211bf73a17",
                "modified": 1637207634,
                "created": 1637207634,
                "creator_username":"test",
                "code": "TP1-7",
                "status": "ASSIGNED",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019635"
            },
            "study_code": "TP1-7"
        },
        {
            "id": "56dba03f-23bd-4259-a99d-fda63fec4e5b",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
            "code": "TSK-67",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "DOING",
            "created": 1637209603,
            "modified": 1637223548,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
                "modified": 1637223566,
                "created": 1637207587,
                "creator_username":"test",
                "code": "TP1-4",
                "status": "ASSIGNED",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019646"
            },
            "study_code": "TP1-4"
        },
        {
            "id": "d62827c1-3846-455c-bab8-54d830b0175f",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "41f7997f-f039-4531-a171-fd1298f50d6c",
            "code": "TSK-66",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637209602,
            "modified": 1637220632,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "41f7997f-f039-4531-a171-fd1298f50d6c",
                "modified": 1637220706,
                "created": 1637207610,
                "creator_username":"test",
                "code": "TP1-5",
                "status": "TO_REVIEW",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019616"
            },
            "study_code": "TP1-5"
        },
        {
            "id": "526ffb26-a89b-4089-b549-4471a95f40d4",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "41f7997f-f039-4531-a171-fd1298f50d6c",
            "code": "TSK-64",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637209601,
            "modified": 1637220634,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "41f7997f-f039-4531-a171-fd1298f50d6c",
                "modified": 1637220706,
                "created": 1637207610,
                "creator_username":"test",
                "code": "TP1-5",
                "status": "TO_REVIEW",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019616"
            },
            "study_code": "TP1-5"
        }
    ]
}

//old data returned
{
  "error_code": 0,
  "server_time": 1637828243,
  "count": 5000,
  "data": [
    {
      "id": "2d5a9b53-8297-43dd-a235-fac841fd85f2",
      "code": "TSK-2220",
      "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
      "creator_id": "",
      "assignee_id": "4d329479-aa44-48d5-93f4-93acf41fa0ef",
      "study_id": "4551cc77-b0be-4971-9f6d-516a73c396dd",
      "status": "COMPLETED",
      "created": 1622027763513,
      "modified": 1622027763513,
      "type": "ANNOTATE",
      "study_code": "V-453",
      "study": {
        "id": "4551cc77-b0be-4971-9f6d-516a73c396dd",
        "modified": 0,
        "time_inserted": 1622017378058,
        "code": "V-453",
        "status": "COMPLETED",
        "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
        "creator_id": "92f566d6-0cc3-45d6-b48d-4fbcc5c627e9",
        "dicom_tags": {
          "PatientSex": [
            "F"
          ],
          "SOPInstanceUID": [
            "c057f15d98b4a110b9e5ef883b0282aa"
          ],
          "SeriesInstanceUID": [
            "412477e78d2dd1c50ef4445ef0758d63"
          ],
          "StudyInstanceUID": [
            "d3f3972413384db0243e5629b82e785e"
          ]
        }
      },
      "comment": "",
      "archived": false
    },
    {
      "id": "0be3d4f6-3e93-4f6b-aac8-15e74a955405",
      "code": "TSK-2222",
      "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
      "creator_id": "",
      "assignee_id": "09b63a48-1b46-40f0-bed4-8087c1714ee7",
      "study_id": "e7e035e8-df7a-4344-a21a-b5b9b36994c6",
      "status": "COMPLETED",
      "created": 1622027764144,
      "modified": 1622027764144,
      "type": "ANNOTATE",
      "study_code": "V-123",
      "study": {
        "id": "e7e035e8-df7a-4344-a21a-b5b9b36994c6",
        "modified": 0,
        "time_inserted": 1622017284683,
        "code": "V-123",
        "status": "COMPLETED",
        "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
        "creator_id": "92f566d6-0cc3-45d6-b48d-4fbcc5c627e9",
        "dicom_tags": {
          "PatientSex": [
            "M"
          ],
          "SOPInstanceUID": [
            "02c519e53ed8125cd0535c24ccd549ea",
            "28142e93af2b6afb982d0bfd4fe3d408",
            "c4055a6e0135fe965da92c42bfe53d99",
            "3d8e35886abc5251aa16cb0a1927ab20"
          ],
          "SeriesInstanceUID": [
            "a1d06adcca4e71d47d756ec3acea4dd7"
          ],
          "StudyInstanceUID": [
            "7c0f1e4eb029ee6f8a29dfbcdaa403fc"
          ]
        }
      },
      "comment": "",
      "archived": false
    }
  ]
}

Delete Tasks by their IDs

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

Request Body

Name

Type

Description

ids*

[]String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637650810,
    "data": {
        "sent": 10, //total ids are sent
        "deleted": 3 //number of tasks are deleted
    }
}

Get Tasks of a Project belong to current user

GET https://your.host.lab/projects/:project_id/my-tasks

/tasks?_offset=0&_limit=25&project_id=d4702175-0403-48e5-bbba-e98716722d4d&_role=ANNOTATOR&type=ANNOTATE

Query Parameters

Name

Type

Description

_offset

Integer

Default 0

_limit

Integer

Default 10

_sort

String

status

String

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637830388,
    "count": 6,
    "data": [
        {
            "id": "dc319f71-f60d-43ef-8269-b35d05ef5c40",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
            "code": "TSK-70",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637220779,
            "modified": 1637220895,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
                "modified": 1637220897,
                "created": 1637207625,
                "creator_username":"test",
                "code": "TP1-6",
                "status": "REVIEWING",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019647"
            },
            "study_code": "TP1-6"
        },
        {
            "id": "30469a2e-2b79-426e-96ef-887170848c66",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
            "code": "TSK-69",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637210271,
            "modified": 1637220895,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
                "modified": 1637220897,
                "created": 1637207625,
                "creator_username":"test",
                "code": "TP1-6",
                "status": "REVIEWING",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019647"
            },
            "study_code": "TP1-6"
        },
        {
            "id": "9b8dff2b-c424-4042-8161-cca950296e9f",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "58da95a9-5a3c-48a2-9204-12211bf73a17",
            "code": "TSK-68",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "NEW",
            "created": 1637210271,
            "modified": 1637210271,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "58da95a9-5a3c-48a2-9204-12211bf73a17",
                "modified": 1637207634,
                "created": 1637207634,
                "creator_username":"test",
                "code": "TP1-7",
                "status": "ASSIGNED",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019635"
            },
            "study_code": "TP1-7"
        },
        {
            "id": "56dba03f-23bd-4259-a99d-fda63fec4e5b",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
            "code": "TSK-67",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "DOING",
            "created": 1637209603,
            "modified": 1637223548,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
                "modified": 1637223566,
                "created": 1637207587,
                "creator_username":"test",
                "code": "TP1-4",
                "status": "ASSIGNED",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019646"
            },
            "study_code": "TP1-4"
        },
        {
            "id": "d62827c1-3846-455c-bab8-54d830b0175f",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "41f7997f-f039-4531-a171-fd1298f50d6c",
            "code": "TSK-66",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637209602,
            "modified": 1637220632,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "41f7997f-f039-4531-a171-fd1298f50d6c",
                "modified": 1637220706,
                "created": 1637207610,
                "creator_username":"test",
                "code": "TP1-5",
                "status": "TO_REVIEW",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019616"
            },
            "study_code": "TP1-5"
        },
        {
            "id": "526ffb26-a89b-4089-b549-4471a95f40d4",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "41f7997f-f039-4531-a171-fd1298f50d6c",
            "code": "TSK-64",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637209601,
            "modified": 1637220634,
            "comment": "",
            "is_archived": false,
            "study": {
                "id": "41f7997f-f039-4531-a171-fd1298f50d6c",
                "modified": 1637220706,
                "created": 1637207610,
                "creator_username":"test",
                "code": "TP1-5",
                "status": "TO_REVIEW",
                "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
                "study_index": "8276396141594019616"
            },
            "study_code": "TP1-5"
        }
    ]
}

//old data returned
{
  "error_code": 0,
  "server_time": 1637828243,
  "count": 5000,
  "data": [
    {
      "id": "2d5a9b53-8297-43dd-a235-fac841fd85f2",
      "code": "TSK-2220",
      "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
      "creator_id": "",
      "assignee_id": "4d329479-aa44-48d5-93f4-93acf41fa0ef",
      "study_id": "4551cc77-b0be-4971-9f6d-516a73c396dd",
      "status": "COMPLETED",
      "created": 1622027763513,
      "modified": 1622027763513,
      "type": "ANNOTATE",
      "study_code": "V-453",
      "study": {
        "id": "4551cc77-b0be-4971-9f6d-516a73c396dd",
        "modified": 0,
        "time_inserted": 1622017378058,
        "code": "V-453",
        "status": "COMPLETED",
        "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
        "creator_id": "92f566d6-0cc3-45d6-b48d-4fbcc5c627e9",
        "dicom_tags": {
          "PatientSex": [
            "F"
          ],
          "SOPInstanceUID": [
            "c057f15d98b4a110b9e5ef883b0282aa"
          ],
          "SeriesInstanceUID": [
            "412477e78d2dd1c50ef4445ef0758d63"
          ],
          "StudyInstanceUID": [
            "d3f3972413384db0243e5629b82e785e"
          ]
        }
      },
      "comment": "",
      "archived": false
    },
    {
      "id": "0be3d4f6-3e93-4f6b-aac8-15e74a955405",
      "code": "TSK-2222",
      "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
      "creator_id": "",
      "assignee_id": "09b63a48-1b46-40f0-bed4-8087c1714ee7",
      "study_id": "e7e035e8-df7a-4344-a21a-b5b9b36994c6",
      "status": "COMPLETED",
      "created": 1622027764144,
      "modified": 1622027764144,
      "type": "ANNOTATE",
      "study_code": "V-123",
      "study": {
        "id": "e7e035e8-df7a-4344-a21a-b5b9b36994c6",
        "modified": 0,
        "time_inserted": 1622017284683,
        "code": "V-123",
        "status": "COMPLETED",
        "project_id": "d4702175-0403-48e5-bbba-e98716722d4d",
        "creator_id": "92f566d6-0cc3-45d6-b48d-4fbcc5c627e9",
        "dicom_tags": {
          "PatientSex": [
            "M"
          ],
          "SOPInstanceUID": [
            "02c519e53ed8125cd0535c24ccd549ea",
            "28142e93af2b6afb982d0bfd4fe3d408",
            "c4055a6e0135fe965da92c42bfe53d99",
            "3d8e35886abc5251aa16cb0a1927ab20"
          ],
          "SeriesInstanceUID": [
            "a1d06adcca4e71d47d756ec3acea4dd7"
          ],
          "StudyInstanceUID": [
            "7c0f1e4eb029ee6f8a29dfbcdaa403fc"
          ]
        }
      },
      "comment": "",
      "archived": false
    }
  ]
}

Assign Tasks from assignees

POST https://your.host.lab/projects/:project_id/tasks/assign

Query Parameters

Name

Type

Description

assignees*

[]string

strategy*

string

source_type*

string

study_indices

[]string

study_ids

[]string

{
    "error_code": 0,
    "error_message": "OK",
    "server_time": 1637650810,
    "count": 1,
    "data": [
        {
            "id": "dc319f71-f60d-43ef-8269-b35d05ef5c40",
            "project_id": "122d7cfb-40fd-48d9-9de7-ba9309ef2e0c",
            "study_id": "886922b1-9a89-4f48-b874-8b017e8d3dbe",
            "code": "TSK-70",
            "creator_username":"test",
            "assignee_username":"test",
            "status": "SUBMITTED",
            "created": 1637220779,
            "modified": 1637220895,
            "comment": "",
            "is_archived": false,
            "study_code": "TP1-6"
        }
    ]
}

// Some code
{
  "assignees": [
    "test1"
  ],
  "strategy": "EQUALLY",
  "source_type": "SELECTED",
  "study_ids": [
    "886922b1-9a89-4f48-b874-8b017e8d3dbe"
  ]
}

// Some code
{
  "assignees": [
    "test2",
    "test3"
  ],
  "strategy": "ALL",
  "source_type": "SELECTED",
  "study_ids": [
    "beb76a95-f63b-4605-9bcb-32da6a9c3c98",
    "41f7997f-f039-4531-a171-fd1298f50d6c"
  ]
}

PreviousStudy NextPassport

Last updated 3 years ago

hashtagGet Tasks of A Study

hashtagUpdate Task

hashtagRequest Body

hashtagRenew Task

hashtagRequest Body

hashtagRenew Task

hashtagRequest Body

hashtagGet Task

hashtagPath Parameters

hashtagHeaders

hashtagMark a Task is DOING

hashtagMark a Task is SUBMITTED

hashtagToggle Task archived or not

hashtagGet Tasks of a Project

hashtagQuery Parameters

hashtagDelete Tasks by their IDs

hashtagRequest Body

hashtagGet Tasks of a Project belong to current user

hashtagQuery Parameters

hashtagAssign Tasks from assignees

hashtagQuery Parameters

Get Tasks of A Study

Update Task

Request Body

Renew Task

Request Body

Renew Task

Request Body

Get Task

Path Parameters

Headers

Mark a Task is DOING

Mark a Task is SUBMITTED

Toggle Task archived or not

Get Tasks of a Project

Query Parameters

Delete Tasks by their IDs

Request Body

Get Tasks of a Project belong to current user

Query Parameters

Assign Tasks from assignees

Query Parameters