Consulta uma lista de coleções no Data Map. As coleções incluem categorias e álbuns de dados.
Descrição da operação
É necessário o DataWorks Professional Edition ou uma edição superior.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| Type |
string |
Sim |
O tipo de coleção. Valores válidos:
|
Category |
| ParentId |
string |
Não |
O ID da coleção pai. |
as78d756asd |
| Name |
string |
Não |
O nome da coleção. Suporta correspondência difusa. |
test |
| Description |
string |
Não |
A descrição da coleção. Suporta correspondência difusa. |
Test collection |
| CreateUser |
string |
Não |
O ID do usuário criador. Válido apenas para tipos de álbum. Valor padrão: o ID do usuário atual. |
123456 |
| Administrator |
string |
Não |
O ID do administrador. Válido apenas para tipos de álbum. Valor padrão: o ID do usuário atual. |
12345 |
| SortBy |
string |
Não |
O campo de ordenação. Valores válidos:
|
Name |
| Order |
string |
Não |
A ordem de classificação. Valores válidos:
|
Asc |
| PageNumber |
integer |
Não |
O número da página. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. Valor padrão: 10. Máximo: 100. |
10 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
A resposta. |
||
| RequestId |
string |
O ID da solicitação. |
E25887B7-XXXX-54A5-9C4F-83A0DE367DDE |
| Data |
object |
Informações de paginação. |
|
| TotalCount |
integer |
O número total de registros. |
10 |
| PageNumber |
integer |
O número da página. |
1 |
| PageSize |
integer |
O número de entradas por página. |
10 |
| MetaCollections |
array<object> |
A lista de coleções. |
|
|
object |
A coleção. |
||
| Name |
string |
The collection name. |
test_category |
| Id |
string |
The collection name. |
7a65sd7aasd |
| ParentId |
string |
The ID of the parent collection. Can be empty. |
as78d756asd |
| Description |
string |
The collection description. |
Test category |
| Type |
string |
The collection type. Valid values:
|
Category |
| CreateUser |
string |
The creator user ID. |
456789 |
| CreateTime |
integer |
The creation time in milliseconds (timestamp). |
1668568601000 |
| ModifyTime |
integer |
The modification time in milliseconds (timestamp). |
1668568601000 |
| Administrators |
array |
The list of administrator IDs. Supported only for album types. Administrators must be users within the same tenant. Multiple administrators can be specified. |
|
|
string |
The administrator ID. |
765432 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "E25887B7-XXXX-54A5-9C4F-83A0DE367DDE",
"Data": {
"TotalCount": 10,
"PageNumber": 1,
"PageSize": 10,
"MetaCollections": [
{
"Name": "test_category",
"Id": "7a65sd7aasd",
"ParentId": "as78d756asd",
"Description": "Test category",
"Type": "Category",
"CreateUser": "456789",
"CreateTime": 1668568601000,
"ModifyTime": 1668568601000,
"Administrators": [
"765432"
]
}
]
}
}
Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.