Queries the information about a collection in Data Map. Collections include categories and data albums.
Operation description
-
DataWorks Professional Edition or a higher edition is required.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Id |
string |
Yes |
The collection ID. |
as78d756asd |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
1AFAE64E-D1BE-432B-A9**** |
| MetaCollection |
object |
The collection details. |
|
| Id |
string |
The collection ID. |
as78d756asd |
| Type |
string |
The collection type. Valid values:
|
Category |
| ParentId |
string |
The parent collection ID. This parameter can be empty. |
4as3dasf654a |
| Name |
string |
The collection name. |
test_category |
| Description |
string |
The collection description. |
test |
| CreateTime |
integer |
The creation time in milliseconds. |
1668568601000 |
| ModifyTime |
integer |
The last modified time in milliseconds. |
1668568601000 |
| CreateUser |
string |
The ID of the creator. |
456789 |
| Administrators |
array |
The list of administrator IDs. Valid only for the album type. The IDs must belong to users in the same tenant. Multiple IDs can be specified. |
|
|
integer |
The ID of the administrator. |
765432 |
Examples
Success response
JSON format
{
"RequestId": "1AFAE64E-D1BE-432B-A9****",
"MetaCollection": {
"Id": "as78d756asd",
"Type": "Category",
"ParentId": "4as3dasf654a",
"Name": "test_category",
"Description": "test",
"CreateTime": 1668568601000,
"ModifyTime": 1668568601000,
"CreateUser": "456789",
"Administrators": [
765432
]
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.