Conditionals

Buscar Condicional do Formulário por ID

get

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

conditionalIdstringObrigatório

ID da condicional

Respostas

200

OK

application/json

idstringOpcional

titlestringOpcional

typestring · enumObrigatórioValores possíveis:

rulestring · enumObrigatórioValores possíveis:

404

Form was not found

application/json

500

An internal server error was thrown

application/json

get

/forms/{formId}/conditionals/{conditionalId}

HTTPcURLJavaScriptPython

GET /api/b2b/forms/{formId}/conditionals/{conditionalId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "title": "text",
  "type": "SHOW_HIDE_FIELD",
  "rule": "ALL",
  "actions": [
    {
      "id": "text",
      "type": "SKIP_PAGE",
      "page": {
        "id": "text"
      },
      "calculation": {
        "formula": "text",
        "target_field_id": "text"
      },
      "fields": [
        "text"
      ]
    }
  ],
  "scenario_groups": [
    {
      "id": "text",
      "label": 1,
      "rule": "ALL",
      "scenarios": [
        {
          "id": "text",
          "state": "NOT_ENDS_WITH",
          "compare_to": "VALUE",
          "value": "text",
          "if_field": "text",
          "target_field": "text"
        }
      ]
    }
  ]
}

Atualizar Condicional do Formulário

put

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

conditionalIdstringObrigatório

ID da condicional

Corpo

application/json

idstringOpcional

titlestringOpcional

typestring · enumObrigatórioValores possíveis:

rulestring · enumObrigatórioValores possíveis:

Respostas

200

OK

application/json

idstringOpcional

titlestringOpcional

typestring · enumObrigatórioValores possíveis:

rulestring · enumObrigatórioValores possíveis:

404

Form Field was not found

application/json

500

An internal server error was thrown

application/json

put

/forms/{formId}/conditionals/{conditionalId}

HTTPcURLJavaScriptPython

PUT /api/b2b/forms/{formId}/conditionals/{conditionalId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 393

{
  "id": "text",
  "title": "text",
  "type": "SHOW_HIDE_FIELD",
  "rule": "ALL",
  "actions": [
    {
      "id": "text",
      "type": "SKIP_PAGE",
      "page": {
        "id": "text"
      },
      "calculation": {
        "formula": "text",
        "target_field_id": "text"
      },
      "fields": [
        "text"
      ]
    }
  ],
  "scenario_groups": [
    {
      "id": "text",
      "label": 1,
      "rule": "ALL",
      "scenarios": [
        {
          "id": "text",
          "state": "NOT_ENDS_WITH",
          "compare_to": "VALUE",
          "value": "text",
          "if_field": "text",
          "target_field": "text"
        }
      ]
    }
  ]
}

{
  "id": "text",
  "title": "text",
  "type": "SHOW_HIDE_FIELD",
  "rule": "ALL",
  "actions": [
    {
      "id": "text",
      "type": "SKIP_PAGE",
      "page": {
        "id": "text"
      },
      "calculation": {
        "formula": "text",
        "target_field_id": "text"
      },
      "fields": [
        "text"
      ]
    }
  ],
  "scenario_groups": [
    {
      "id": "text",
      "label": 1,
      "rule": "ALL",
      "scenarios": [
        {
          "id": "text",
          "state": "NOT_ENDS_WITH",
          "compare_to": "VALUE",
          "value": "text",
          "if_field": "text",
          "target_field": "text"
        }
      ]
    }
  ]
}

Excluir Condicional do Formulário

delete

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

conditionalIdstringObrigatório

ID da condicional

Respostas

204

Form conditional deleted successfully

404

Form field was not found

500

An internal server error was thrown

delete

/forms/{formId}/conditionals/{conditionalId}

HTTPcURLJavaScriptPython

DELETE /api/b2b/forms/{formId}/conditionals/{conditionalId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Listar Condicionais do Formulário

get

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

Parâmetros de consulta

sortstringOpcionalDefault: createdAt

dirstringOpcionalDefault: asc

Respostas

200

Conditionals listed

application/json

idstringOpcional

titlestringOpcional

typestring · enumObrigatórioValores possíveis:

404

Form was not found

application/json

422

A query param was invalid

application/json

500

An internal server error was thrown

application/json

get

/forms/{formId}/conditionals

HTTPcURLJavaScriptPython

GET /api/b2b/forms/{formId}/conditionals HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "title": "text",
    "type": "SHOW_HIDE_FIELD"
  }
]

Criar Condicional do Formulário

post

Autorizações

auth

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulario

Corpo

application/json

titlestringOpcional

typestring · enumObrigatórioValores possíveis:

rulestring · enumObrigatórioValores possíveis:

Respostas

201

Criado

application/json

404

Form was not found

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post

/forms/{formId}/conditionals

HTTPcURLJavaScriptPython

POST /api/b2b/forms/{formId}/conditionals HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "title": "text",
  "type": "SHOW_HIDE_FIELD",
  "rule": "ALL",
  "actions": [
    {
      "type": "SKIP_PAGE",
      "page": {
        "id": "text"
      },
      "calculation": {
        "formula": "text",
        "target_field_id": "text"
      },
      "fields": [
        "text"
      ]
    }
  ],
  "scenario_groups": [
    {
      "label": 1,
      "rule": "ALL",
      "scenarios": [
        {
          "state": "NOT_ENDS_WITH",
          "compare_to": "VALUE",
          "value": "text",
          "if_field": "text",
          "target_field": "text"
        }
      ]
    }
  ]
}

{
  "id": "text",
  "title": "text",
  "type": "SHOW_HIDE_FIELD",
  "rule": "ALL",
  "actions": [
    {
      "id": "text",
      "type": "SKIP_PAGE",
      "page": {
        "id": "text"
      },
      "calculation": {
        "formula": "text",
        "target_field_id": "text"
      },
      "fields": [
        "text"
      ]
    }
  ],
  "scenario_groups": [
    {
      "id": "text",
      "label": 1,
      "rule": "ALL",
      "scenarios": [
        {
          "id": "text",
          "state": "NOT_ENDS_WITH",
          "compare_to": "VALUE",
          "value": "text",
          "if_field": "text",
          "target_field": "text"
        }
      ]
    }
  ]
}