Latest version of this endpoint: API ImportedDatasets Get v4.
Contents:
Get the specified imported dataset.
Version: v3
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.0/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v3/importedDatasets/<id>
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the imported dataset |
Endpoint with embedded reference:
Use the following embedded reference to embed in the response data about the connection used to acquire the source dataset if it was created from a Hive or relational connection.
/v3/importedDatasets/<id>?embed=connection
Request URI - Example:
/v3/importedDatasets/196
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"id": 196,
"size": "-1",
"path": null,
"isSharedWithAll": false,
"type": "jdbc",
"bucket": null,
"isSchematized": true,
"createdAt": "2017-02-17T19:07:12.757Z",
"updatedAt": "2017-02-17T19:09:10.117Z",
"createdBy": 1,
"updatedBy": 1,
"name": "SQL Dataset 1 – 4",
"description": null,
"connection": {
"id": 7
},
"parsingRecipe": {
"id": 378
},
"relationalSource": {
"relationalPath": null,
"columns": null,
"filter": null,
"raw": [
"SELECT INST#,BUCKET#,INST_LOB# FROM \"AUDSYS\".\"CLI_SWP$7395268a$1$1\""
],
"id": 109,
"tableName": null,
"createdAt": "2017-02-17T19:07:12.767Z",
"updatedAt": "2017-02-17T19:07:12.767Z",
"datasourceId": 196
}
}
Response Body Example with embedded reference:
The following response includes embedded information on the connection used to import the data.
{
"id": 313,
"size": "35651584",
"path": null,
"isSharedWithAll": false,
"type": "jdbc",
"bucket": null,
"isSchematized": true,
"createdAt": "2017-02-22T23:33:54.400Z",
"updatedAt": "2017-02-22T23:34:18.148Z",
"createdBy": 1,
"updatedBy": 1,
"name": "TestOracleDS",
"description": null,
"connection": {
"id": 7,
"name": "Oracle",
"description": "",
"type": "jdbc",
"createdBy": 1,
"isGlobal": true,
"credentialType": "basic",
"createdAt": "2017-01-11T01:21:54.950Z",
"updatedAt": "2017-01-11T01:22:20.107Z",
"updatedBy": 1
},
"parsingRecipe": {
"id": 645
},
"relationalSource": {
"relationalPath": [
"AUDSYS"
],
"columns": [
"INST#",
"BUCKET#",
"INST_LOB#",
"MAX_SEQ#",
"FLUSH_SCN",
"FLUSH_TIME",
"MIN_SCN",
"MAX_SCN",
"MIN_TIME",
"MAX_TIME",
"SID#",
"SERIAL#",
"STATUS",
"LOG_PIECE"
],
"filter": null,
"raw": null,
"id": 121,
"tableName": "CLI_SWP$7395268a$1$1",
"createdAt": "2017-02-22T23:33:54.406Z",
"updatedAt": "2017-02-22T23:33:54.406Z",
"datasourceId": 313
}
}
Reference
Common Properties:
The following properties are common to file-based and JDBC datasets.
| Property | Description |
|---|---|
| id | Internal identifier of the imported dataset |
| size | Size of the source file in bytes (if applicable) |
| path | For HDFS and S3 file sources, this value defines the path to the source. For JDBC sources, this value is not specified. |
| isSharedWithAll | If true, the source is shared among all users of the platform. |
| type | Identifies where the type of storage where the source is located. Values:
|
| bucket | (If type=s3) Bucket on S3 where source is stored. |
| isSchematized | (If source file is avro, or type=jdbc) If true, schema information is available for the source. |
| createdAt | Timestamp for when the dataset was imported |
| UpdatedAt | Timestamp for when the dataset was last updated |
| createdBy | Internal identifier of the user who created the imported dataset |
| updatedBy | Internal identifier of the user who last updated the imported dataset |
| name | Internal name of the imported dataset |
| description | User-friendly description for the imported dataset |
| connection | Internal identifier of the connection to the server hosting the dataset. If this value is To acquire the entire connection for this dataset, you can use either of the following endpoints: /v3/importedDatasets?embed=connection /v3/importedDatasets/:id?embed=connection For more information, see API Connections Get v3. |
| parsingRecipe | Internal identifier of the recipe that is used to parse the imported dataset for wrangling. |
Hive or Relational Source:
If the source data is from Hive or a relational system (type=jdbc), the following properties contain information on the source table, the imported columns, and any custom SQL filters applied to the table:
| Property | Description |
|---|---|
| relationalPath | Name of the database from which the source was queried. If a custom SQL query has been applied, this value is |
| columns | List of columns imported from the source, pre-filtered. If a custom SQL query has been applied, this value is |
| filter | This value is empty. |
| raw | If custom SQL has been applied to the data source to filter the data before it is imported, all SQL statements are listed. For more information, see Enable Custom SQL Query. |
| id | Internal identifier for the relational source |
| tableName | Name of the table from which the data is extracted. If a custom SQL query has been applied, this value is |
| createdAt | Timestamp for when the source was imported |
| updatedAt | Timestamp for when the source was last updated |
| datasourceId | Internal identifier for the datasource. |
File:
File-based datasets support the common properties only.
This page has no comments.