GIS Item JSON Format
  • 21 Jan 2025
  • Dark
    Light
  • PDF

GIS Item JSON Format

  • Dark
    Light
  • PDF

Article summary

Overview

The GIS Item JSON structure in Dataloop provides a comprehensive format that encapsulates all necessary data and metadata for each annotated entity within the system. This structure is designed to represent an 'Item' — a core data unit in Dataloop's platform — and its associated information for annotation purposes. Here’s a breakdown based on the provided content:

The JSON Structure

Each data entity in Dataloop’s system has a dedicated JSON format that encapsulates the item’s data and metadata, enabling efficient tracking, access, and management within the platform. This JSON file is essential for exporting or downloading item annotations and can be accessed for detailed inspection or integration purposes.


GIS Item JSON Format


{
    "type": "gis",                              //For the type of Web Map Item, it should be GIS only and mandatory
    "shebang": "dataloop",                      //For the type of Web Map Item, it should be dataloop only and mandatory
    "metadata": {
        "dltype": "gis"                         //For the type of Web Map Item, it should be gis only and mandatory
    },
    "layer": {                                  // Representing the Tile Layer - it's a mandatory layer object
        "name": "OpenStreetMap",
        "type": "xyz",                          // Currently supporting "xyz", "osm" and "cog" types only
        "url": "https://dummy-tile.com/surveys/1723928/tiles/{z}/{x}/{y}?auth_token=fM68PVOJO8p5m2sPo4Cqdcoi4sLSsecR&datatype_name=vexcel_urban_vertical_jpg"
    },
    "optionalLayers":                           // Representing the Optional Layers array, which can have multiple layers("xyz", "osm" and "cog")
    [ 
        {
            "name": "OpenStreetMap",
            "type": "osm",
            "url": ""
        }
    ],
    "zoom":20,                                  // It's an optional zoom level, which can be between 0 to 28
    "minZoom":0,                                // It's an optional min zoom level, which can be between 0 to 28
    "maxZoom":30,                               // It's an optional max zoom level, which can be between 1 to 28
    "epsg":"4326",                              // Representing the file's Coordinate System . (3857, 3035, 4326)
    "bounds": [                                 // The coordinates that represents the (square) area within the map that the user can view, and should add/edit the annotations. I.e. the bounds where the projection is valid. Optional field.
        [-118.33559370040894, 33.82662439264756],//top left
        [-118.33497619628906, 33.82610016009953]//bottom    right
    ],
    "aoi": [                                    // Coordinates representing the Area of Interest -- The areas within the bounds of the tile layer, where I allow to create annotations. I.e. the “boarders of the canvas”. Optional field. 
        [-118.33545684814453, 33.826504880358854],
        [-118.33545684814453, 33.82621967238824],
        [-118.33511352539062, 33.82621967238824],
        [-118.33511352539062, 33.826504880358854],
        [-118.33545684814453, 33.826504880358854]
    ]
}



GIS Item JSON Fields Description

Key NameDefinitionParent Key
idUnique identifier for this specific GIS item, useful for referencing and accessing the item directly.N/A
datasetIdIdentifier of the dataset to which this item belongs, linking the item to its dataset.N/A
urlDirect API endpoint for accessing this item, allowing integrations and automated access to the item’s dataN/A
datasetAPI endpoint for the dataset that contains this item, providing context and location of the dataset in the data management system.N/A
createdAtItem creation dateN/A
dirDirectory path where the item is stored, showing its organizational location in the file system.N/A
filenameName of the fileN/A
typeItem typeN/A
hiddenBoolean field indicating if the file is hidden, allowing users to control visibility in the interface.N/A
labelThe annotations labelannotations
attributes
  • Annotation 1.0 format – list of annotation attributes
  • Annotation 2.0 format – dictionary of annotation attributes
annotations
metadataThis key holds all the annotation informationannotations
systemThis key holds all the annotation system informationmetadata
statusQA status for annotationsystem
startTimeThe start time of the annotation in video itemssystem
endTimeThe end time of the annotation in video itemssystem
frameThe first frame of the annotation in video itemssystem
endFrameThe end frame of the annotation in video itemssystem
snapshots_Snapshot information Relevant for video annotationsystem
promptIdThe ID of prompt annotationsystem
parentIdThe ID of parent annotationsystem
clientIdThe ID of parent annotationsystem
automatedIf the frame is automatedsystem
objectIdThe annotation Object IDsystem
attributesSnapshots attributessystem
systemTrue - the system created this specific annotation, False - annotation was created on a different waysystem
itemLinksItemLinks are the connection between ‘snapshot’ annotation (like snapping a frame from a video) to the newly created image itemsystem
openAnnotationVersionproduct versionsystem
recipeIdId of the recipesystem
userUser metadata that can be added by user via SDKannotations
creatorAnnotation creatorannotations
createdAtAnnotation creation date and timeannotations
updatedByAnnotation edits by usernameannotations
updatedAtAnnotation edits date and timeannotations
hashUsed to map the item’s data to a string of arbitrary sizeannotations
sourceWhere the annotation was created: UI/SDKannotations
coordinatesAnnotation position coordinatesannotations
geo_typeAnnotation tool typecoordinates
wgs84_geo_coordinatesAnnotation coordinates on the mapcoordinates
_idItem IDannotations
filenameName of the fileannotations
metadataThis key holds all the annotation informationannotations
systemShows system metadata information.metadata
encodingClick https://en.wikipedia.org/wiki/Character_encoding to learn about encoding.metadata
isBinaryIs the item a binary file?metadata
mimetypeThe mime type of the filemetadata
originalnameThe filename of the JSONmetadata
refsThe references of the taskmetadata
shebangIt allows the UI to present the annotation as GIS instead of a JSON type.metadata
sizeSize of the filemetadata
taskStatusLogLogs from the taskmetadata

What's Next