Skip To Content
ArcGIS Developer
Dashboard

Relational Data Store Types

Description

Legacy:

The request parameters, syntax, and examples described in this topic can be used in Insights 3.0 and lower. The parameters and syntax are deprecated starting at Insights 3.1.

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.

Note:
Relational data store types are only used with Insights and are not to be confused with ArcGIS Data Store relational data stores.

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.

Note:
Starting at 10.5.1, ArcGIS Insights must be installed in order to register Relational Data Store Types and create Relational Catalog Services or Relational Database Connections. Please refer to ArcGIS Insights documentation for more information on supported databases, required vendor files, supported data types, and required database privileges.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL for relationalDataStoreTypes:

https://machine.domain.com/webadaptor/admin/data/relationalDatastoreTypes?f=json

JSON Response syntax

{
  "relationalDatastoreTypes": [  
    {  
      "name": "",
      "id": "",
      "userDefinedProperties": [] //platform-specific connection properties  
    }
  ]
}

JSON Response example

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