Relational Data Store Type

URL:
https://<root>/data/relationalDatastoreTypes/<relationalDatastoreTypeID>
Methods:
GET
Operations:
Edit Relational Data Store Type, Unregister Relational Data Store Type
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.5

Description

The resource for an individual relational data store type lists its properties. The properties returned are those that client applications must provide when creating a Relational Database Connection portal item.

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 used to access an individual relational data store type resource:

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

JSON Response syntax

1
2
3
4
5
6
{
  "name": "",  //user-friendly name
  "id": "",  //identifier
  "userDefinedProperties": [],  //properties specified when creating a relational catalog service
  "dependentServices": []  //comma-separated array of existing relational catalog services using this type
}

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
{
  "name": "Teradata",
  "id": "esri.teradata",
  "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": "DATABASE",
      "alias": "Database Name",
      "defaultValue": "",
      "type": "string",
      "required": true
    },
    {
      "name": "DBS_PORT",
      "alias": "Port Number",
      "defaultValue": "",
      "type": "int",
      "required": false
    }
  ],
  "dependentServices": [
    "QA1.RelationalCatalogServer"
  ]
}

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