Relational Data Store Types

URL:: https://<root>/data/relationalDatastoreTypes
Methods:: GET
Required Capability:: Access allowed with any authorized privilege
Version Introduced:: 10.5

Description

Relational Data Store Types are used by ArcGIS Insights. They enable Insights users to browse and query data from relational databases through the creation of Relational Database Connection portal items.

This resource lists the relational data store types that have been registered with the server. Each registered relational data store type has both an id and a name property, as well as an array of userDefinedProperties, which indicates the properties that client applications must provide when creating a Relational Database Connection portal item. Only administrators can register and unregister a relational data store type.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample request URL for the relationalDataStoreTypes resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/admin/data/relationalDatastoreTypes?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "relationalDatastoreTypes": [
    {
      "name": "",
      "id": "",
      "userDefinedProperties": [] //platform-specific connection properties
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "relationalDatastoreTypes": [
    {
      "name": "SAP HANA",
      "id": "esri.hana",
      "userDefinedProperties": [
        {
          "name": "username",
          "alias": "User Name",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "password",
          "alias": "Password",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "serverName",
          "alias": "Server Name",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "databaseName",
          "alias": "Database Name",
          "defaultValue": "",
          "type": "string",
          "required": false
        },
        {
          "name": "portNumber",
          "alias": "Port Number",
          "defaultValue": "",
          "type": "int",
          "required": false
        }
      ]
    },
    {
      "name": "Microsoft SQL Server",
      "id": "esri.sqlserver",
      "userDefinedProperties": [
        {
          "name": "username",
          "alias": "User Name",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "password",
          "alias": "Password",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "serverName",
          "alias": "Server Name",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "databaseName",
          "alias": "Database Name",
          "defaultValue": "",
          "type": "string",
          "required": true
        },
        {
          "name": "instanceName",
          "alias": "Instance Name",
          "defaultValue": "",
          "type": "string",
          "required": false
        },
        {
          "name": "portNumber",
          "alias": "Port Number",
          "defaultValue": "",
          "type": "int",
          "required": false
        }
      ]
    },
  ]
}