Skip to main content

API Reference

API docs by Redocly

Urbi.Geo.Push.Api (v1)

DynamicAsset

Actions to work with dynamic assets

Get dynamic asset metadata

Get dynamic asset metadata

Sample request:

GET /dynamic_asset/user_dyn_pRsBtqGECTpwKqDkCzow
Authorizations:
Bearer
path Parameters
assetId
required
string [ 1 .. 200 ] characters

Dynamic asset ID

header Parameters
X-Brand
required
string
Default: 2gis

Responses

Response Schema: application/json
id
required
string [ 1 .. 200 ] characters

ID

name
required
string [ 1 .. 100 ] characters

Name

description
string or null [ 1 .. 500 ] characters

Description

geometry_dimension
required
string (GeometryDimension)
Enum: "point" "line" "polygon"

Members:

  • point
  • line
  • polygon
required
Array of objects (AssetAttributeGroup)

Attribute groups

Array of objects or null (AttributeFilter)

Filters

Array of objects or null (AttributeContextFilter)

Context filters

object (DynamicAssetLocalizations)

Response samples

Content type
application/json
{
  • "id": "user_dyn_zq3ZJxPdT0i1vDAvvyWkgQ",
  • "name": "Road events",
  • "description": "Information on various incidents affecting road traffic. The data includes details about roadworks, accidents, temporary traffic restrictions, weather conditions, traffic jams, and other events that may impact road safety and accessibility.",
  • "geometry_dimension": "point",
  • "attribute_groups": [
    • {
      }
    ],
  • "filters": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "context_filters": [
    • {
      }
    ],
  • "localizations": {
    • "name": {
      },
    • "description": {
      }
    }
}

Create dynamic asset

Create dynamic asset

Sample request:

POST /dynamic_asset
Authorizations:
Bearer
header Parameters
X-Brand
required
string
Default: 2gis
Request Body schema: application/json
name
required
string [ 1 .. 100 ] characters

Asset name

description
string or null [ 1 .. 500 ] characters

Asset description

geometry_dimension
required
string (GeometryDimension)
Enum: "point" "line" "polygon"

Members:

  • point
  • line
  • polygon
Array of objects or null (AssetAttributeGroup)

Attribute groups

Array of objects or null (AttributeFilter)

Filters

Array of objects or null (AttributeContextFilter) <= 100 items

Context filters

asset_group_id
string or null [ 1 .. 200 ] characters

Asset group ID. Determines the library group to place the asset to

object (CreateDynamicAssetRequestLocalizations)

Responses

Response Schema: application/json
task_id
string or null

Task ID

Array of objects or null (UrbiActionError)

Errors (if any)

asset_id
string or null

Asset ID

access_token
string or null

Token required to push data to asset

Request samples

Content type
application/json
{
  • "geometry_dimension": "point",
  • "name": "Road events",
  • "description": "Information on various incidents affecting road traffic. The data includes details about roadworks, accidents, temporary traffic restrictions, weather conditions, traffic jams, and other events that may impact road safety and accessibility.",
  • "attribute_groups": [
    • {
      }
    ],
  • "filters": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "context_filters": [
    • {
      }
    ],
  • "localizations": {
    • "name": {
      },
    • "description": {
      }
    }
}

Response samples

Content type
application/json
{
  • "asset_id": "user_dyn_zq3ZJxPdT0i1vDAvvyWkgQ",
  • "access_token": "VT8UivWdluDSWdXA",
  • "task_id": "hBAbF8iZVUKoXXUjJBgKpA"
}

Update dynamic asset metadata

Update dynamic asset metadata

Sample request:

PUT /dynamic_asset
Authorizations:
Bearer
header Parameters
X-Brand
required
string
Default: 2gis
Request Body schema: application/json
name
required
string [ 1 .. 100 ] characters

Asset name

description
string or null [ 1 .. 500 ] characters

Asset description

Array of objects or null (AssetAttributeGroup)

Attribute groups

Array of objects or null (AttributeFilter)

Filters

Array of objects or null (AttributeContextFilter) <= 100 items

Context filters

object (CreateDynamicAssetRequestLocalizations)
id
required
string [ 1 .. 200 ] characters

Asset ID

Responses

Response Schema: application/json
task_id
string or null

Task ID

Array of objects or null (UrbiActionError)

Errors (if any)

asset_id
string or null

Asset ID

access_token
string or null

Token required to push data to asset

Request samples

