Relational Data Store Types

Description

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 client applications must provide when creating a Relational Database Connection portal item. Only administrators can register and unregister a relational data store type. The following database platforms are supported: SAP HANA, Microsoft SQL Server and Teradata.

Request Parameters

Parameter

Details

f

The response format. The default response format is html.

Values: html | json

Response Format

{
  "relationalDatastoreTypes":[  
    {  
      "name":"",
      "id": "",
      "userDefinedProperties":[] //platform-specific connection properties  
    }, ... 
  ]
}

Example

http://services.myserver.com:port/arcgis/admin/data/relationalDatastoreTypes?f=json

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

3/3/2017