Versões comparadas

Chave

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

...

A API de menu implementa somente o método GET, porém o mesmo aceita dois tipos de assinatura que são:

  • {idcompany}
  • {idcompany}/{parentId}

Onde ID company na linha RM representa a coligada e o parentId representa o ID do Menu que deseja exibir seus filhos.

1.1 - GET

...

...

...

...

Informações
iconfalse
title1.1.1 GetAll
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

Informações
iconfalse
title1.1.2 Order (Asc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?order=name

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?order=-name

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

Informações
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}?{campo}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: custom

Valor: success

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?custom=win

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}?page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?page=1&pageSize=1

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

Informações
iconfalse
title1.1.5 Fields
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}?fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: id, name, custom

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?fields=id,name,custom

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue


...

...

...

Informações
iconfalse
title1.1.1 GetAll
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}/{parentID}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue


...

Informações
titleParâmetros

Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos).

Exemplo 1: ?order=campo1 (Ascendente)

Exemplo 2: ?order=-campo1 (Descendente)

Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ...

Informações
iconfalse
title1.1.2 Order (Asc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{company}/{idparentID}?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?order=name

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
Informações
iconfalse
title1.1.2 Order (Desc)
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}/{parentID}?order=[-]{campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: name

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?order=-name

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

...

Informações
iconfalse
title1.1.3 Filter
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}/{parentID}?{campo}={valor}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: custom

Valor: success

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?custom=win

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

...

Informações
titleParâmetros

Page: Página que será apresentada.

PageSize: Quantidade máxima de registros por página que serão apresentados.

Exemplo: ?page=valor1&pageSize=1

Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão.

Page: 1

PageSize: 20

Informações
iconfalse
title1.1.4 Paginacao
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}/{parentID}?page={valor1}&pageSize={valor2}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?page=1&pageSize=1

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue

...

...

Informações
titleParâmetros

Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado.

Exemplo: ?fields=campo1

Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ...

Informações
iconfalse
title1.1.5 Fields
Expandir
Informações
iconfalse
titleConfiguração

Máscara de Url: http://{domínio}:{porta}/api/glb/v1/menu/{idcompany}/{parentID}?fields={campo}

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Campos: id, name, custom

Url Utilizada: http://localhost:8051/api/glb/v1/menu/1?fields=id,name,custom

Informações
iconfalse
titleExemplo Postman


Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue