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:
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
- application/json
Root Schema : schema
Type:
object
The details of a custom layer.
Show Source
-
id: integer
(int64)
The custom layer ID.Example:
100
-
layerType: string
The layer type. Allowed values are plink or point. This cannot be changed after a layer has been created.Example:
plink
-
name: string
The custom layer name.Example:
Custom pLink Layer
-
onByDefault: boolean
Whether to display the custom layer when the map first loads (true) or not (false)Example:
true
-
refresh: integer
(int32)
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
-
use: boolean
Whether to make the layer visible in the map sidebar (true) or not (false)Example:
true
Response
Supported Media Types
- application/json
201 Response
The custom layer was created successfully.
Root Schema : schema
Type:
object
The response resource wrapper.
Show Source
-
columns: array
columns
Information about the columns used to display the requested or updated content.
-
content: object
schema
The details of a custom layer.
-
links: array
links
Links related to the requested or updated content.
Nested Schema : columns
Type:
array
Information about the columns used to display the requested or updated content.
Show Source
-
Array of:
object ColumnData
The details of columns to use to show data in a table.
Nested Schema : schema
Type:
object
The details of a custom layer.
Show Source
-
id: integer
(int64)
The custom layer ID.Example:
100
-
layerType: string
The layer type. Allowed values are plink or point. This cannot be changed after a layer has been created.Example:
plink
-
name: string
The custom layer name.Example:
Custom pLink Layer
-
onByDefault: boolean
Whether to display the custom layer when the map first loads (true) or not (false)Example:
true
-
refresh: integer
(int32)
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
-
use: boolean
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
-
Array of:
object Link
The link details.
Nested Schema : ColumnData
Type:
object
The details of columns to use to show data in a table.
Show Source
-
cssClass: string
The CSS class for the column.Example:
slick-header-column
-
defaultSortAsc: boolean
Whether to sort the column in ascending order by default (true) or not (false).Example:
true
-
editor: string
The editor to use for the column.Example:
TaskEnabledEditor
-
entity: string
The name of the Vision resource that the column represents. This generally corresponds to one of the sections in the side menu of the Settings UI.Example:
Task
-
field: string
The field to use for data in the column cells.Example:
enabled
-
focusable: boolean
Whether the column is focusable (true) or not (false).Example:
true
-
formatter: string
The formatter to apply to the column. For example, CamelCaseFormatter formats strings to use camel case, transforming a value like true to True.Example:
CamelCaseFormatter
-
headerCssClass: string
The CSS class for the column header.Example:
slick-header-column
-
id: integer
(int64)
The column ID.Example:
130
-
maxWidth: integer
(int32)
The maximum width for the column.Example:
80
-
minWidth: integer
(int32)
The minimum width for the column.Example:
30
-
name: string
The column name, that appears in the header row.Example:
Enabled
-
options: string
Options for values in the column.Example:
true,false
-
rerenderOnResize: boolean
Whether the column should be rerendered when resized (true) or not (false).Example:
false
-
resizable: boolean
Whether the column can be resized (true) or not (false).Example:
true
-
selectable: boolean
Whether the column can be selected (true) or not (false).Example:
true
-
sortable: boolean
Whether the column can be used to sort the table (true) or not (false).Example:
true
-
tooltip: string
The tooltip to display for the column.Example:
Whether the task is enabled or disabled.
-
width: integer
(int32)
The default width, in pixels, of the column.Example:
50
Nested Schema : Link
Type:
object
The link details.
Show Source
-
expects: object
expects
Additional Properties Allowed: additionalPropertiesAny input expected by the link.
-
href: string
The link reference.Example:
https://example.com/layers
-
method: string
The HTTP method used by the linked object.Example:
GET
-
rel: string
The relationship between the linked object and the current object.Example:
self
Nested Schema : expects
Type:
object
Additional Properties Allowed
Show Source
Any input expected by the link.
Example:
text
Nested Schema : additionalProperties
Type:
object
401 Response
Unauthorized Access
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
422 Response
Unprocessable Entity. Usually due to not providing a required field.
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500
500 Response
The server encountered an unexpected condition that prevented it from fulfilling the request.
Root Schema : schema
Type:
object
The error response details.
Show Source
-
message: string
The error message.Example:
An internal server error occurred.
-
reason: string
The reason phrase for the response.Example:
INTERNAL SERVER ERROR
-
status: integer
(int32)
The response status code.Example:
500