...
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.
...
Informações |
---|
|
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup Informações |
---|
icon | false |
---|
title | Exemplo de Configuração |
---|
| Domínio: localhost Porta: 8051 Rota: companies Url Utilizada: localhost:8051/api/framework/v1/companies/lookup |
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,
"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 |
---|
|
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 |
---|
icon | false |
---|
title | GetOneFields |
---|
|
Máscara de Url: http://http://{domínio}:{porta}/api/framework/v1/{rota}/lookup/?fields={idcampos} 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,
"iditems": [
{
"nickname": "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 |
---|
|
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 |
---|
icon | false |
---|
title | FieldsOrder (Asc) |
---|
|
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/{rota}/lookup?fieldsorder={camposcampo} 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,
"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": "05.295.401/0001-30"TOTVS SA"
}
]
} |
|
|
|
2.3 - GetOne (Recuperar um único registro pelo identificador)
...
Informações |
---|
|
Expand: Foi desabilitado para esta Api. |
Informações |
---|
|
Máscara de Url: http://http://{domínio}:{porta}/api/framework/v1/{rota}/lookup/{id} Informações |
---|
icon | false |
---|
title | Exemplo de Configuração |
---|
| Domínio: localhost Porta: 8099 Rota: companies Id: 6 Url Utilizada: localhost:8051/api/framework/v1/companies/lookup/6 |
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 |
---|
| {
"id": "6",
"code": 6,
} "nickname": "INSTITUTO TOTVS DE ENSINO SA",
] "federalId": "25.578.337/0001-01"
} |
|
|
|