Purpose

Retrieves information and options for the specified data store. The options available on the data source are returned in the connectionType object. These options may be specified when creating a data source on the specified data store.

URL

https://<myserver>:<port>/api/mgmt/datastores/{datastoreId}

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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.

{datastoreId} is the integer ID of the data store. This data store ID is used to identify the data store in data source references.

Response Definition

The response takes the following format. The properties of the response are described in the table that follows.


    {
      "id": datastore_id,
      "name": "datastore_name",
      "isBeta": boolean,
      "isGroup": boolean,
      "authorized": boolean,
      "connectionType": {connection_type_details}
    }
Properties Description Valid Values
"id" The integer ID of the data store The data store ID
"name" The name of the data store The name of the data store
"isBeta" Indicates whether the data store is beta or GA true | false

If true, the data store is a beta data store.

If false, the data store is GA.
"isGroup" 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.
"driver" Provides details on the underlying driver used to connect to the data source. The driver details include the name of the driver jar file, the version number, and a help URL.
"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. Connection type details include descriptions for parameters and the values that may be specified for them. See connectionType-details Object for more information.

Sample Server Success Response 

{
    "id": 1,
    "name": "Salesforce",
    "isBeta": false,
    "isGroup": false,
    "driver": {
        "name": "ddsforce.jar",
        "version": "6.0.0.2603",
        "helpURL": "https://docs.progress.com/bundle/datadirect-hybrid-data-
                    pipeline-46/page/Salesforce-parameters.html"
        },
    "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. Salesforce
                                 ... 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"
                        }
                    ]
                }
            ]
        }
    ]
}

Sample Server Failure Response 


{
  "error": {
    "code": "222207015",
    "message": {
      "lang": "en-US",
      "value": "Invalid DataStore ID: 88"
    }
  }
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) permission.