Sumário

...

Índice

indent	10
exclude	Sumário

Objetivo

...

Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.

1 - Métodos

...

A 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

...

1.1.1 -

...

Get (Retorna todos os módulos do RM que o usuário autenticado possui permissão na coligada informada

...

no parâmetro company)

Informações

icon	false
title	1.1.1 GetAllGet

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/glbframework/v1/menu/{id}menus

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Url Utilizada: http://localhost:8051/api/glbframework/v1/menu/1menus

Informações

icon	false
title	Exemplo Postman

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

title	Parâ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 ...

...

icon	false
title	1.1.2 Order (Asc)

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

{
"hasNext": true,
"menuItems": [
{
"id": "86624781592fa5e5dd649b57e1667df6",
"name": "Gestão de Custos",
"type": "group",
"custom": "Win"
},
{
"id": "6edb6b19adc2b967dcb6d225c5c089a8",
"name": "Integração",
"type": "group",
"custom": "Win"
},
{
"id": "2050d813014fc487ffead38ca1e49cdc",
"name": "Inteligência de Negócios",
"type": "group",
"custom": "Win"
},
{
"id": "b9982a14ccfb3d6c4b6a4e0406ea489a",
"name": "Serviços Globais",
"type": "group",
"custom": "Win"
},
{
"id": "7e128ef49d72932b49b6db15f2d24be3",
"name": "Serviços Globais",
"type": "group",
"custom": "Web"
},
{
"id": "8298bc939bc4a95a9c24f333cbdd6f35",
"name": "Gestão do Relacionamento com o Cliente",
"type": "group",
"custom": "Win"
},
{
"id": "f8811f490807addb6daa7c4de40ee4ac",
"name": "Gestão do Relacionamento com o Cliente",
"type": "group",
"custom": "Web"
},
{
"id": "394af69d94b0fe68f64ec7b61d211755",
"name": "Manutenção",
"type": "group",
"custom": "Win"
},
{
"id": "9b6531bd8da28ae8be6c2923d6c01114",
"name": "Gestão de Conteúdos",
"type": "group",
"custom": "Win"
},
{
"id": "6c4bd975a84afc3a7dc545ce1581fe5e",
"name": "Gestão de Conteúdos",
"type": "group",
"custom": "Web"
},
{
"id": "66c488e81895984a5de7be84067eb6a9",
"name": "Gestão Contábil",
"type": "group",
"custom": "Win"
},
{
"id": "0161f316970640a6bd3f8a53e6bd2561",
"name": "Gestão Fiscal",
"type": "group",
"custom": "Win"
},
{
"id": "1c8647a41151692197750531401956a6",
"name": "Gestão Financeira",
"type": "group",
"custom": "Win"
},
{
"id": "49512246df92fb8a5cddbc077df8b4b8",
"name": "Gestão Financeira",
"type": "group",
"custom": "Web"
},
{
"id": "ddc3337f62a6a45bcd0fd17d91996803",
"name": "Gestão de Estoque, Compras e Faturamento",
"type": "group",
"custom": "Win"
},
{
"id": "a25693005f36a69794a7acd9191c7ba1",
"name": "Gestão de Estoque, Compras e Faturamento",
"type": "group",
"custom": "Web"
},
{
"id": "d271f243a7d25db027ccf084ec91ced2",
"name": "Avaliação e Pesquisa",
"type": "group",
"custom": "Win"
},
{
"id": "7b5d93e8c314cd59ca8826b1c7ec2bc2",
"name": "Gestão Bibliotecária",
"type": "group",
"custom": "Win"
},
{
"id": "48513a97e0ff8ad23d541d07c471dbf0",
"name": "Gestão Bibliotecária",
"type": "group",
"custom": "Web"
},
{
"id": "8a554e97d5021b84e6d5d07b4568a348",
"name": "Educacional",
"type": "group",
"custom": "Win"
}
]
}

1.1.2 - Order(Resultado Ordenado)

Informações

title	Parâ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

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

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

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

...

icon	false
title	1.1.2 Order (Desc)

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

icon	false
title	1.1.3 Filter

Postman

Expandir

Domínio: localhost

Porta: 8051

Campo: custom

Valor: success

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

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Informações

icon	false
title	Exemplo

