Skip To Content
ArcGIS Developers
Dashboard

Relational Data Store Type

Description

Legacy:

The use of all relational data store operations in the ArcGIS Server Admin API has been deprecated as of ArcGIS Enterprise 10.9. Starting at Insights 2021.1, the registration and management of relational data store types should be performed with ArcGIS Insights. For more information, see Manage connector types.

This resource lists the properties of a registered relational data store type. 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

Example usage

Below is a sample request URL for an individual relational data store type resource:

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

JSON Response syntax

{  
  "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

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