Retrieves a list of supported backend data stores and their options.
URL
https://<myserver>:<port>/api/mgmt/datastores
Method
GET
URL Parameters
<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.
Response Definition
The response takes the following format. The properties of the response are described in the table that follows.
Indicates whether the data store is the group data store (as opposed to a specific back end data store such as Oracle)
The group data store enables the creation of group data sources. A group data source is comprised of multiple member data sources that connect to one or more back end data stores such as Salesforce or SQL Server.
The group data store is named DataSource Group, and its ID is 56.
true | false
If true, the data store is the group data store.
If false, the data store is not the group data store.
"authorized"
Indicates whether the user making the request can create a data source on the data store
true | false
If true, the user making the request is authorized to create a data source for this data store.
If false, the user making the request is not authorized to create a data source for this data store.
"connectionType"
Provides details about a supported data store, including the options that can be specified when creating a data source on the data store.
{
"dataStores": [
{
"id": 1,
"name": "Salesforce",
"isBeta": false,
"isGroup": false,
"authorized": true,
"connectionType": [
{
"name": "Cloud",
"category": [
{
"name": "General",
"options": [
{
"id": "Name",
"displayName": "Data Source Name",
"documentation": "A name you provide to uniquely
identify this Data Source.",
"required": true,
"maxLength": 128,
"type": "string"
},
...
{
"id": "SecurityToken",
"displayName": "Security Token",
"documentation": "The security token is required to
log in to Salesforce from an untrusted network.
... A new token will be sent by e-mail.",
"type": "string"
}
]
},
...
{
"name": "Advanced",
"options": [
{
"id": "StmtCallLimit",
"displayName": "Web Service Call Limit",
"documentation": "The maximum number of Web service
calls allowed to Salesforce for a single SQL
statement or metadata query.",
"minInclusive": 0,
"maxInclusive": 2000000000,
"type": "integer",
"default": "0"
},
...
{
"id": "HDPMetadataExposedSchemas",
"displayName": "Metadata Exposed Schemas",
"documentation": "Defines the schemas to be allowed
in the metadata queries.",
"type": "string"
}
]
}
]
}
]
},
...
{
"id": 43,
"name": "Oracle",
"isBeta": false,
"isGroup": false,
"authorized": true,
"connectionType": [
{
"name": "Hybrid",
"category": [
{
"name": "General",
"options": [
{
"id": "Name",
"displayName": "Data Source Name",
"documentation": "A name you provide to uniquely
identify this Data Source.",
"required": true,
"maxLength": 128,
"type": "string"
},
...
{
"id": "TNSServerName",
"displayName": "TNS Server Name",
"documentation": "The Oracle net service name that
is used to reference the connection information
in a tnsnames.ora file.",
"type": "string"
}
]
},
...
{
"name": "Advanced",
"options": [
{
"id": "AlternateServers",
"displayName": "Alternate Servers",
"documentation": "The server name (servername1,
servername2, and so on) is required for each
... default port number of 1521 is used. For
more information, see the Help.",
"type": "string"
},
...
{
"id": "HDPMetadataExposedSchemas",
"displayName": "Metadata Exposed Schemas",
"documentation": "Defines the schemas to be allowed
in the metadata queries.",
"type": "string"
}
]
}
]
}
]
},
...
}
]
}
Sample Server Failure Response
{
"error": {
"code": "222206007",
"message": {
"lang": "en-US",
"value": "Invalid user ID or password"
}
}
}
