Relational Data Store Types

URL:
https://<root>/data/relationalDatastoreTypes
Methods:
GET
Operations:
Register Relational Data Store Type
Child Resources:
Relational Data Store Type
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

ParameterDetails

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:

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

JSON Response syntax

1
2
3
4
5
6
7
8
9
{
  "relationalDatastoreTypes": [
    {
      "name": "",
      "id": "",
      "userDefinedProperties": [] //platform-specific connection properties
    }
  ]
}

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
  "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
        }
      ]
    },
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close