Consulta uma lista de workflows.
Experimente agora
Testar
Autorização RAM
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ProjectId |
integer |
Não |
O ID do workspace DataWorks. Você pode fazer login no console do DataWorks e acessar a página Workspace para consultar o ID. Você deve especificar este parâmetro ou o parâmetro ProjectIdentifier para identificar o workspace DataWorks ao chamar esta operação. |
10000 |
| ProjectIdentifier |
string |
Não |
O nome do workspace DataWorks. Você pode fazer login no console do DataWorks e acessar a página Workspace para consultar o nome do workspace. Você deve especificar este parâmetro ou o parâmetro ProjectId para identificar o workspace DataWorks ao chamar esta operação. |
dw_project |
| PageNumber |
integer |
Sim |
O número da página solicitada, usado para paginação. |
1 |
| PageSize |
integer |
Sim |
O número de registros por página. Valor padrão: 10. Máximo: 100. |
10 |
| Keyword |
string |
Não |
A palavra-chave, usada para correspondência aproximada de nomes de workflows. |
my |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Respostas. |
||
| HttpStatusCode |
integer |
O código de status HTTP. |
200 |
| ErrorMessage |
string |
A mensagem de erro. |
The connection does not exist. |
| RequestId |
string |
O ID da solicitação. Usado para solução de problemas quando ocorre um erro. |
0000-ABCD-EFG**** |
| ErrorCode |
string |
O código de erro. |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
Indica se a solicitação foi bem-sucedida. |
true |
| Data |
object |
Detalhes dos workflows. |
|
| PageNumber |
integer |
O número da página atual. |
1 |
| PageSize |
integer |
O número de registros na página atual. |
10 |
| TotalCount |
integer |
O número total de registros que atendem às condições de consulta. |
13 |
| Business |
array<object> |
Informações sobre a lista de workflows. |
|
|
object |
Informações sobre a lista de workflows. |
||
| Owner |
string |
The owner of the workflow. |
34824327**** |
| Description |
string |
The description of the workflow. |
test |
| ProjectId |
integer |
The ID of the workspace to which the workflow belongs. |
10000 |
| BusinessId |
integer |
The workflow ID. |
3000001 |
| BusinessName |
string |
The name of the workflow. |
test |
| UseType |
string |
The module to which the workflow belongs. Valid values: NORMAL (Data Studio) and MANUAL_BIZ (Manually Triggered Workflow). |
NORMAL |
Exemplos
Resposta de sucesso
JSON formato
{
"HttpStatusCode": 200,
"ErrorMessage": "The connection does not exist.",
"RequestId": "0000-ABCD-EFG****",
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 13,
"Business": [
{
"Owner": "34824327****",
"Description": "test",
"ProjectId": 10000,
"BusinessId": 3000001,
"BusinessName": "test",
"UseType": "NORMAL"
}
]
}
}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.