Get a Custom Layer by ID

get

/vision/api/custom/{id}

Gets the specified custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
  • Admin
  • Operator
  • Viewer
  • Api

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ResourceWrapper12
Type: object
The response resource wrapper.
Show Source
Nested Schema : columns
Type: array
Information about the columns used to display the requested or updated content.
Show Source
Nested Schema : content
Match All
Show Source
Nested Schema : ColumnData
Type: object
The details of columns to use to show data in a table.
Show Source
Nested Schema : content-allOf[1]
Match All
The requested or updated content.
Show Source
  • schema
    The details of a custom layer.
  • The requested or updated content.
Nested Schema : schema
Type: object
The details of a custom layer.
Show Source
  • The custom layer ID.
    Example: 100
  • The layer type. Allowed values are plink or point. This cannot be changed after a layer has been created.
    Example: plink
  • The custom layer name.
    Example: Custom pLink Layer
  • Whether to display the custom layer when the map first loads (true) or not (false)
    Example: true
  • The interval, in minutes, at which the data on the custom layer should be refreshed. When set to 0, the data is static and is loaded only when the map is first loaded or manually refreshed.
    Example: 5
  • Whether to make the layer visible in the map sidebar (true) or not (false)
    Example: true

401 Response

Unauthorized Access
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

404 Response

Resource not Found
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

500 Response

An internal server error occurred while accessing the database or performing a database operation.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source
Back to Top