Annotation

Get Annotations of Task

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

200

{
  "error_code": 0,
  "server_time": 1633590892,
  "data": {
    "FINDING": [
      {
        "id": "436de6e1-ac13-48c8-af6a-ff228625f816",
        "object_id": "941ad44a-b91f-4648-8c19-ee26c1f59944",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from 3rd party converter",
        "data": [
          {
            "_id": "f78f29e1-2da5-4aae-a5f5-af52ffff612f",
            "frame_index": -141.727,
            "group_id": "436de6e1-ac13-48c8-af6a-ff228625f816",
            "image_id": "mpr:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848:1,0,0,0,1,0:-141:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551934.910/b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848",
            "point_2d": [
              {
                "x": 122.97984374999999,
                "y": 177.88714735243056
              },
              {
                "x": 134.1111480034722,
                "y": 194.5841796875
              }
            ],
            "point_3d": [
              {
                "x": -75.2298,
                "y": -54.9231,
                "z": -141.727
              },
              {
                "x": -67.4031,
                "y": -43.183,
                "z": -141.727
              }
            ]
          }
    ],
    "IMPRESSION": [
      {
        "id": "325b24fe-114e-4b37-98e0-939615a15ad4",
        "object_id": "2dcbb50a-64fb-4bc4-827d-799571ddedf4",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from label pacs",
        "type": "TAG",
        "event": "CREATED",
        "created": 1631163149213,
        "label_ids": [
          "99da60b5-c4eb-4400-abe3-c2fbbfb6af37"
        ],
        "labels": [
          {
            "id": "99da60b5-c4eb-4400-abe3-c2fbbfb6af37",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "name": "Other",
            "short_name": "",
            "parent_label_id": "",
            "color": "#E91E63",
            "creator_id": "8fef7df2-7bc6-488a-b03c-db1bc90d95b3",
            "created": 1631163176743,
            "label_group_id": "932f8d9b-7447-4b76-acbd-97ec62c1e4a8",
            "children_select_type": "",
            "order": 0
          }
        ],
        "task_id": "fb170330-6354-4bda-a2c7-53313c1bc8bd",
        "study_id": "cce0c685-6de7-48b1-a274-60a2e56704ec",
        "creator_name": "rad4"
      }
    ]
  }
}

Set Annotations for Task

PUT https://your.host.lab/projects/:project_id/tasks/:task_id/annotations

200

Clone Annotations from one Task to current

PUT https://your.host.lab/projects/:project_id/tasks/:task_id/annotations/clone

Request Body

Name	Type	Description
source_task*	String	You want to clone Annotations from this task

200

Import Annotations from CSV or JSON file

POST https://your.host.lab/projects/:project_id/annotations/import

Query Parameters

Name	Type	Description
option*	String	APPEND, OVERWRITE, SKIP_EXISTS
format*	String	CSV, JSON

Request Body

Name	Type	Description
file*	File

200

{
  "error_code": 0,
  "server_time": 1633590892,
  "data": {
    "FINDING": [
      {
        "id": "436de6e1-ac13-48c8-af6a-ff228625f816",
        "object_id": "941ad44a-b91f-4648-8c19-ee26c1f59944",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from 3rd party converter",
        "data": [
          {
            "_id": "f78f29e1-2da5-4aae-a5f5-af52ffff612f",
            "frame_index": -141.727,
            "group_id": "436de6e1-ac13-48c8-af6a-ff228625f816",
            "image_id": "mpr:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848:1,0,0,0,1,0:-141:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551934.910/b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848",
            "point_2d": [
              {
                "x": 122.97984374999999,
                "y": 177.88714735243056
              },
              {
                "x": 134.1111480034722,
                "y": 194.5841796875
              }
            ],
            "point_3d": [
              {
                "x": -75.2298,
                "y": -54.9231,
                "z": -141.727
              },
              {
                "x": -67.4031,
                "y": -43.183,
                "z": -141.727
              }
            ]
          }
    ],
    "IMPRESSION": [
      {
        "id": "325b24fe-114e-4b37-98e0-939615a15ad4",
        "object_id": "2dcbb50a-64fb-4bc4-827d-799571ddedf4",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from label pacs",
        "type": "TAG",
        "event": "CREATED",
        "created": 1631163149213,
        "label_ids": [
          "99da60b5-c4eb-4400-abe3-c2fbbfb6af37"
        ],
        "labels": [
          {
            "id": "99da60b5-c4eb-4400-abe3-c2fbbfb6af37",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "name": "Other",
            "short_name": "",
            "parent_label_id": "",
            "color": "#E91E63",
            "creator_id": "8fef7df2-7bc6-488a-b03c-db1bc90d95b3",
            "created": 1631163176743,
            "label_group_id": "932f8d9b-7447-4b76-acbd-97ec62c1e4a8",
            "children_select_type": "",
            "order": 0
          }
        ],
        "task_id": "fb170330-6354-4bda-a2c7-53313c1bc8bd",
        "study_id": "cce0c685-6de7-48b1-a274-60a2e56704ec",
        "creator_name": "rad4"
      }
    ]
  }
}




{
  "error_code": 0,
  "server_time": 1633590892,
  "data": {
    "FINDING": [
      {
        "id": "436de6e1-ac13-48c8-af6a-ff228625f816",
        "object_id": "941ad44a-b91f-4648-8c19-ee26c1f59944",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from 3rd party converter",
        "data": [
          {
            "_id": "f78f29e1-2da5-4aae-a5f5-af52ffff612f",
            "frame_index": -141.727,
            "group_id": "436de6e1-ac13-48c8-af6a-ff228625f816",
            "image_id": "mpr:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848:1,0,0,0,1,0:-141:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551934.910/b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848",
            "point_2d": [
              {
                "x": 122.97984374999999,
                "y": 177.88714735243056
              },
              {
                "x": 134.1111480034722,
                "y": 194.5841796875
              }
            ],
            "point_3d": [
              {
                "x": -75.2298,
                "y": -54.9231,
                "z": -141.727
              },
              {
                "x": -67.4031,
                "y": -43.183,
                "z": -141.727
              }
            ]
          }
    ],
    "IMPRESSION": [
      {
        "id": "325b24fe-114e-4b37-98e0-939615a15ad4",
        "object_id": "2dcbb50a-64fb-4bc4-827d-799571ddedf4",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from label pacs",
        "type": "TAG",
        "event": "CREATED",
        "created": 1631163149213,
        "label_ids": [
          "99da60b5-c4eb-4400-abe3-c2fbbfb6af37"
        ],
        "labels": [
          {
            "id": "99da60b5-c4eb-4400-abe3-c2fbbfb6af37",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "name": "Other",
            "short_name": "",
            "parent_label_id": "",
            "color": "#E91E63",
            "creator_id": "8fef7df2-7bc6-488a-b03c-db1bc90d95b3",
            "created": 1631163176743,
            "label_group_id": "932f8d9b-7447-4b76-acbd-97ec62c1e4a8",
            "children_select_type": "",
            "order": 0
          }
        ],
        "task_id": "fb170330-6354-4bda-a2c7-53313c1bc8bd",
        "study_id": "cce0c685-6de7-48b1-a274-60a2e56704ec",
        "creator_name": "rad4"
      }
    ]
  }
}

Import Annotations from CSV or JSON file

POST https://your.host.lab/projects/:project_id/annotations/import-by-bigfile

Query Parameters

Name	Type	Description
option*	String	APPEND, OVERWRITE, SKIP_EXISTS
format*	String	CSV, JSON

Headers

Name	Type	Description
Content-Range*	String	https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range

Request Body

Name	Type	Description
file*	File	Chunk by size of 10MB (10240 bytes)

200

{
  "error_code": 0,
  "server_time": 1633590892
}

Export Annotations

GET https://your.host.lab/projects/:project_id/annotations/export/:order_id

200

{
  "error_code": 0,
  "server_time": 1633590892,
  "data": {
    "FINDING": [
      {
        "id": "436de6e1-ac13-48c8-af6a-ff228625f816",
        "object_id": "941ad44a-b91f-4648-8c19-ee26c1f59944",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from 3rd party converter",
        "data": [
          {
            "_id": "f78f29e1-2da5-4aae-a5f5-af52ffff612f",
            "frame_index": -141.727,
            "group_id": "436de6e1-ac13-48c8-af6a-ff228625f816",
            "image_id": "mpr:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848:1,0,0,0,1,0:-141:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551934.910/b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848",
            "point_2d": [
              {
                "x": 122.97984374999999,
                "y": 177.88714735243056
              },
              {
                "x": 134.1111480034722,
                "y": 194.5841796875
              }
            ],
            "point_3d": [
              {
                "x": -75.2298,
                "y": -54.9231,
                "z": -141.727
              },
              {
                "x": -67.4031,
                "y": -43.183,
                "z": -141.727
              }
            ]
          }
    ],
    "IMPRESSION": [
      {
        "id": "325b24fe-114e-4b37-98e0-939615a15ad4",
        "object_id": "2dcbb50a-64fb-4bc4-827d-799571ddedf4",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from label pacs",
        "type": "TAG",
        "event": "CREATED",
        "created": 1631163149213,
        "label_ids": [
          "99da60b5-c4eb-4400-abe3-c2fbbfb6af37"
        ],
        "labels": [
          {
            "id": "99da60b5-c4eb-4400-abe3-c2fbbfb6af37",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "name": "Other",
            "short_name": "",
            "parent_label_id": "",
            "color": "#E91E63",
            "creator_id": "8fef7df2-7bc6-488a-b03c-db1bc90d95b3",
            "created": 1631163176743,
            "label_group_id": "932f8d9b-7447-4b76-acbd-97ec62c1e4a8",
            "children_select_type": "",
            "order": 0
          }
        ],
        "task_id": "fb170330-6354-4bda-a2c7-53313c1bc8bd",
        "study_id": "cce0c685-6de7-48b1-a274-60a2e56704ec",
        "creator_name": "rad4"
      }
    ]
  }
}

Create an Export order

POST https://your.host.lab/projects/:project_id/annotations/order-export

Request Body

Name	Type	Description
tag*	string
format*	string

200

{
  "error_code": 0,
  "server_time": 1633590892,
  "data": {
    "FINDING": [
      {
        "id": "436de6e1-ac13-48c8-af6a-ff228625f816",
        "object_id": "941ad44a-b91f-4648-8c19-ee26c1f59944",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from 3rd party converter",
        "data": [
          {
            "_id": "f78f29e1-2da5-4aae-a5f5-af52ffff612f",
            "frame_index": -141.727,
            "group_id": "436de6e1-ac13-48c8-af6a-ff228625f816",
            "image_id": "mpr:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848:1,0,0,0,1,0:-141:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551934.910/b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848",
            "point_2d": [
              {
                "x": 122.97984374999999,
                "y": 177.88714735243056
              },
              {
                "x": 134.1111480034722,
                "y": 194.5841796875
              }
            ],
            "point_3d": [
              {
                "x": -75.2298,
                "y": -54.9231,
                "z": -141.727
              },
              {
                "x": -67.4031,
                "y": -43.183,
                "z": -141.727
              }
            ]
          }
    ],
    "IMPRESSION": [
      {
        "id": "325b24fe-114e-4b37-98e0-939615a15ad4",
        "object_id": "2dcbb50a-64fb-4bc4-827d-799571ddedf4",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from label pacs",
        "type": "TAG",
        "event": "CREATED",
        "created": 1631163149213,
        "label_ids": [
          "99da60b5-c4eb-4400-abe3-c2fbbfb6af37"
        ],
        "labels": [
          {
            "id": "99da60b5-c4eb-4400-abe3-c2fbbfb6af37",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "name": "Other",
            "short_name": "",
            "parent_label_id": "",
            "color": "#E91E63",
            "creator_id": "8fef7df2-7bc6-488a-b03c-db1bc90d95b3",
            "created": 1631163176743,
            "label_group_id": "932f8d9b-7447-4b76-acbd-97ec62c1e4a8",
            "children_select_type": "",
            "order": 0
          }
        ],
        "task_id": "fb170330-6354-4bda-a2c7-53313c1bc8bd",
        "study_id": "cce0c685-6de7-48b1-a274-60a2e56704ec",
        "creator_name": "rad4"
      }
    ]
  }
}

Get IO history

GET https://your.host.lab/projects/:project_id/annotations/order-io-history

Request Body

Name	Type	Description
_offset	int
_limit	int
type	sting	Default is EXPORT (IMPORT/EXPORT)

200

{
  "error_code": 0,
  "server_time": 1633590892,
  "data": {
    "FINDING": [
      {
        "id": "436de6e1-ac13-48c8-af6a-ff228625f816",
        "object_id": "941ad44a-b91f-4648-8c19-ee26c1f59944",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from 3rd party converter",
        "data": [
          {
            "_id": "f78f29e1-2da5-4aae-a5f5-af52ffff612f",
            "frame_index": -141.727,
            "group_id": "436de6e1-ac13-48c8-af6a-ff228625f816",
            "image_id": "mpr:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848:1,0,0,0,1,0:-141:b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551934.910/b1536439-4cb9-4062-a4cf-2e04f05a1c36.1.2.840.113619.2.25.4.83425943.1576551945.848",
            "point_2d": [
              {
                "x": 122.97984374999999,
                "y": 177.88714735243056
              },
              {
                "x": 134.1111480034722,
                "y": 194.5841796875
              }
            ],
            "point_3d": [
              {
                "x": -75.2298,
                "y": -54.9231,
                "z": -141.727
              },
              {
                "x": -67.4031,
                "y": -43.183,
                "z": -141.727
              }
            ]
          }
    ],
    "IMPRESSION": [
      {
        "id": "325b24fe-114e-4b37-98e0-939615a15ad4",
        "object_id": "2dcbb50a-64fb-4bc4-827d-799571ddedf4",
        "project_id": "b1536439-4cb9-4062-a4cf-2e04f05a1c36",
        "creator_id": "28192ad1-521c-438b-bc9f-016cb764eefa",
        "description": "from label pacs",
        "type": "TAG",
        "event": "CREATED",
        "created": 1631163149213,
        "label_ids": [
          "99da60b5-c4eb-4400-abe3-c2fbbfb6af37"
        ],
        "labels": [
          {
            "id": "99da60b5-c4eb-4400-abe3-c2fbbfb6af37",
            "type": "IMPRESSION",
            "scope": "IMAGE",
            "annotation_type": "TAG",
            "name": "Other",
            "short_name": "",
            "parent_label_id": "",
            "color": "#E91E63",
            "creator_id": "8fef7df2-7bc6-488a-b03c-db1bc90d95b3",
            "created": 1631163176743,
            "label_group_id": "932f8d9b-7447-4b76-acbd-97ec62c1e4a8",
            "children_select_type": "",
            "order": 0
          }
        ],
        "task_id": "fb170330-6354-4bda-a2c7-53313c1bc8bd",
        "study_id": "cce0c685-6de7-48b1-a274-60a2e56704ec",
        "creator_name": "rad4"
      }
    ]
  }
}