Corrigir um registro da quarentena

PATCH

/connectors/{connectorId}/quarantine/{itemId}

curl --request PATCH \
  --url https://api-connect.zoppy.com.br/connectors/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/quarantine/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "values": { "cpf": "12345678909" } }'

• Produção
• Staging

Troca os campos informados do registro; ele volta no próximo reprocesso com os valores novos.

Authorizations

• bearer

Parameters

Path Parameters

connectorId

required

Id do conector

string format: uuid

Id do conector

itemId

required

Id do registro na quarentena

string format: uuid

Id do registro na quarentena

Request Body^required

Media typeapplication/json

object

values

required

Campos do registro a trocar; os outros ficam como estão

object

key

additional properties

Example

{
  "values": {
    "cpf": "12345678909"
  }
}

Responses

200

O registro corrigido

Media typeapplication/json

object

id

required

Id do registro na quarentena

string format: uuid

runId

required

Execução que mandou o registro para cá por último

string format: uuid

slice

required

Fatia dessa execução

integer

versionSeq

required

Versão do conector que recusou

integer

object

required

Objeto do registro (campo object do registro); null quando o registro não diz

string

nullable

externalId

required

Id do registro no sistema de origem (externalId ou id do registro), mascarado; null quando não há

string

nullable

httpStatus

required

Status HTTP da recusa, do registro (httpStatus, status, error.status) ou do motivo; null quando não há

integer

nullable

record

required

O registro, com dados pessoais mascarados

reason

required

O motivo dado pelo conector, mascarado

string

attempts

required

Quantas vezes o mesmo registro voltou para a quarentena

integer

status

required

Situação

string

Allowed values: open resolved discarded

correctedAt

required

Quando uma pessoa corrigiu valores

string format: date-time

nullable

reprocessRunId

required

Reprocesso em andamento que levou o registro

string format: uuid

nullable

resolvedByRunId

required

Reprocesso que resolveu o registro

string format: uuid

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

resolvedAt

required

Quando foi resolvido ou descartado

string format: date-time

nullable

Example

{
  "status": "open"
}

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

Registro não está aberto neste conector

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

{
  "type": "connect.quarantine_item_not_found",
  "title": "Este registro não está mais na quarentena.",
  "status": 404
}

422

O registro não tem campos (connect.quarantine_record_not_object)

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"
  }
}