Relational Data Store Type

URL:: https://<root>/data/relationalDatastoreTypes/<relationalDatastoreTypeID>
Methods:: GET
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

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

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/admin/data/relationalDatastoreTypes/esri.teradata?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "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

Use dark colors for code blocksCopy
{
  "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"
  ]
}