Páginas filhas
  • 2. Parâmetros de Entrada

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  • PathParam: o valor faz parte da URL de execução, geralmente utilizados para representar códigos (chave primária).
    Exemplo: http://localhost:8080/logix/companies/01; http://localhost:8080/logix/item/01/ITEMXPTO.

  • QueryString: o valor virá como parâmetro da URL, indicado pelo sufixo ? ou & sempre acompanhado de um nome, comumente utilizado para definir parâmetros de execução.
    Exemplo: http://localhost:8080/logix/item/XX?order=asc&visible=true.

  • PayLoad: o valor virá no cabeçalho da requisição web e não será visível na URL, utilizado para enviar informações em lote ou para conteúdos mais sensíveis.
    Exemplo: http://localhost:8080/logix/item/XX.

    Bloco de código
    POST /logix/item/XX HTTP/1.1
    Content-Type: application/json
    
    {"cod_empresa":"XX", "cod_item":"ITEMXPTO"}

Abaixo será demonstrado como definir cada um destes tipos de parâmetros de entrada na função 4GL de sua API.

Nota
titleTipos de Variáveis

No Para este desenvolvimento de API Logix, alguns tipos de dados 4GL não são suportados como parâmetros de entrada, como:
INTERVAL, DATETIME, ARRAY multidimensionais e RECORD com atributos complexos (RECORD, ARRAY ou ARRAY OF RECORD).

...

.

2.1. PathParam

O PathParam é um valor contido na própria URL da requisição web e é utilizado para definir identificadores. Para definir um parâmetro de entrada na função da API, representando um PathParam, é necessário nomeá-lo com o prefixo _pp_ conforme os exemplos abaixo:

...