Linha RM

Atalhos

Páginas filhas
  • API de Lookup

Sumário


Objetivo

A API de Lookup é uma API com intuito de trazer apenas dados para identificação de registros. (A partir da versão 12.1.2406,)
É implementada a partir da rota da API principal, e é apartada do sistema de permissionamento do RM.


1 - Métodos

      Utilizado um único método implementado:

  • GET


2 - GET

GetAll

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Url Utilizada: localhost:8051/api/framework/v1/companies/lookup

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "id": "1",
            "code": 1,
            "nickname": "TOTVS SA",
            "federalId": "21.867.387/0001-58"
        },
        {
            "id": "6",
            "code": 6,
            "nickname": "INSTITUTO TOTVS DE ENSINO SA",
            "federalId": "25.578.337/0001-01"
        },
        {
            "id": "7",
            "code": 7,
            "nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA",
            "federalId": "05.295.401/0001-30"
        }
    ]
}


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

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 ...

Fields

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Campo 1: nickname

Campo 2: federalId

Url Utilizada: http://localhost:8051/api/framework/v1/companies/lookup?fields=nickname,federalId

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "nickname": "TOTVS SA",
            "federalId": "21.867.387/0001-58"
        },
        {
            "nickname": "INSTITUTO TOTVS DE ENSINO SA",
            "federalId": "25.578.337/0001-01"
        },
        {
            "nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA",
            "federalId": "05.295.401/0001-30"
        }
    ]
}



2.2 - Order (Resultado Ordenado)

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 ...

Order (Asc)

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

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Campo: nickname

Tipo de Ordenação: Ascendente

Url Utilizada: http://localhost:8051/api/framework/v1/companies/lookup?order=nickname

Exemplo de Resultado

Resultado (JSON)
{
    "hasNext": false,
    "items": [
        {
            "id": "6",
            "code": 6,
            "nickname": "INSTITUTO TOTVS DE ENSINO SA"
        },
        {
            "id": "7",
            "code": 7,
            "nickname": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA"
        },
        {
            "id": "1",
            "code": 1,
            "nickname": "TOTVS SA"
        }
    ]
}



2.3 - GetOne (Recuperar um único registro pelo identificador)

Parâmetros

Expand: Foi desabilitado para esta Api.

GetOne

Máscara de Url: http://http://{domínio}:{porta}/api/framework/v1/{rota}/lookup/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8099

Rota: companies

Id: 6

Url Utilizada: localhost:8051/api/framework/v1/companies/lookup/6

Exemplo de Resultado

Resultado (JSON)
{
    "id": "6",
    "code": 6,
    "nickname": "INSTITUTO TOTVS DE ENSINO SA",
    "federalId": "25.578.337/0001-01"
}






  • Sem rótulos