Tools and processes viewer
Endpoint that returns the viewer’s tools. It is a list of tools, processes, and actions, ordered according to the order field in the database. If the tool does not have “Visible in the geoportal” checked, it is not returned in the endpoint. Depending on the user, different tools will be visible.
Endpoint
The endpoint is as follows and can be called by passing a Token via header or parameter:
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/geoportal/map-tools/
If the Token is passed as a parameter: access_token
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/geoportal/map-tools/?access_token=*************
If the Token is passed as a header: Authorization
https://xxxxxxxxx.xxxx.xxx/xxxx/giscube-admin/geoportal/map-tools/
{ Authorization: Bearer rrxhu5YWizyuoIPBLKww2PfaeY5tSc }
Returned data
Field | Type | Description |
---|---|---|
“id” | Integer | Tool ID |
“name” | Text | Internal name of the tool. |
“title” | Text | Title of the tool. The name the user sees in the viewer. |
“description” | Text | Description of what the tool does (optional). |
“icon” | Text | Tool icon. Can be from the following libraries: material icons, line-awesome, and font-awesome. |
“action_type” | Text | Defines the tool’s behavior (action, url, webhook, to). |
“to” | Text | If “to” is defined as “action_type”. Route defined in the viewer’s router (in the front-end code). |
“url” | Text | If “url” or “webhook” is defined as “action_type”. Link to open or endpoint to make the request. |
“target” | Text | Where the defined “url” opens, in the same tab or a new one. |
“headers” | Text | Header of the Webhook GET request. |
“params” | Text | Parameters of the Webhook GET request. |