Get a custom map layer
get
/rest/ofscMetadata/v1/mapLayers/{label}
This operation retrieves the specified custom map layer.
Request
Path Parameters
-
label(required): string
The label of the custom map layer.
Response
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : MapLayers
Type:
object
Title:
Show Source
MapLayers
-
label(required):
string
Title:
Label
Minimum Length:1
Maximum Length:24
Pattern:^[A-Za-z0-9_]+$
The unique identifier of the custom map layer. -
shapeHintButton:
object Plugin or form map layer hint button
Title:
Plugin or form map layer hint button
The object representing selected Custom Form or Plugin will be displayed as a button on layer hint. Parameters specified in Plugin/Form Field will be sent to the selected Custom Form or Plugin. -
shapeHintColumns:
array List of Shape Hint Columns
Title:
List of Shape Hint Columns
-
shapeTitleColumn:
string
Title:
Shape Title Column
The name of the column that is selected as the title. This field is returned only if the property is set for the custom map layer. -
sourceName:
string
Title:
Source Name
Minimum Length:1
Maximum Length:255
The name of the external source of the custom map layers. This field is not applicable for the internal custom map layers. -
status:
string
Title:
Status
Allowed Values:[ "active", "inactive" ]
The status of the custom map layers. The status can be set to either 'active' or 'inactive'. -
tableColumns:
array List of Table Columns
Title:
List of Table Columns
-
text:
string
Title:
Text
The name of the custom map layer in the user's language. This field is returned only by using the GET operation and it is ignored in a PUT or POST operation. -
theme:
string
Title:
Theme
Minimum Length:1
Maximum Length:255
The theme name of the external custom map layers. This field is not applicable for the internal custom map layers. -
translations:
array Translations
Title:
Translations
The translations of all the custom map layers. This field is required in a PUT or POST operation. The translation of the 'text' parameter is required for the default language. -
type(required):
string
Title:
Type
Allowed Values:[ "internal", "external" ]
The type of the custom map layer. The value can be set to either 'external' or 'internal'.
- If the value is set to 'external', then the geo data is imported from external source.
- If the value is set to 'internal', then the geo data is in the Oracle Field Service MapViewer, and it need not be imported.
-
url:
string
Title:
URL
Minimum Length:1
Maximum Length:1024
The URL for the external custom map layers. This field is not applicable for the internal custom map layers.
Nested Schema : Plugin or form map layer hint button
Type:
object
Title:
Plugin or form map layer hint button
The object representing selected Custom Form or Plugin will be displayed as a button on layer hint. Parameters specified in Plugin/Form Field will be sent to the selected Custom Form or Plugin.
Show Source
-
actionType(required):
string
Title:
PluginForm Type
Allowed Values:[ "plugin", "form" ]
The type of plugin or form the activity hint button on map layer. -
label(required):
string
Title:
Label for plugin or form
Minimum Length:1
Maximum Length:64
The label plugin or form for map layer hint.
Nested Schema : List of Shape Hint Columns
Type:
array
Title:
Show Source
List of Shape Hint Columns
-
Array of:
object Shape Hint Column
Title:
Shape Hint Column
Nested Schema : Translations
Type:
array
Title:
Translations
The translations of all the custom map layers. This field is required in a PUT or POST operation. The translation of the 'text' parameter is required for the default language.
Show Source
Nested Schema : Shape Hint Column
Type:
object
Title:
Show Source
Shape Hint Column
-
defaultName(required):
string
Title:
Default Name
-
pluginFormField(required):
string
Title:
Plugin or Form Column Name
Maximum Length:255
-
sourceColumn(required):
string
Title:
Source Column Name
Nested Schema : Translation
Type:
Show Source
object
-
language(required):
string
This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
-
languageISO:
string
This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)
-
name(required):
string
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
detail:
string
The detailed description of this error.
-
status:
string
The HTTP status code of this error.
-
title(required):
string
The brief description of this error.
-
type(required):
string
The URL of the web page containing more details about this error.
Examples
The following example shows how to get a specific custom map layer by submitting a GET request on the REST resource.
Example of Request Header
The following shows an example of the request header.
GET /rest/ofscMetadata/v1/mapLayers/mapLayerLabel HTTP/1.0
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 Ok
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "label": "mapLayerLabel", "type": "external", "status": "active", "sourceName": "testName", "theme": "testTheme", "url": "http://testurl.com", "text": "some text", "links": [ { "rel": "canonical", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/mapLayers/testLabel" }, { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/mapLayers" } ] }