Cancele uma ordem de serviço com cancelamento padrão, próxima iteração ou reprogramação em uma nova OS.
Por meio desta API, é possível cancelar uma Ordem de Trabalho. Ela suporta três tipos de cancelamento: padrão, levar para a próxima iteração e reprogramar em uma nova OT.
Este serviço web faz parte do add-on APIS AVANÇADAS.
:folio = Número do fólio ou da OT a cancelar.
Parâmetros de entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folio | Texto | Sim* | Código da OT. |
user_code | Texto | Sim | Código do recurso humano que atualizará a OT no Fracttal. |
work_orders_status_cancel | Texto | Sim | Motivo do cancelamento. |
note | Texto | Sim | Nota onde se indica por que a OT está sendo cancelada. |
id_work_order | Número | Não* | Id da OT. Este id é opcional; só é obrigatório quando o fólio não é indicado. |
cancellation_type | Número | Não (padrão: 1) | Tipo de cancelamento. 1 = Cancelar OT, 2 = Cancelar e levar para a próxima iteração, 3 = Cancelar e reprogramar em uma nova OT. |
id_reschedule_cause | Número | Condicional† | Id do motivo de reprogramação. Obrigatório quando cancellation_type é 2 ou 3. |
reschedule_note | Texto | Não | Nota de reprogramação. Aplica-se a cancellation_type 2 ou 3. |
id_assigned_user | Número | Condicional† | Id do responsável pela nova OT. Obrigatório quando cancellation_type é 3. |
tasks | Array | Não | Lista de tarefas a incluir no cancelamento avançado. Aplica-se a cancellation_type 2 ou 3. Veja a estrutura na seção Tasks. |
utc_min | Número | Não | Offset UTC em minutos. |
type_user | Texto | Não | Tipo de usuário. Valor padrão: HUMAN_RESOURCES. |
reschedule_cause | Texto | Não | Descrição textual da causa de reprogramação do catálogo auxiliar. Aplica-se a regra de precedência quando reschedule_cause e id_reschedule_cause são enviados simultaneamente. |
folioeid_work_ordersão mutuamente excludentes; é necessário enviar pelo menos um.
† Condicional: obrigatório de acordo com o valor de cancellation_type. Veja a tabela de comportamento.
Tasks
Estrutura de cada objeto dentro do array tasks:
| Parâmetro | Tipo | Descrição |
|---|---|---|
id_task | Número | Id da tarefa. |
id_item | Número | Id do ativo associado à tarefa. |
date_maintenance | Data | Data de manutenção da tarefa. |
Tipos de cancelamento
| cancellation_type | Comportamento |
|---|---|
1 (padrão) | Cancela a OT. As tarefas mantêm sua programação atual. Comportamento retrocompatível; equivale a omitir o parâmetro. |
2 | Cancela a OT e reprograma as tarefas para a próxima iteração. As tarefas planejadas por ativador de data avançam a data calculada e programada. As não planejadas mantêm as mesmas datas. Requer id_reschedule_cause. |
3 | Cancela a OT e cria uma nova OT com a mesma tarefa. Requer id_reschedule_cause e id_responsible. |
Parâmetros de saída
| Parâmetro | Tipo | Descrição |
|---|---|---|
id | Número | Id da tarefa na ordem de trabalho |
id_group_task | Número | Id do plano de tarefas onde se encontra a tarefa da qual se obterá a informação |
id_request | Número | Id da solicitação, se a tarefa provém de uma solicitação |
id_item_log | Número | Id do item log associado à tarefa |
id_task_log | Número | Id interno do log de tarefas |
id_tasks_todo | Número | Id interno de tarefas pendentes |
id_task_trigger | Número | Id interno do ativador da tarefa |
id_task | Número | Id da tarefa da qual se obterá a informação para criar a OT |
id_item | Número | Id do ativo |
id_items_availability | Número | Id de registro do fora de serviço |
items_log_description | Texto | Descrição do ativo |
task_description | Texto | Descrição da tarefa |
Exemplo
Cancelamento padrão — cancellation_type omitido (retrocompatível)
cancellation_type omitido (retrocompatível)Requisição: (PUT)https://app.fracttal.com/api/work_order_cancel?folio=OT-1896
{
"user_code": "AQOP1521",
"work_orders_status_cancel": "Erro na geração da OT",
"note": "OT Duplicada"
}{
"success": true,
"message": "200",
"data": {
"id": 16954494,
"id_group_task": null,
"id_request": null,
"id_item_log": 3696049,
"id_task_log": 5683844,
"id_tasks_todo": 16740135,
"id_task_trigger": null,
"id_task": 5911238,
"id_item": 1,
"id_items_availability": null,
"items_log_description": "{ CORP-256 } EMPRESA SECTOR MANUFACTURA AVDA INTERNACIONAL ",
"task_description": "OT Duplicada"
},
"total": 1
}Cancelar e levar para a próxima iteração — cancellation_type: 2
cancellation_type: 2Requisição: (PUT)https://app.fracttal.com/api/work_order_cancel?folio=OT-1896
{
"user_code": "AQOP1521",
"work_orders_status_cancel": "Manutenção reprogramada",
"note": "É reprogramada para a próxima iteração de acordo com a frequência",
"cancellation_type": 2,
"reschedule_cause": "Se reprograma para nueva fecha",
"reschedule_note": "Equipamento não disponível na data programada"
}{
"success": true,
"message": "200",
"data": [
{
"id": 16954495,
"id_group_task": null,
"id_request": null,
"id_item_log": 3696050,
"id_task_log": 5683845,
"id_tasks_todo": 16740136,
"id_task_trigger": null,
"id_task": 5911238,
"id_item": 1,
"id_items_availability": null,
"items_log_description": "{ CORP-256 } EMPRESA SECTOR MANUFACTURA AVDA INTERNACIONAL ",
"task_description": "Manutenção reprogramada"
}
],
"total": 1
}Cancelar e reprogramar em uma nova OT — cancellation_type: 3
cancellation_type: 3Requisição: (PUT)https://app.fracttal.com/api/work_order_cancel?folio=OT-1896
{
"user_code": "AQOP1521",
"work_orders_status_cancel": "OT requiere reprogramación",
"note": "Se genera nueva OT con la misma tarea",
"cancellation_type": 3,
"id_reschedule_cause": 5,
"reschedule_note": "Nueva fecha acordada con cliente",
"type_user": "HUMNA_RESOURCES",
"id_assigned_user": 1234,
"tasks": [
{
"id_task": 5911238,
"id_item": 1,
"data_maintenance": "2026-08-10T18:00:00-05:00"
}
]
}{
"success": true,
"message": "200",
"data": {
"work_order_id": 16954496,
"cancellation_type": 3,
"new_work_order": {
"id":123,
"wo_folio":"WO-123",
"id_status_work_order":0
}
},
"total": 1
} 200