Descrição

API genérica para a listagem das opções de parâmetros do SX1 do tipo combo com formato esperado pelo Smart View.

Utilização da API

É necessário ligar a segurança do socket do rest para a utilização dessa api (chave SECURITY=1)

Disponível a partir da lib 20240115.



Restrições

Para o correto funcionamento da api o pergunte (SX1) informado, deverá ter o campo X1_VAR01 preenchido.


API

/api/framework/treports/integratedprovider/v1/options/:optionsId/:paramId

É necessário preencher o pathParam da URL, sendo eles:

PathParamDescrição
optionsId

Nome do grupo de pergunta (X1_GRUPO).

Ex. MTR850

paramId

MV_PAR utilizado (X1_VAR01).

Ex. MV_PAR10


Exemplo de uso

http://localhost:8050/rest/api/framework/treports/integratedprovider/v1/options/MTR850/MV_PAR10

Para manter o mesmo comportamento do pergunte do Protheus, o retorno da api de combo (propriedade key) será numérico.

Retorno da consulta

{
    "data": [
        {
            "key": 1,
            "label": "Sacramentada"
        },
        {
            "key": 2,
            "label": "Suspensa"
        },
        {
            "key": 3,
            "label": "Todas"
        }
    ],
    "nextPageUrl": null
}

  • Sem rótulos