Descartar a escrita guardada

POST

/connectors/{connectorId}/external-writes/{heldWriteId}/discard

curl --request POST \
  --url https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/external-writes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/discard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

• Produção
• Staging

Com o token da prévia, a escrita guardada ou confirmada passa a descartada e não sai mais; a próxima execução que escrever nesse sistema guarda outra para confirmar. Só vale enquanto ela não começou a sair.

Authorizations

• bearer

Parameters

Path Parameters

connectorId

required

Id do conector

string format: uuid

Id do conector

heldWriteId

required

Id da escrita guardada

string format: uuid

Id da escrita guardada

Request Body^required

Media typeapplication/json

object

token

required

O token da prévia; vale 10 minutos e para esse estado da escrita

string

>= 1 characters

Example ^generated

{
  "token": "example"
}

Responses

200

Escrita descartada

Media typeapplication/json

object

id

required

string format: uuid

runId

required

Execução que guardou a escrita

string format: uuid

versionSeq

required

Versão do conector que pediu a escrita

integer

host

required

Sistema que recebe a escrita

string

status

required

Held espera a pessoa; confirmed ainda não saiu; sending saindo; sent saiu; failed pode ter chegado e nunca é repetida; discarded não sai mais

string

Allowed values: held confirmed sending sent failed discarded

method

required

string

url

required

Como o código pediu; segredos aparecem como marcadores

string

query

required

object

key

additional properties

string

headers

required

object

key

additional properties

string

body

required

Corpo com dados pessoais mascarados

string

nullable

heldAt

required

Instante ISO 8601

string format: date-time

confirmedAt

required

Instante ISO 8601

string format: date-time

nullable

confirmedByUserId

required

string

nullable

sentAt

required

Instante ISO 8601

string format: date-time

nullable

responseStatus

required

Status HTTP que o outro sistema respondeu

integer

nullable

failureCode

required

string

nullable

notice

required

Aviso para a pessoa quando a escrita pode ter chegado ao outro sistema

string

nullable

Example

{
  "status": "held"
}

400

Corpo inválido

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

401

Token ausente, inválido ou expirado (connect.unauthorized)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

403

Papel sem acesso ou Connect não liberado (connect.forbidden_role, connect.feature_disabled)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

404

Conector ou escrita guardada de outra loja ou inexistente (connect.connector_not_found, connect.held_write_not_found)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

409

Connect.held_write_decided (já saiu, está saindo, falhou ou foi descartada), connect.held_write_confirmation_refused (prévia vencida, de outro estado ou já usada)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}