Create a Custom Layer

post

/vision/api/custom

Creates a custom layer. After creating a layer, use the Raw JSON endpoint to add and manage data on the custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:
  • Admin
  • Api

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root 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
Back to Top

Response

Supported Media Types

201 Response

The custom layer was created successfully.
Body ()
Root Schema : schema
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 : 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
Nested Schema : links
Type: array
Links related to the requested or updated content.
Show Source
Nested Schema : ColumnData
Type: object
The details of columns to use to show data in a table.
Show Source

401 Response

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

422 Response

Unprocessable Entity. Usually due to not providing a required field.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source

500 Response

The server encountered an unexpected condition that prevented it from fulfilling the request.
Body ()
Root Schema : schema
Type: object
The error response details.
Show Source
Back to Top