Remote metadata reference#

Projects metadata#

Project metadata example:

{
  "name": "Example Project test",
  "description": "test vector",
  "creator_id": "admin@superannotate.com",
  "updatedAt": "2020-08-31T05:43:43.118Z",
  "createdAt": "2020-08-31T05:43:43.118Z"
  "type": "Vector",
  "attachment_name": None,
  "attachment_path": None,
  "entropy_status": 1,
  "status": "NotStarted",
  "item_count": 123,
  "...": "..."
}

Folder metadata#

Folder metadata example:

{
 "name": "Example folder",
 "status": "NotStarted"
}

Setting metadata#

Setting metadata example:

{
 "attribute": "FrameRate",
 "value": 3
}

Export metadata#

Export metadata example:

{
  "name": "Aug 17 2020 15:44 First Name.zip",
  "user_id": "user@gmail.com",
  "status": 2,
  "createdAt": "2020-08-17T11:44:26.000Z",
  "...": "..."
}

Integration metadata#

Integration metadata example:

{
"name": "My S3 Bucket",
"type": "aws",
"root": "test-openseadragon-1212"
 }

Item metadata#

Item metadata example:

{
 "createdAt": "2022-09-14T07:06:53.000Z",
 "updatedAt": "2022-09-30T13:14:26.000Z",
 "id": 33027004,
 "name": "5199856037_03d1929b7b_o.jpg",
 "path": "New Classes",
 "url": "None",
 "assignments": [
    {
       "user_role": "Annotator",
       "user_id": "annotator@example.com"
    },
    {
       "user_role": "QA",
       "user_id": "qa@example.com"
    }
 ],
 "entropy_value": "None",
 "custom_metadata": {
    "study_date": "2021-12-31",
    "patient_id": "A1234567890",
    "medical_specialist": "dr.smith@clinic.com",
 }
 }

Priority score#

Priority score example:

{
     "name" : "image1.png",
     "priority": 0.567
 }

Attachment#

Attachment example:

{
   "url": "https://sa-public-files.s3.../text_file_example_1.jpeg",
   "name": "example.jpeg"
}

Annotation class metadata#

Annotation class metadata example:

{
  "id": 4444,
  "name": "Human",
  "color": "#e4542b",
  "attribute_groups": [
     {
        "name": "tall",
        "attributes": [
           {
              "name": "yes"
           },
           {
              "name": "no"
           }
        ]
     },
     {
       "name": "age",
       "attributes": [
           {
             "name": "young"
           },
           {
             "name": "old"
           }
       ]
     }
  ],

  "...": "..."
}

Team contributor metadata#

Team contributor metadata example:

{
  "id": "admin@superannotate.com",
  "first_name": "First Name",
  "last_name": "Last Name",
  "email": "admin@superannotate.com",
  "user_role": 6
  "...": "...",
}