de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Campo: name

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/menus?order=name

Informações

icon

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

title	Parâ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

...

icon	false
title	1.1.4 Paginacao

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

{
    "hasNext": true,
    "menuItems": [
        {
            "id": "d271f243a7d25db027ccf084ec91ced2",
            "name": "Avaliação e Pesquisa",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "8a554e97d5021b84e6d5d07b4568a348",
            "name": "Educacional",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "7b5d93e8c314cd59ca8826b1c7ec2bc2",
            "name": "Gestão Bibliotecária",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "48513a97e0ff8ad23d541d07c471dbf0",
            "name": "Gestão Bibliotecária",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "66c488e81895984a5de7be84067eb6a9",
            "name": "Gestão Contábil",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "9b6531bd8da28ae8be6c2923d6c01114",
            "name": "Gestão de Conteúdos",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6c4bd975a84afc3a7dc545ce1581fe5e",
            "name": "Gestão de Conteúdos",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "86624781592fa5e5dd649b57e1667df6",
            "name": "Gestão de Custos",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "ddc3337f62a6a45bcd0fd17d91996803",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a25693005f36a69794a7acd9191c7ba1",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "8298bc939bc4a95a9c24f333cbdd6f35",
            "name": "Gestão do Relacionamento com o Cliente",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "f8811f490807addb6daa7c4de40ee4ac",
            "name": "Gestão do Relacionamento com o Cliente",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "1c8647a41151692197750531401956a6",
            "name": "Gestão Financeira",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "49512246df92fb8a5cddbc077df8b4b8",
            "name": "Gestão Financeira",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "0161f316970640a6bd3f8a53e6bd2561",
            "name": "Gestão Fiscal",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6edb6b19adc2b967dcb6d225c5c089a8",
            "name": "Integração",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "2050d813014fc487ffead38ca1e49cdc",
            "name": "Inteligência de Negócios",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "394af69d94b0fe68f64ec7b61d211755",
            "name": "Manutenção",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "b9982a14ccfb3d6c4b6a4e0406ea489a",
            "name": "Serviços Globais",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "7e128ef49d72932b49b6db15f2d24be3",
            "name": "Serviços Globais",
            "type": "group",
            "custom": "Web"
        }
    ]
}

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Campo: name

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/framework/v1/menus?order=-name

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "menuItems": [
        {
            "id": "b9982a14ccfb3d6c4b6a4e0406ea489a",
            "name": "Serviços Globais",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "7e128ef49d72932b49b6db15f2d24be3",
            "name": "Serviços Globais",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "394af69d94b0fe68f64ec7b61d211755",
            "name": "Manutenção",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "2050d813014fc487ffead38ca1e49cdc",
            "name": "Inteligência de Negócios",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6edb6b19adc2b967dcb6d225c5c089a8",
            "name": "Integração",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "0161f316970640a6bd3f8a53e6bd2561",
            "name": "Gestão Fiscal",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "1c8647a41151692197750531401956a6",
            "name": "Gestão Financeira",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "49512246df92fb8a5cddbc077df8b4b8",
            "name": "Gestão Financeira",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "8298bc939bc4a95a9c24f333cbdd6f35",
            "name": "Gestão do Relacionamento com o Cliente",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "f8811f490807addb6daa7c4de40ee4ac",
            "name": "Gestão do Relacionamento com o Cliente",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "ddc3337f62a6a45bcd0fd17d91996803",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a25693005f36a69794a7acd9191c7ba1",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "86624781592fa5e5dd649b57e1667df6",
            "name": "Gestão de Custos",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "9b6531bd8da28ae8be6c2923d6c01114",
            "name": "Gestão de Conteúdos",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6c4bd975a84afc3a7dc545ce1581fe5e",
            "name": "Gestão de Conteúdos",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "66c488e81895984a5de7be84067eb6a9",
            "name": "Gestão Contábil",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "7b5d93e8c314cd59ca8826b1c7ec2bc2",
            "name": "Gestão Bibliotecária",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "48513a97e0ff8ad23d541d07c471dbf0",
            "name": "Gestão Bibliotecária",
            "type": "group",
            "custom": "Web"
        },
        {
            "id": "8a554e97d5021b84e6d5d07b4568a348",
            "name": "Educacional",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "d271f243a7d25db027ccf084ec91ced2",
            "name": "Avaliação e Pesquisa",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.1.3 - Filter (Resultado filtrado)

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Campo: custom

Valor: win

Url Utilizada: http://localhost:8051/api/framework/v1/menus?custom=win

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)

{
    "hasNext": true,
    "menuItems": [
        {
            "id": "86624781592fa5e5dd649b57e1667df6",
            "name": "Gestão de Custos",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6edb6b19adc2b967dcb6d225c5c089a8",
            "name": "Integração",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "2050d813014fc487ffead38ca1e49cdc",
            "name": "Inteligência de Negócios",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "b9982a14ccfb3d6c4b6a4e0406ea489a",
            "name": "Serviços Globais",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "8298bc939bc4a95a9c24f333cbdd6f35",
            "name": "Gestão do Relacionamento com o Cliente",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "394af69d94b0fe68f64ec7b61d211755",
            "name": "Manutenção",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "9b6531bd8da28ae8be6c2923d6c01114",
            "name": "Gestão de Conteúdos",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "66c488e81895984a5de7be84067eb6a9",
            "name": "Gestão Contábil",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "0161f316970640a6bd3f8a53e6bd2561",
            "name": "Gestão Fiscal",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "1c8647a41151692197750531401956a6",
            "name": "Gestão Financeira",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "ddc3337f62a6a45bcd0fd17d91996803",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "d271f243a7d25db027ccf084ec91ced2",
            "name": "Avaliação e Pesquisa",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "7b5d93e8c314cd59ca8826b1c7ec2bc2",
            "name": "Gestão Bibliotecária",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "8a554e97d5021b84e6d5d07b4568a348",
            "name": "Educacional",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "07623c5fc17a50e4efac41da20889477",
            "name": "Processo Seletivo",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a6b7f54b809d6225f404711012e98b23",
            "name": "ETO – Engenharia sob encomenda",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a5e5f32b20798ca459c530fdbf194562",
            "name": "Incorporação",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "b806cabd39ead28f46dbb9ef06185bb1",
            "name": "Automação de Ponto",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "3e3bd1c4994e48eda17d5ef86a873062",
            "name": "Folha de Pagamento",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "5f069608609ccac95b3b75b2bc7e35d8",
            "name": "Gestão de Pessoas",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.1.4 - Paginação

Informações

title	Parâ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

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/framework/v1/menus?page=1&pageSize=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "menuItems": [
        {
            "id": "86624781592fa5e5dd649b57e1667df6",
            "name": "Gestão de Custos",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.1.5 - Fields (Retorno de campos específicos no resultado)

Informações

title	Parâ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

icon	false
title	1.1.5 Fields

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

Campos: id, name, custom

Url Utilizada: http://localhost:8051/api/framework/v1/menus?fields=id,name,custom

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "menuItems": [
        {
            "id": "86624781592fa5e5dd649b57e1667df6",
            "name": "Gestão de Custos",
            "custom": "Win"
        },
        {
            "id": "6edb6b19adc2b967dcb6d225c5c089a8",
            "name": "Integração",
            "custom": "Win"
        },
        {
            "id": "2050d813014fc487ffead38ca1e49cdc",
            "name": "Inteligência de Negócios",
            "custom": "Win"
        },
        {
            "id": "b9982a14ccfb3d6c4b6a4e0406ea489a",
            "name": "Serviços Globais",
            "custom": "Win"
        },
        {
            "id": "7e128ef49d72932b49b6db15f2d24be3",
            "name": "Serviços Globais",
            "custom": "Web"
        },
        {
            "id": "8298bc939bc4a95a9c24f333cbdd6f35",
            "name": "Gestão do Relacionamento com o Cliente",
            "custom": "Win"
        },
        {
            "id": "f8811f490807addb6daa7c4de40ee4ac",
            "name": "Gestão do Relacionamento com o Cliente",
            "custom": "Web"
        },
        {
            "id": "394af69d94b0fe68f64ec7b61d211755",
            "name": "Manutenção",
            "custom": "Win"
        },
        {
            "id": "9b6531bd8da28ae8be6c2923d6c01114",
            "name": "Gestão de Conteúdos",
            "custom": "Win"
        },
        {
            "id": "6c4bd975a84afc3a7dc545ce1581fe5e",
            "name": "Gestão de Conteúdos",
            "custom": "Web"
        },
        {
            "id": "66c488e81895984a5de7be84067eb6a9",
            "name": "Gestão Contábil",
            "custom": "Win"
        },
        {
            "id": "0161f316970640a6bd3f8a53e6bd2561",
            "name": "Gestão Fiscal",
            "custom": "Win"
        },
        {
            "id": "1c8647a41151692197750531401956a6",
            "name": "Gestão Financeira",
            "custom": "Win"
        },
        {
            "id": "49512246df92fb8a5cddbc077df8b4b8",
            "name": "Gestão Financeira",
            "custom": "Web"
        },
        {
            "id": "ddc3337f62a6a45bcd0fd17d91996803",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "custom": "Win"
        },
        {
            "id": "a25693005f36a69794a7acd9191c7ba1",
            "name": "Gestão de Estoque, Compras e Faturamento",
            "custom": "Web"
        },
        {
            "id": "d271f243a7d25db027ccf084ec91ced2",
            "name": "Avaliação e Pesquisa",
            "custom": "Win"
        },
        {
            "id": "7b5d93e8c314cd59ca8826b1c7ec2bc2",
            "name": "Gestão Bibliotecária",
            "custom": "Win"
        },
        {
            "id": "48513a97e0ff8ad23d541d07c471dbf0",
            "name": "Gestão Bibliotecária",
            "custom": "Web"
        },
        {
            "id": "8a554e97d5021b84e6d5d07b4568a348",
            "name": "Educacional",
            "custom": "Win"
        }
    ]
}

1.2 - GET {companyId}

...

1.2.1 - Get (Retorna o primeiro nível dos menus filhos que o usuário autenticado possui permissão na coligada informada no parâmetro company, referentes ao menu informado no parâmetro parentID)

Informações

icon	false
title	1.1.1 Get

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/menus/{parentID}?companyId={CompanyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

ParentID: b9982a14ccfb3d6c4b6a4e0406ea489a

Url Utilizada: http://localhost:8051/api/framework/v1/menus/b9982a14ccfb3d6c4b6a4e0406ea489a?companyId=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "menuItems": [
        {
            "id": "192bbdce1d8b6cdba6f9ae13ab228316",
            "name": "Administração",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "926242551cb81a01bbaa2ef50a059734",
            "name": "Segurança",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "f4fdfcda14f1cbeccdd6d78fd334850e",
            "name": "Serviços",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "d767aa643f127acd858d1e8e112204fe",
            "name": "Metadados",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a439ff1157644051effe9f5ae680842a",
            "name": "Customização",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6dda92a05dbf0d7cb048cbd5e68bab19",
            "name": "Gestão",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "4c72d7984f7046f4ac4c89db134e4dbf",
            "name": "Ambiente",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.2.2 - Order(Resultado Ordenado)

Informações

title	Parâ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

icon	false
title	1.1.2 Order (Asc)

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/menus/{parentID}?order=[-]{campo}&{companyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

ParentID: b9982a14ccfb3d6c4b6a4e0406ea489a

Campo: name

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/menus/b9982a14ccfb3d6c4b6a4e0406ea489a?order=name&companyId=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "menuItems": [
        {
            "id": "192bbdce1d8b6cdba6f9ae13ab228316",
            "name": "Administração",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "4c72d7984f7046f4ac4c89db134e4dbf",
            "name": "Ambiente",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a439ff1157644051effe9f5ae680842a",
            "name": "Customização",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6dda92a05dbf0d7cb048cbd5e68bab19",
            "name": "Gestão",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "d767aa643f127acd858d1e8e112204fe",
            "name": "Metadados",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "926242551cb81a01bbaa2ef50a059734",
            "name": "Segurança",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "f4fdfcda14f1cbeccdd6d78fd334850e",
            "name": "Serviços",
            "type": "group",
            "custom": "Win"
        }
    ]
}

Informações

icon	false
title	1.1.2 Order (Desc)

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/menus/{parentID}?order=[-]{campo}&/{companyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

ParentID: b9982a14ccfb3d6c4b6a4e0406ea489a

Campo: name

Tipo de Ordenação: Descendente

Url Utilizada: http://localhost:8051/api/framework/v1/menus/b9982a14ccfb3d6c4b6a4e0406ea489a?order=-name&companyId=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "menuItems": [
        {
            "id": "f4fdfcda14f1cbeccdd6d78fd334850e",
            "name": "Serviços",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "926242551cb81a01bbaa2ef50a059734",
            "name": "Segurança",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "d767aa643f127acd858d1e8e112204fe",
            "name": "Metadados",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6dda92a05dbf0d7cb048cbd5e68bab19",
            "name": "Gestão",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a439ff1157644051effe9f5ae680842a",
            "name": "Customização",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "4c72d7984f7046f4ac4c89db134e4dbf",
            "name": "Ambiente",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "192bbdce1d8b6cdba6f9ae13ab228316",
            "name": "Administração",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.2.3 - Filter (Resultado filtrado)

Informações

icon	false
title	1.1.3 Filter

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/menus/{parentID}?{campo}={valor}&/{companyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

ParentID: b9982a14ccfb3d6c4b6a4e0406ea489a

Campo: custom

Valor: success

Url Utilizada: http://localhost:8051/api/framework/v1/menus/b9982a14ccfb3d6c4b6a4e0406ea489a?custom=win&/companyId=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "menuItems": [
        {
            "id": "192bbdce1d8b6cdba6f9ae13ab228316",
            "name": "Administração",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "926242551cb81a01bbaa2ef50a059734",
            "name": "Segurança",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "f4fdfcda14f1cbeccdd6d78fd334850e",
            "name": "Serviços",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "d767aa643f127acd858d1e8e112204fe",
            "name": "Metadados",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "a439ff1157644051effe9f5ae680842a",
            "name": "Customização",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "6dda92a05dbf0d7cb048cbd5e68bab19",
            "name": "Gestão",
            "type": "group",
            "custom": "Win"
        },
        {
            "id": "4c72d7984f7046f4ac4c89db134e4dbf",
            "name": "Ambiente",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.2.4 - Paginação

Informações

title	Parâ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

icon	false
title	1.1.4 Paginacao

Expandir

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

ParentID: b9982a14ccfb3d6c4b6a4e0406ea489a

Valor1: 1

Valor2: 1

Url Utilizada: http://localhost:8051/api/framework/v1/menus/b9982a14ccfb3d6c4b6a4e0406ea489a?page=1&pageSize=1&companyId=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": true,
    "menuItems": [
        {
            "id": "192bbdce1d8b6cdba6f9ae13ab228316",
            "name": "Administração",
            "type": "group",
            "custom": "Win"
        }
    ]
}

1.2.5 - Fields (Retorno de campos específicos no resultado)

Informações

title	Parâ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

icon	false
title	1.1.5 Fields

Expandir

Informações

icon	false
title	Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/menus/{parentID}?fields={campo}/{companyId}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Company: 1

ParentID: b9982a14ccfb3d6c4b6a4e0406ea489a

Campos: id, name, custom

Url Utilizada: http://localhost:8051/api/framework/v1/menus/b9982a14ccfb3d6c4b6a4e0406ea489a?fields=id,name,custom&companyId=1

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

{
    "hasNext": false,
    "menuItems": [
        {
            "id": "192bbdce1d8b6cdba6f9ae13ab228316",
            "name": "Administração",
            "custom": "Win"
        },
        {
            "id": "926242551cb81a01bbaa2ef50a059734",
            "name": "Segurança",
            "custom": "Win"
        },
        {
            "id": "f4fdfcda14f1cbeccdd6d78fd334850e",
            "name": "Serviços",
            "custom": "Win"
        },
        {
            "id": "d767aa643f127acd858d1e8e112204fe",
            "name": "Metadados",
            "custom": "Win"
        },
        {
            "id": "a439ff1157644051effe9f5ae680842a",
            "name": "Customização",
            "custom": "Win"
        },
        {
            "id": "6dda92a05dbf0d7cb048cbd5e68bab19",
            "name": "Gestão",
            "custom": "Win"
        },
        {
            "id": "4c72d7984f7046f4ac4c89db134e4dbf",
            "name": "Ambiente",
            "custom": "Win"
        }
    ]
}

1.2.6 - Desabilitar uso do OData e selecionar Tags

Informações

title	Parâmetros

DisableODataFilter: esse parâmetro tem a finalidade de desativar o recurso de OData da API, resultando em um desempenho mais rápido e eficiente na utilização da mesma.

Exemplo: ?DisableODataFilter=True

TagsMenu: esse parâmetro tem como objetivo permitir a especificação de quais tags serão incluídas na consulta, por meio da passagem de uma lista de identificadores. As tagsmenu passadas pelo parâmetro que irão determinar quais permissões de perfil que deve ser validadas. pela api, por padrão, todas as permissões de perfil são carregadas. Dessa forma, é possível obter apenas as informações desejadas e relevantes para a operação em questão fazendo com que a resposta da api seja mais rápida.

Exemplo: ?TagsMenu=800000010,800000015,826000037

Informações

icon	false
title	Fields

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

title	Parâ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 ...

...

icon	false
title	1.1.5 Fields

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

...

icon	false
title	1.1.1 GetAll

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

title	Parâ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 ...

...

icon	false
title	1.1.2 Order (Asc)

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

...

icon	false
title	1.1.2 Order (Desc)

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

...

icon	false
title	1.1.3 Filter

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

Campo: custom

Valor: success

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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

language	js
firstline	1
title	Resultado (JSON)
linenumbers	true

Informações

title	Parâ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

...

Expandir

Informações

icon	false
title	Configuração

Máscara de Url:

...

http://{domínio}:{porta}/api/

...

framework/v1/

...

menus?DisableODataFilter={

...

disable}&

...

TagsMenu={

...

tags}

Informações

icon	false
title	Exemplo de Configuração

Domínio: localhost

Porta: 8051

...

DisableODataFilter:

...

True

...

TagsMenu:

...

999999903,999999902

Url Utilizada:

...

http://localhost:8051/api/

...

framework/v1/

...

menus?

...

DisableODataFilter=

...

icon	false
title	Exemplo Postman

True&

...

tagsMenu=999999903,999999902

Informações

icon	false
title	Exemplo de Resultado

Expandir

title	Ver resultado JSON...

Bloco de código

language	js

...

Informações

title	Parâ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 ...

...

icon	false
title	1.1.5 Fields


firstline	1
title	Resultado (JSON)
linenumbers	true

{
  "hasNext": false,
  "menuItems": [
    {
      "id": "6edb6b19adc2b967dcb6d225c5c089a8",
      "name": "Integração",
      "type": "group",
      "custom": "Win"
    },
    {
      "id": "2050d813014fc487ffead38ca1e49cdc",
      "name": "Inteligência de Negócios",
      "type": "group",
      "custom": "Win"
    }
  ]
}

...

Informações

icon	false
title	Configuração

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

Informações

icon	false
title	Exemplo 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

...

icon	false
title	Exemplo Postman

...

icon	false
title	Exemplo de Resultado

...

title	Ver resultado JSON...

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 -

GET

1.1.2 - Order(Resultado Ordenado)

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.2 - GET {companyId}

1.2.2 - Order(Resultado Ordenado)

1.2.3 - Filter (Resultado filtrado)

1.2.4 - Paginação

1.2.5 - Fields (Retorno de campos específicos no resultado)

1.2.6 - Desabilitar uso do OData e selecionar Tags

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.1.1 - Get {id} (Retorna todos os módulos do RM que o usuário autenticado possui permissão na coligada informada em {id})

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

Atalhos

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

Sumário

Objetivo

1 - Métodos

1.1 -

GET

1.1.2 - Order(Resultado Ordenado)

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.2 - GET {companyId}

1.2.2 - Order(Resultado Ordenado)

1.2.3 - Filter (Resultado filtrado)

1.2.4 - Paginação

1.2.5 - Fields (Retorno de campos específicos no resultado)

1.2.6 - Desabilitar uso do OData e selecionar Tags

1.1.5 - Fields (Retorno de campos específicos no resultado)

1.1.1 - Get {id} (Retorna todos os módulos do RM que o usuário autenticado possui permissão na coligada informada em {id})

1.1.2 - Order(Resultado Ordenado)

1.1.3 - Filter (Resultado filtrado)

1.1.4 - Paginação

1.1.5 - Fields (Retorno de campos específicos no resultado)