Lists the details of one or more views.
Try it now
Test
RAM authorization
Request syntax
GET /dlf/v1/{catalogId}/databases/{database}/view-details HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| catalogId |
string |
Yes |
The ID of the data catalog. |
clg-paimon-xxx |
| database |
string |
Yes |
The name of the database. |
database_name |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| maxResults |
integer |
No |
The maximum number of records to return in a single request. |
1000 |
| pageToken |
string |
No |
The token for the next page of results. If the response does not include this token, pass an empty string (""). |
"" |
| viewNamePattern |
string |
No |
A pattern to filter view names. |
view% |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
ListViewDetailsResponse |
||
| viewDetails |
array |
A list of views. |
|
| View |
The details of a view. |
||
| nextPageToken |
string |
The token for the next page of results. If null is returned, all results have been retrieved. |
“” |
Examples
Success response
JSON format
{
"viewDetails": [
{
"schema": {
"fields": [
{
"name": "order_id",
"description": "description",
"id": 1,
"type": {
"type": "STRING",
"fields": [
{
"name": "order_id",
"description": "description",
"id": 1,
"type": {
"type": "STRING",
"fields": [
{
"name": "order_id",
"description": "description",
"id": 1,
"type": {
"type": "STRING",
"fields": []
}
}
]
}
}
]
}
}
],
"query": "",
"dialects": {
"key": ""
},
"comment": "",
"options": {
"key": ""
}
},
"owner": "",
"createdAt": 0,
"updatedBy": "",
"createdBy": "",
"name": "",
"id": "",
"updatedAt": 0
}
],
"nextPageToken": "“”"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.