Jump to

• Request
• Response
• Examples

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.

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : MapLayers

Type: object

Title: MapLayers

Show Source

• 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.
• 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.
• 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":"object",
    "title":"MapLayers",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":24,
            "pattern":"^[A-Za-z0-9_]+$",
            "title":"Label",
            "description":"The unique identifier of the custom map layer."
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "title":"Status",
            "description":"The status of the custom map layers. The status can be set to either 'active' or 'inactive'."
        },
        "text":{
            "type":"string",
            "title":"Text",
            "description":"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."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"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."
        },
        "shapeTitleColumn":{
            "type":"string",
            "title":"Shape Title Column",
            "description":"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."
        },
        "tableColumns":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "title":"List of Table Columns"
        },
        "shapeHintColumns":{
            "type":"array",
            "items":{
                "type":"object",
                "title":"Shape Hint Column",
                "properties":{
                    "defaultName":{
                        "type":"string",
                        "title":"Default Name"
                    },
                    "sourceColumn":{
                        "type":"string",
                        "title":"Source Column Name"
                    },
                    "pluginFormField":{
                        "type":"string",
                        "title":"Plugin or Form Column Name",
                        "maxLength":255
                    }
                },
                "required":[
                    "defaultName",
                    "sourceColumn",
                    "pluginFormField"
                ]
            },
            "title":"List of Shape Hint Columns"
        },
        "shapeHintButton":{
            "type":"object",
            "title":"Plugin or form map layer hint button",
            "description":"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.",
            "properties":{
                "actionType":{
                    "type":"string",
                    "enum":[
                        "plugin",
                        "form"
                    ],
                    "title":"PluginForm Type",
                    "description":"The type of plugin or form the activity hint button on map layer."
                },
                "label":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":64,
                    "title":"Label for plugin or form",
                    "description":"The label plugin or form for map layer hint."
                }
            },
            "required":[
                "actionType",
                "label"
            ]
        }
    },
    "required":[
        "label"
    ]
}

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.

{
    "type":"object",
    "title":"Plugin or form map layer hint button",
    "description":"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.",
    "properties":{
        "actionType":{
            "type":"string",
            "enum":[
                "plugin",
                "form"
            ],
            "title":"PluginForm Type",
            "description":"The type of plugin or form the activity hint button on map layer."
        },
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":64,
            "title":"Label for plugin or form",
            "description":"The label plugin or form for map layer hint."
        }
    },
    "required":[
        "actionType",
        "label"
    ]
}

Nested Schema : List of Shape Hint Columns

Type: array

Title: List of Shape Hint Columns

Show Source

• Array of: object Shape Hint Column
  Title: Shape Hint Column

{
    "type":"array",
    "items":{
        "type":"object",
        "title":"Shape Hint Column",
        "properties":{
            "defaultName":{
                "type":"string",
                "title":"Default Name"
            },
            "sourceColumn":{
                "type":"string",
                "title":"Source Column Name"
            },
            "pluginFormField":{
                "type":"string",
                "title":"Plugin or Form Column Name",
                "maxLength":255
            }
        },
        "required":[
            "defaultName",
            "sourceColumn",
            "pluginFormField"
        ]
    },
    "title":"List of Shape Hint Columns"
}

Nested Schema : List of Table Columns

Type: array

Title: List of Table Columns

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "title":"List of Table Columns"
}

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

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"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."
}

Nested Schema : Shape Hint Column

Type: object

Title: Shape Hint Column

Show Source

• 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

{
    "type":"object",
    "title":"Shape Hint Column",
    "properties":{
        "defaultName":{
            "type":"string",
            "title":"Default Name"
        },
        "sourceColumn":{
            "type":"string",
            "title":"Source Column Name"
        },
        "pluginFormField":{
            "type":"string",
            "title":"Plugin or Form Column Name",
            "maxLength":255
        }
    },
    "required":[
        "defaultName",
        "sourceColumn",
        "pluginFormField"
    ]
}

Nested Schema : Translation

Type: object

Show Source

• language(required): string
  The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').

  See Supported Language Codes to view the values that are supported.

• languageISO: string
  The ISO language code (for example, 'en-US').
• name(required): string
  The specified name of the property translated to the language code available in the system.

{
    "properties":{
        "language":{
            "description":"The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').<p>See <a href='OFSC_Supported_Language_Codes.html'>Supported Language Codes</a> to view the values that are supported.</p> ",
            "type":"string"
        },
        "languageISO":{
            "description":"The ISO language code (for example, 'en-US').",
            "type":"string"
        },
        "name":{
            "description":"The specified name of the property translated to the language code available in the system.",
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Error response

Show Source

• detail: string
  The detailed information about the error.
• status: string
  The HTTP status code.
• title: string
  The summary of the error message.
• type: string
  The URL of the page containing the error details.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the page containing the error details."
        },
        "title":{
            "type":"string",
            "description":"The summary of the error message."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code."
        },
        "detail":{
            "type":"string",
            "description":"The detailed information about the error."
        }
    },
    "description":"Error response"
}

Back to Top

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"
        }
    ]
}

Back to Top