Skip To Content ArcGIS for Developers Sign In Dashboard

Relational Data Store Type

Description

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