Previews the content of a specified dataset version. Currently only text file preview is supported for OSS-type datasets. Supported MIME types 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
string |
Yes |
The dataset version ID |
dataworks-datasetVersion:3pXXXb8o0ngr07njhps1 :2 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
A6C6B486-E3A2-5D52-9E76-D9380485DXXX |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| PreviewResult |
object |
Preview results |
|
| SupportPreview |
boolean |
Preview availability |
true |
| MimeType |
string |
The MIME type |
text/plain |
| FileName |
string |
File name |
parth/data.csv |
| Content |
string |
Content |
this is content |
Examples
Success response
JSON format
{
"RequestId": "A6C6B486-E3A2-5D52-9E76-D9380485DXXX",
"Success": true,
"PreviewResult": {
"SupportPreview": true,
"MimeType": "text/plain",
"FileName": "parth/data.csv",
"Content": "this is content"
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.