Versões comparadas

Chave

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

Descrição:

Retorna uma listagem do alias informado.

Essa API foi criada com base na classe FWAdapterBaseV2, logo ela permite filtros, seleção de campos, paginação e ordenação.


Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasCaracterIndica o alias da tabela que terá seus dados listadosX
FilialFilterLogicalIndica se deve ser feito o filtro da filial ([ALIAS]_FILIAL) - Opcional, tendo seu valor como verdadeiro por padrão.
true
DeletedFilterLogicalIndica se deve ser feito o filtro de campos deletados de forma lógica (D_E_L_E_T_)
true

Exemplos de uso
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15

Exemplos de uso

Sem Formato
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15

Exemplos de uso

Section
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15
Informações
titleExemplos de uso
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15

Exemplos de uso

Card
labelExemplos de uso
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15

Exemplos de uso



Painel
titleExemplos de uso
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15

Exemplos de uso



api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15
Float
sideright
Informações
O JSON retornado tem como chave o nome do campo na tabela, evitando assim problemas com localização.
Essa API efetua validações de privilégios, nível de campo e dados protegidos.



Informações
titleDados protegidos
Caso o usuário que consuma a API não tenha acesso a algum campo, esses campos não são retornados e a propriedade protectedDataFields do JSON de retorno listará tais campos.
Informações
titleNível de campos
Assim como nos dados protegidos, caso o usuário não tenha acesso a um campo, ele não será retornado, sendo listado na propriedade nivelFields do JSON de retorno.

01. DADOS GERAIS

05. ASSUNTOS RELACIONADOS


Templatedocumentos

HTML
<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>