Relational Data Store Types | ArcGIS REST APIs

URL:: https://<root>/data/relationalDatastoreTypes
Methods:: GET
Operations:: Register Relational Data Store Type
Child Resources:: Relational Data Store Type
Version Introduced:: 10.5

Access requirements

Required privileges

The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.

Learn how to generate a token

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://organization.example.com/<context>/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
        }
      ]
    },
  ]
}