Obtém uma lista de pastas.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| PageNumber |
integer |
Não |
O número da página. As páginas começam a partir da página 1. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. Valor padrão: 10. Valor máximo: 100. |
10 |
| ProjectId |
integer |
Sim |
O ID do workspace. |
10001 |
| TenantId |
integer |
Não |
O ID do tenant. Para obter o ID do tenant, execute as seguintes etapas: Faça logon no console do DataWorks. Encontre seu workspace e acesse a página do DataStudio. Na página exibida, clique no nome de usuário de logon no canto superior direito e clique em User Info na seção Menu. |
10002 |
| GroupId |
string |
Não |
O ID do processo de negócios ao qual as pastas pertencem. |
ds_123abc |
| FolderNameKeyword |
string |
Não |
A palavra-chave nos nomes das pastas. A palavra-chave é usada para pesquisar pastas cujos nomes contêm essa palavra-chave. |
Folder name keyword |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
|||
| RequestId |
string |
O ID da solicitação. |
0000-ABCD-EF**** |
| FolderPagingResult |
object |
O resultado paginado das pastas. |
|
| PageNumber |
integer |
O número da página. O valor deste parâmetro é o mesmo que o do parâmetro PageNumber na solicitação. |
1 |
| PageSize |
integer |
O número de entradas por página. Valor padrão: 10. Valor máximo: 100. |
10 |
| TotalCount |
integer |
O número total de entradas retornadas. |
100 |
| Folders |
array<object> |
As pastas. |
|
|
object |
|||
| ParentId |
integer |
The ID of the parent folder. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0. |
0 |
| ModifiedTime |
string |
The time when the folder was last modified. |
2020-09-24T18:37:51+0800 |
| GroupId |
string |
The ID of the business process to which the folder belongs. |
ds_1234 |
| FolderId |
integer |
The folder ID. |
11 |
| FolderName |
string |
The name of the folder. |
test1 |
| ProjectId |
integer |
The workspace ID. |
10001 |
| CreatedTime |
string |
The time when the folder was created. |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
The tenant ID. |
10002 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "0000-ABCD-EF****",
"FolderPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Folders": [
{
"ParentId": 0,
"ModifiedTime": "2020-09-24T18:37:51+0800",
"GroupId": "ds_1234",
"FolderId": 11,
"FolderName": "test1",
"ProjectId": 10001,
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10002
}
]
}
}Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permission, please authorize |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.