- 21 Jan 2025
- Print
- DarkLight
- PDF
GIS Item JSON Format
- Updated On 21 Jan 2025
- Print
- DarkLight
- PDF
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 Name | Definition | Parent Key |
---|---|---|
id | Unique identifier for this specific GIS item, useful for referencing and accessing the item directly. | N/A |
datasetId | Identifier of the dataset to which this item belongs, linking the item to its dataset. | N/A |
url | Direct API endpoint for accessing this item, allowing integrations and automated access to the item’s data | N/A |
dataset | API endpoint for the dataset that contains this item, providing context and location of the dataset in the data management system. | N/A |
createdAt | Item creation date | N/A |
dir | Directory path where the item is stored, showing its organizational location in the file system. | N/A |
filename | Name of the file | N/A |
type | Item type | N/A |
hidden | Boolean field indicating if the file is hidden, allowing users to control visibility in the interface. | N/A |
label | The annotations label | annotations |
attributes |
| annotations |
metadata | This key holds all the annotation information | annotations |
system | This key holds all the annotation system information | metadata |
status | QA status for annotation | system |
startTime | The start time of the annotation in video items | system |
endTime | The end time of the annotation in video items | system |
frame | The first frame of the annotation in video items | system |
endFrame | The end frame of the annotation in video items | system |
snapshots_ | Snapshot information Relevant for video annotation | system |
promptId | The ID of prompt annotation | system |
parentId | The ID of parent annotation | system |
clientId | The ID of parent annotation | system |
automated | If the frame is automated | system |
objectId | The annotation Object ID | system |
attributes | Snapshots attributes | system |
system | True - the system created this specific annotation, False - annotation was created on a different way | system |
itemLinks | ItemLinks are the connection between ‘snapshot’ annotation (like snapping a frame from a video) to the newly created image item | system |
openAnnotationVersion | product version | system |
recipeId | Id of the recipe | system |
user | User metadata that can be added by user via SDK | annotations |
creator | Annotation creator | annotations |
createdAt | Annotation creation date and time | annotations |
updatedBy | Annotation edits by username | annotations |
updatedAt | Annotation edits date and time | annotations |
hash | Used to map the item’s data to a string of arbitrary size | annotations |
source | Where the annotation was created: UI/SDK | annotations |
coordinates | Annotation position coordinates | annotations |
geo_type | Annotation tool type | coordinates |
wgs84_geo_coordinates | Annotation coordinates on the map | coordinates |
_id | Item ID | annotations |
filename | Name of the file | annotations |
metadata | This key holds all the annotation information | annotations |
system | Shows system metadata information. | metadata |
encoding | Click https://en.wikipedia.org/wiki/Character_encoding to learn about encoding. | metadata |
isBinary | Is the item a binary file? | metadata |
mimetype | The mime type of the file | metadata |
originalname | The filename of the JSON | metadata |
refs | The references of the task | metadata |
shebang | It allows the UI to present the annotation as GIS instead of a JSON type. | metadata |
size | Size of the file | metadata |
taskStatusLog | Logs from the task | metadata |