Item JSON Format
  • 29 May 2024
  • Dark
    Light
  • PDF

Item JSON Format

  • Dark
    Light
  • PDF

Article summary

Item

An 'Item' is a Dataloop entity that represents the required data for annotation. It can consist of a single file or multiple files. For instance, a 'Video Item' comprises a sole video file, while a 'Lidar Item' includes multiple PCD frames stitched into one item, presenting them as a sequence. Each Dataloop Annotation Studio has its unique item structure.


Download an Item

A JSON structure represents the item. Refer to the Export selected/queried items section to learn about downloading the item JSON file.

JSON

JSON is a minimal text-based data exchange format that is used primarily to transmit data between a server and a web application. To understand more about JSON, go here.


Format Details

{
  "id": "61d5eb9d14b5b8ea83e18037",
  "datasetId": "61d5e83f5575066ffd58fcda",
  "createdAt": "2022-01-05T19:03:57.000Z",
  "dir": "/",
  "filename": "/panda.jpg",
  "type": "file",
  "hidden": false,
  "metadata": {
    "system": {
      "originalname": "panda.jpg",
      "size": 1681485,
      "encoding": "7bit",
      "mimetype": "image/jpeg",
      "taskStatusLog": [
        {
          "status": {
            "taskId": "61d5eb2f3e1b9e55742d498c",
            "assignmentId": "61d5eb2f3e1b9eb7c22d498d",
            "status": "completed",
            "creator": "vakasix267@zoeyy.com",
            "timestamp": "2022-01-05T19:09:21.823Z"
          },
          "action": "created"
        },
        {
          "status": {
            "taskId": "61d5eb2f3e1b9e55742d498c",
            "assignmentId": "61d5eb2f3e1b9eb7c22d498d",
            "status": "completed",
            "creator": "vakasix267@zoeyy.com",
            "timestamp": "2022-01-05T19:26:16.095Z"
          },
          "action": "deleted"
        },
        {
          "status": {
            "taskId": "61d5eb2f3e1b9e55742d498c",
            "assignmentId": "61d5eb2f3e1b9eb7c22d498d",
            "status": "completed",
            "creator": "vakasix267@zoeyy.com",
            "timestamp": "2022-01-05T19:31:38.290Z"
          },
          "action": "created"
        }
      ],
      "refs": [
        {
          "type": "pipelineExecution",
          "id": "61d5eb9da833ff055cdb16e5",
          "pipelineId": "61cdb7e058f16ab159713d38"
        },
        {
          "type": "task",
          "id": "61d5eb2f3e1b9e55742d498c",
          "metadata": {
            "creator": "vakasix267@zoeyy.com",
            "status": "completed",
            "timestamp": "2022-01-05T19:31:38.290Z"
          }
        },
        {
          "type": "assignment",
          "id": "61d5eb2f3e1b9eb7c22d498d",
          "metadata": {
            "creator": "vakasix267@zoeyy.com",
            "status": "completed",
            "timestamp": "2022-01-05T19:31:38.290Z"
          }
        }
      ],
      "isBinary": true,
      "executionLogs": {
        "image-preprocess": {
          "default_module": {
            "on_create": {
              "61d5eb9da833ff954bdb16e4": {
                "status": "success",
                "progress": 100
              }
            }
          }
        },
        "pipeline-utils": {
          "default_module": {
            "move_to_task": {
              "61d5eb9da833ff1cabdb16fa": {
                "status": "success",
                "progress": 100
              },
              "61d5eb9da833ff1b1bdb16fb": {
                "status": "success",
                "progress": 100
              },
              "61d5eb9da833ff4278db1708": {
                "status": "success",
                "progress": 100
              }
            }
          }
        }
      },
      "channels": 3,
      "exif": {},
      "height": 3872,
      "thumbnailAnnotationsId": "61d5eba014b5b85774e1803d",
      "thumbnailId": "61d5eba014b5b89da1e1803a",
      "width": 2592
    }
  },
  "name": "panda.jpg",
  "url": "https://rc-gate.dataloop.ai/api/v1/items/61d5eb9d14b5b8ea83e18037",
  "dataset": "https://rc-gate.dataloop.ai/api/v1/datasets/61d5e83f5575066ffd58fcda",
  "creator": "oren.a@dataloop.ai",
  "annotationsCount": 1,
  "annotated": true,
  "stream": "https://rc-gate.dataloop.ai/api/v1/items/61d5eb9d14b5b8ea83e18037/stream",
  "thumbnail": "https://rc-gate.dataloop.ai/api/v1/items/61d5eb9d14b5b8ea83e18037/thumbnail",
  "annotations": [. . .]
}

Dictionary Table

Key NameDefinitionParent Key
idItem/image IDN/A
datasetIdDataset IDN/A
createdAtTime and date the item/image was uploadedN/A
dirImage location directory in datasetN/A
filenameItem/image full pathN/A
typeItem typeN/A
hiddenSystem propertyN/A
metadataThis key holds all the item's informationN/A
systemThis key holds all the item's system informationmetadata
originalnameOriginal item's name when createdsystem
sizeImage size in bytessystem
encodingencodingsystem
mimetypeMedia typesystem
taskStatusLogList of item statuses in given taskssystem
statusInformation about the status of the item in a given tasktaskStatusLog
taskIdTask idstatus
assignmentIdAssignment idstatus
statusThe status of the item in this taskstatus
creatorCreator of the statusstatus
timestampWhen the task status was createdstatus
actionThe action (created/deleted) on the status of this itemtaskStatusLog
refsTask assignment list referencesystem
typetask or assignmentrefs
idID of the task/assignment that the item is linked withrefs
metadataInformation about the item in this task/assignmentrefs
creatorUsername of the creator of the status of the item in this task/assignmentmetadata
statusStatus of this item in this task/assignment – completed/discard/complete/custom status created by the task creator (this attribute will not show if no status has been created yet)metadata
timestampDate and time when the status was createdmetadata
isBinaryIs the item a binary filesystem
executionLogsInformation about executions the item went throughsystem
image-preprocessInformation about preprocess the item went through (e.g., export metadata)executionLogs
default-moduleName of the moduleimage-preprocess
on_createName of the functiondefault-module
61d5eb9da833ff954bdb16e4Execution IDon_create
statusExecution progress61d5eb9da833ff954bdb16e4
progressExecution status61d5eb9da833ff954bdb16e4
pipeline-utilsFaaS name (as seen in application hub library)executionLogs
default_moduleApp module namepipeline-utils
move_to_taskFunction namedefault_module
61d5eb9da833ff1cabdb16faExecution of the move_to_task functionmove_to_task
statusThe status of the execution61d5eb9da833ff1cabdb16fa
progressThe progress of the execution61d5eb9da833ff1cabdb16fa
channelsImage color dimensions (1 black and white; 3 color (rgb); 4 with transparency effect)system
exif[exif](https://docs.dataloop.ai/docs/exif-orientation-value){target="_blank"} informationsystem
heightImage resolutionsystem
thumbnailAnnotationsIdThumbnail Annotation idsystem
thumbnailIdThumbnail idsystem
widthImage resolutionsystem
nameUpdated item nameN/A
urlAPI URL for itemsN/A
datasetAPI URL for datasetN/A
creatorItem creatorN/A
annotationsCountNumber of annotationsN/A
annotatedTrue shows that the item is annotatedN/A
streamAPI URL for streamN/A
thumbnailAPI URL for thumbnailN/A
annotationsInformation about annotationsN/A

What's Next