Atualizar
PUT https://.account-name.krzlabs.io/api/v1/workflows/:id
Realiza a atualização de um workflow.
Path Params
id string required
ID do workflow.
Body Params
| Field | Type | Description | Optional | Searchable |
|---|---|---|---|---|
| filters | object | Filtros aplicados ao workflow. Exemplo de estrutura: all (boolean) que indica se aplica a todos os casos. | not required | false |
| steps | array(object) | Array de objetos representando os passos do workflow. | not required | false |
| code | string | Código único que identifica o workflow. | required | true |
| name | string | Nome do workflow. | required | true |
| description | string | Descrição detalhada do workflow, explicando seu propósito e características. | not required | false |
| tags | array(string) | Lista de tags que classificam ou identificam o workflow. | not required | false |
| enabled | boolean | Indica se o workflow está habilitado (true) ou desabilitado (false). | required | false |
| default | boolean | Indica se este é o workflow padrão. Valor padrão é true se não informado. | not required | false |
Exemplo em JSON
{
"filters": {},
"steps": [
{
"name": "Example Step",
"code": "STEP001",
"description": "This is a step",
"allocation_time": 10,
"users_groups": [
{
"source_id": "SRC123",
"name": "Group A",
"description": "Main group",
"has_full_product_access": true,
"users": [
{
"id": "64bfc2f21a7b8e001f9d1234",
"name": "John Doe",
"roles": ["admin", "editor"]
}
]
}
],
"users": [
{
"id": "64bfc2f21a7b8e001f9d5678",
"name": "Jane Smith"
}
],
"status": [
{
"_id": "64bfc2f21a7b8e001f9d9999",
"code": "ST001",
"name": "Approved",
"color": "#00FF00",
"tags": ["done", "success"],
"notify": true,
"enabled": true,
"outcome": "success"
}
],
"scopes": ["scope1", "scope2"],
"locker": false,
"editable": true
}
],
"code": "WF001",
"name": "Example Workflow",
"description": "Workflow description",
"tags": ["tag1", "tag2"],
"enabled": true,
"default": false
}
Response
Resposta de sucesso
200
| Field | Type | Description | Optional | Searchable |
|---|---|---|---|---|
| filters | object | Filtros aplicados ao workflow. Exemplo de estrutura: all (boolean) que indica se aplica a todos os casos. | not required | false |
| steps | array(object) | Array de objetos representando os passos do workflow. | not required | false |
| code | string | Código único que identifica o workflow. | required | true |
| name | string | Nome do workflow. | required | true |
| description | string | Descrição detalhada do workflow, explicando seu propósito e características. | not required | false |
| tags | array(string) | Lista de tags que classificam ou identificam o workflow. | not required | false |
| enabled | boolean | Indica se o workflow está habilitado (true) ou desabilitado (false). | required | false |
| default | boolean | Indica se este é o workflow padrão. Valor padrão é true se não informado. | not required | false |
Resposta de erro
400
| Field | Type | Description |
|---|---|---|
| code | Number | Código da resposta http |
| kind | String | Tipo de mensagem |
| name | String | Nome da exceção lançada pela plataforma |
| title | String | Titulo do erro lançado pela plataforma |
| message | String | Mensagem indicando o probloma ocorrido |
| solution | String | Mensagem indicando uma possível solução para o problema |
Copyright © 2025 kruzer | All Rights Reserved