Content type
application/json
{
  • "id": "user_dyn_zq3ZJxPdT0i1vDAvvyWkgQ",
  • "name": "Road events",
  • "description": "Information on various incidents affecting road traffic. The data includes details about roadworks, accidents, temporary traffic restrictions, weather conditions, traffic jams, and other events that may impact road safety and accessibility.",
  • "attribute_groups": [
    • {
      }
    ],
  • "filters": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "context_filters": [
    • {
      }
    ],
  • "localizations": {
    • "name": {
      },
    • "description": {
      }
    }
}

Response samples

Content type
application/json
{
  • "asset_id": "user_dyn_zq3ZJxPdT0i1vDAvvyWkgQ",
  • "access_token": "VT8UivWdluDSWdXA",
  • "task_id": "hBAbF8iZVUKoXXUjJBgKpA"
}

Update dynamic asset filter

Update dynamic asset metadata

Sample request:

PUT /dynamic_asset/assetId/filter
Authorizations:
Bearer
path Parameters
id
required
string [ 1 .. 200 ] characters
header Parameters
X-Brand
required
string
Default: 2gis
Request Body schema: application/json
attribute_id
required
string [ 1 .. 200 ] characters

Corresponding attribute ID

control_type
required
string (FilterControlType)
Enum: "text_box" "check_box" "select_box" "check_box_list" "range" "date_range" "date_time_range"

Control type used to render filter in UI

Members:

  • text_box
  • check_box
  • select_box
  • check_box_list
  • range
  • date_range
  • date_time_range

Array of objects or null (AttributeFilterItem) <= 500 items

Filter items

min
number or null <double>

Minimal value

max
number or null <double>

Maximum value

Responses

Response Schema: application/json
task_id
string or null

Task ID

Array of objects or null (UrbiActionError)

Errors (if any)

asset_id
string or null

Asset ID

access_token
string or null

Token required to push data to asset

Request samples

Content type
application/json
{
  • "attribute_id": "Time",
  • "control_type": "date_time_range",
  • "min": 1761988910583,
  • "max": 1793524910583
}

Response samples

Content type
application/json
{
  • "asset_id": "user_dyn_zq3ZJxPdT0i1vDAvvyWkgQ",
  • "access_token": "VT8UivWdluDSWdXA",
  • "task_id": "hBAbF8iZVUKoXXUjJBgKpA"
}

Push data to dynamic asset

Push data to dynamic asset

Sample request:

PUT /dynamic_asset/user_dyn_pRsBtqGECTpwKqDkCzow/data
Authorizations:
Bearer
path Parameters
assetId
required
string [ 1 .. 200 ] characters

Dynamic asset ID

header Parameters
X-Brand
required
string
Default: 2gis
Request Body schema: application/json

Payload in GeoJSON format

type
required
string (GeoJsonType)
Enum: "Geometry" "Feature" "FeatureCollection"

GeoJson data type

Members:

  • Geometry
  • Feature
  • FeatureCollection

Array of objects or null (GeoJsonFeature) [ 1 .. 100 ] items

Responses

Response Schema: application/json
object or null

Errors grouped by object ID

property name*
additional property
Array of strings or null

Request samples

Content type
application/json
{
  • "type": "FeatureCollection",
  • "features": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "errors_by_id": {
    • "1": [
      ]
    }
}

Delete selected objects from dynamic asset

Delete selected objects from dynamic asset

Sample request:

DELETE /dynamic_asset/user_dyn_pRsBtqGECTpwKqDkCzow/data
Authorizations:
Bearer
path Parameters
assetId
required
string [ 1 .. 200 ] characters

Dynamic asset ID

header Parameters
X-Brand
required
string
Default: 2gis
Request Body schema: application/json
required

Objects to delete

Array ([ 1 .. 100 ] items)
string

Responses

Response Schema: application/json
string

Request samples

Content type
application/json
[
  • "1",
  • "2",
  • "3"
]

Response samples

Content type
application/json
"string"

Delete all objects from dynamic asset

Delete all objects from dynamic asset

Sample request:

DELETE /dynamic_asset/user_dyn_pRsBtqGECTpwKqDkCzow/data/all
Authorizations:
Bearer
path Parameters
assetId
required
string [ 1 .. 200 ] characters

Dynamic asset ID

header Parameters
X-Brand
required
string
Default: 2gis

Responses

Response Schema: application/json
string

Response samples

Content type
application/json
"string"