Export native file for data source

Purpose

Exports the native file for the specified non-relational data source. The file will be shown as an XML response.

URL

https://<myserver>:<port>/api/mgmt/datasources/{id}/export/driverfiles/native

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.

The {id} parameter must also be specified in the URL.

Sample Server Success Response

  Status code: 200
  Successful response

<?xml version='1.0' encoding='UTF-8'?>
<Native xmlns="http://test-datadirect.com/cloud/native" version="11" nativeVersion="1"
xmlns:z="http://test-datadirect.com/cloud/native/sforce">    
    <Options>
        <OptionSet name="Set1">
            <Option value="a__c"/>
            <Option value="BigTable__c"/>
            <Option value="BINTABLE__c"/>
            <Option value="BITABLE__c"/>
            <Option value="BTABLE__c"/>
            ...
        </OptionSet>
        ...
    </Options>
    <Packages>
        <Package name="SFORCE">            
            <Object name="AcceptedEventRelation" ... label="Accepted Event Relation">
                <Fields>
                    <Field name="Id" ... label="Event Relation ID"/>
                    <Field name="RelationId" ... label="Relation ID"/>
                    <Field name="EventId" ... label="Event ID"/>
                    ...
                </Fields>
                <Parents>
                    <Parent name="Relation0" ... parentKeyPath="Id/*"/>
                        <KeyPart path="RelationId/*" parentKeyPath="Id/*"/>
                    </Parent>
                    <Parent name="Relation1" ... parentPackage="SFORCE">
                        <KeyPart path="RelationId/*" parentKeyPath="Id/*"/>
                    </Parent>
                    ...
                </Parents>
                <Children>
                    <Child name="ChildAccounts" ... childPackage="SFORCE">
                        <KeyPart path="Id/*" childKeyPath="ParentId/*"/>
                    </Child>
                    <Child name="AccountContactRoles" ... cascadeDelete="true">
                        <KeyPart path="Id/*" childKeyPath="AccountId/*"/>
                    </Child>
                    ...
                </Children>
            </Object>
        </Package>
    </Packages>
</Native>

Sample Server Failure Response

{
    "error": 
      {
       "code": 222208728,
       "message": "No native cloud db driver file found."
      }
} 

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have either the Administrator (12) permission, or the MgmtAPI (11) permission and ViewDataSource (2) permission on the applicable data source.