Linha RM

Atalhos

Páginas filhas
  • API de Lookup

Versões comparadas

Versão antiga 7

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

comparado com

Nova versão 8

changes.mady.by.user Adriano Diniz Agrizzi

Gravado em

Chave

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

...

Informações
iconfalse
titleGetAll

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "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)

...

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 ..Expand: Foi desabilitado para esta Api.

Informações
iconfalse
titleGetOneFields

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8099 8051

Rota: companies

Campo 1: nickname

Campo 2: federalIdId: 6

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "idnickname": "6TOTVS SA",
            "codefederalId": 6,
    "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)

Informações
titleParâmetros

FieldsOrder: parâmetro responsável pela especialização de campos em um ordenação do resultado, ou seja, o usuário define quais campos serão apresentados no 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)Exemplo: ?fields=campo1

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

Informações
iconfalse
titleFieldsOrder (Asc)

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8051

Rota: companies

Campo 1: nicknameCampo 2: federalId

Tipo de Ordenação: Ascendente

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "hasNext": false,
    "items": [
        {
            "nicknameid": "TOTVS SA""6",
            "code": 6,
            "federalIdnickname": "21.867.387/0001-58INSTITUTO TOTVS DE ENSINO SA"
        },
        {
            "nicknameid": "INSTITUTO TOTVS DE ENSINO SA""7",
            "code": 7,
            "federalIdnickname": "25.578.337/0001-01INSTITUTO TOTVS DE ENSINO SUPERIOR SA"
        },
        {
            "nicknameid": "INSTITUTO TOTVS DE ENSINO SUPERIOR SA""1",
            "code": 1,
            "federalIdnickname": "TOTVS "05.295.401/0001-30"
        }
    ]SA"
        }
    ]
}



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

...

Informações
titleParâmetros

Expand: Foi desabilitado para esta Api.

Informações
iconfalse
titleGetOne

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

Informações
iconfalse
titleExemplo de Configuração

Domínio: localhost

Porta: 8099

Rota: companies

Id: 6

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

Informações
iconfalse
titleExemplo de Resultado
Expandir
titleVer resultado JSON...
Bloco de código
languagejs
firstline1
titleResultado (JSON)
linenumberstrue
{
    "id": "6",
    "code": 6,
    "nickname": "INSTITUTO TOTVS DE ENSINO SA",
    "federalId": "25.578.337/0001-01"
}