Get output REST file

Hybrid Data Pipeline API reference : Management API : Driver Files API : Get output REST file

Try Now

Purpose

Retrieves the output REST file. The output REST file is a JSON object provided in the response payload.

URL

https://<myserver>:<port>/api/mgmt/datasources/{datasourceId}/export/driverfiles/outputrest

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.

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

Parameter	Description	Valid Values
{id}	The ID of the data source.	The ID is auto-generated when the data source is created and cannot be changed.

Sample Server Success Response

Status code: 200
Successful response

{
"countries": {
"#path": [
"https://example.com/country"
],
"type": "VarChar(64),#key",
"metadata": {
"generated": "BigInt",
"url": "VarChar(184)",
"title": "VarChar(64)",
"status": "Integer",
...
},
"features[1]": {
"type": "VarChar(10)",
"properties": {
"size": "Decimal",
"place": "VarChar(108)",
...
},
"geometry": {
"type": "VarChar(7)",
"coordinates[3]": "Double"
},
"id": "VarChar(27)"
},
...
}
}

Sample Server Failure Response

{
"error": {
"code": 222208734,
"message": {
"lang": "en-US",
"value": "inputrest driver file is not applicable for datasources with
datastore id {1}. Applicable datastore id is 62."
}
}
}

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.