Pular para o conteúdo
Zoppy ConnectZoppy ConnectZoppy Connect

Ensaiar a versão em edição

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

Abre um ensaio (dry_run) da versão mais nova: lê de verdade, inclusive no banco local; as escritas não saem e aparecem em plannedRequests. A amostra lê a primeira fatia e, se cortada, marca needsFullRehearsal; o completo lê a origem inteira, que publicar exige.

Authorizations

Seção intitulada “Authorizations”

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
connectorId
required

Id do conector

string format: uuid

Id do conector

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
scope

Sample lê só a primeira fatia; full lê a origem inteira, que publicar exige

string
default: sample
Allowed values: sample full

Responses

Seção intitulada “Responses”

202

Seção intitulada “202”

Ensaio aberto

Media typeapplication/json
object
runId
required

Id da execução do ensaio; acompanhe em GET /connectors/{connectorId}/runs/{runId}

string format: uuid
connectorId
required

Id do conector

string format: uuid
versionSeq
required

Versão em edição que o ensaio roda

integer
scope
required

Escopo do ensaio

string
Allowed values: sample full

Example 

{
  "scope": "sample"
}

401

Seção intitulada “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

Seção intitulada “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

Seção intitulada “404”

Conector não existe nesta loja (connect.connector_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

Seção intitulada “409”

Host esperando aprovação (connect.hosts_awaiting_approval), segredo ou acesso à Zoppy faltando (connect.access_incomplete), outra execução em andamento (connect.run_in_progress) ou conector sem versão (connect.connector_without_version)

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.hosts_awaiting_approval",
  "title": "Aprove estes hosts antes de ensaiar: api.erp.com.br",
  "status": 409
}

423

Seção intitulada “423”

Conector ou loja em pausa de emergência (connect.paused)

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