API atual/Referência completa/Mudanças agendadas

Cancelar

Cancela uma mudança agendada ou um lote inteiro que ainda não foi aplicado.

Só mudanças em scheduled podem ser canceladas. As que já foram aplicadas, revertidas, canceladas ou que falharam ficam como estão. Cancelar não desfaz nada: se a mudança já foi aplicada, o valor novo continua valendo.

Cancelar uma mudança

POST/api/v1/admin/scheduled-changes/{id}/cancelAdmin

Cancela uma mudança agendada

Parâmetros de caminho

iduuidobrigatório

Id da mudança.

Exemplo de requisição: uma mudança

bash

curl -X POST "$BASE_URL/api/v1/admin/scheduled-changes/2fe513d8-c5e4-44ce-89c5-4287ea725748/cancel" \
  -H "Authorization: Bearer $TOKEN"

Resposta: uma mudança

200Cancelada

json

{
  "status": "cancelled"
}

Erros: uma mudança

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	Falta um destes privilégios: `manage_catalog`, `manage_layout` ou `manage_content`. Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_catalog"}`
422	Não existe, ou não está mais em `scheduled` (já aplicada, revertida, cancelada ou falhou).	`{"error":"failed","detail":"not cancellable (already applied or missing)"}`

Cancelar um lote

POST/api/v1/admin/scheduled-changes/batch/{batchId}/cancelAdmin

Cancela as mudanças ainda agendadas de um lote

Parâmetros de caminho

batchIduuidobrigatório

batch_id devolvido ao agendar.

Exemplo de requisição: lote

bash

curl -X POST "$BASE_URL/api/v1/admin/scheduled-changes/batch/0d4c8f1a-6b2e-4c9d-9f31-7a5e2b8c0d14/cancel" \
  -H "Authorization: Bearer $TOKEN"

Resposta: lote

200Lote cancelado

json

{
  "cancelled": 2
}

Campos da resposta

cancelledinteger

Quantas mudanças foram canceladas. 0 se o lote não existe ou se nada estava mais em scheduled.

Erros: lote

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	Falta um destes privilégios: `manage_catalog`, `manage_layout` ou `manage_content`. Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_catalog"}`
500	`batchId` não é um UUID válido.	`{"error":"failed","detail":"..."}`

Veja também

Cancelar

Cancela uma mudança agendada ou um lote inteiro que ainda não foi aplicado.

Cancelar uma mudança

POST/api/v1/admin/scheduled-changes/{id}/cancelAdmin

Cancela uma mudança agendada

Parâmetros de caminho

iduuidobrigatório

Id da mudança.

Exemplo de requisição: uma mudança

bash

curl -X POST "$BASE_URL/api/v1/admin/scheduled-changes/2fe513d8-c5e4-44ce-89c5-4287ea725748/cancel" \
  -H "Authorization: Bearer $TOKEN"

Resposta: uma mudança

200Cancelada

json

{
  "status": "cancelled"
}

Erros: uma mudança

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	Falta um destes privilégios: `manage_catalog`, `manage_layout` ou `manage_content`. Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_catalog"}`
422	Não existe, ou não está mais em `scheduled` (já aplicada, revertida, cancelada ou falhou).	`{"error":"failed","detail":"not cancellable (already applied or missing)"}`

Cancelar um lote

POST/api/v1/admin/scheduled-changes/batch/{batchId}/cancelAdmin

Cancela as mudanças ainda agendadas de um lote

Parâmetros de caminho

batchIduuidobrigatório

batch_id devolvido ao agendar.

Exemplo de requisição: lote

bash

curl -X POST "$BASE_URL/api/v1/admin/scheduled-changes/batch/0d4c8f1a-6b2e-4c9d-9f31-7a5e2b8c0d14/cancel" \
  -H "Authorization: Bearer $TOKEN"

Resposta: lote

200Lote cancelado

json

{
  "cancelled": 2
}

Campos da resposta

cancelledinteger

Quantas mudanças foram canceladas. 0 se o lote não existe ou se nada estava mais em scheduled.

Erros: lote

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	Falta um destes privilégios: `manage_catalog`, `manage_layout` ou `manage_content`. Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_catalog"}`
500	`batchId` não é um UUID válido.	`{"error":"failed","detail":"..."}`