...
Utilizado um único método implementado:
...
2 - GET
...
| 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"
}
]
} |
|
|
|
...
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"
} |
|
|
|
4 - 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 ...
| Aviso |
|---|
| Os campos informados em Fields devem ser validados para retornar apenas as colunas esperadas do lookup.
Esta validação deve ser realizada pelo produto. |
|
| Informações |
|---|
|
Máscara de Url: http://{domínio}:{porta}/api/framework/v1/companies?fields={campos} | 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": [
{
"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"
},
{
"nickname": "Teste"
},
{
"nickname": "Teste PUT",
"federalId": "82.122.163/0001-01"
},
{
"nickname": "Colligada",
"federalId": "38.737.259/0001-92"
},
{
"nickname": "Teste coligada"
}
]
} |
|
|
|
