Jump to

• Request
• Response
• Examples

Create a custom map layer

post

/rest/ofscMetadata/v1/mapLayers

This operation creates a custom map layer.

Request

Body ()

The custom map layer object that needs to be created.

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.
• 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.

{
    "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."
        },
        "type":{
            "type":"string",
            "enum":[
                "internal",
                "external"
            ],
            "title":"Type",
            "description":"<p>The type of the custom map layer. The value can be set to either 'external' or 'internal'.</p><ul><li>If the value is set to 'external', then the geo data is imported from external source.</li><li>If the value is set to 'internal', then the geo data is in the Oracle Field Service MapViewer, and it need not be imported.</li></ul>"
        },
        "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'."
        },
        "sourceName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Source Name",
            "description":"The name of the external source of the custom map layers. This field is not applicable for the internal custom map layers."
        },
        "theme":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Theme",
            "description":"The theme name of the external custom map layers. This field is not applicable for the internal custom map layers."
        },
        "url":{
            "type":"string",
            "minLength":"1",
            "maxLength":"1024",
            "title":"URL",
            "description":"The URL for the external custom map layers. This field is not applicable for the internal custom map layers. "
        },
        "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",
        "type"
    ]
}

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
  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

{
    "properties":{
        "language":{
            "description":"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.",
            "type":"string"
        },
        "languageISO":{
            "description":"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)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

201 Response

This section describes the 201 status response for this operation. This response code indicates that the custom map layer object is created. The custom map layer object is returned in the response.

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.
• 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.

{
    "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."
        },
        "type":{
            "type":"string",
            "enum":[
                "internal",
                "external"
            ],
            "title":"Type",
            "description":"<p>The type of the custom map layer. The value can be set to either 'external' or 'internal'.</p><ul><li>If the value is set to 'external', then the geo data is imported from external source.</li><li>If the value is set to 'internal', then the geo data is in the Oracle Field Service MapViewer, and it need not be imported.</li></ul>"
        },
        "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'."
        },
        "sourceName":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Source Name",
            "description":"The name of the external source of the custom map layers. This field is not applicable for the internal custom map layers."
        },
        "theme":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "title":"Theme",
            "description":"The theme name of the external custom map layers. This field is not applicable for the internal custom map layers."
        },
        "url":{
            "type":"string",
            "minLength":"1",
            "maxLength":"1024",
            "title":"URL",
            "description":"The URL for the external custom map layers. This field is not applicable for the internal custom map layers. "
        },
        "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",
        "type"
    ]
}

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
  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

{
    "properties":{
        "language":{
            "description":"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.",
            "type":"string"
        },
        "languageISO":{
            "description":"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)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• 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.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to create a map layer by submitting a POST request on the REST resource using cURL.

Example of Request Header

The following shows an example of the request header.

POST /rest/ofscMetadata/v1/mapLayers HTTP/1.0

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
  "label": "somelb1",           
  "type": "external",           
  "status": "active",           
  "sourceName": "someSourceName",   
  "theme": "someTheme",         
  "url": "https://hello.com",    
  "translations": [             
    {
      "language": "en",
      "name": "Some Name"
    },
    {
      "language": "es",
      "name": "Un Nombre"
    }
  ]
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201 Created

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "label": "somelb1",         
    "type": "external",         
    "status": "active",         
    "sourceName": "someSourceName", 
    "theme": "someTheme",       
    "url": "https://hello.com",  
    "text": "Some Name",        
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/mapLayers/somelb1"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/mapLayers"
        }
    ]
}

Back to Top