Cross Segmentos - Backoffice RM - Integração - API - Consumo API Metadados – Central de Atendimento TOTVS

Tempo aproximado para leitura: 00:04:10 min

Dúvida
Como consumir a API de Metadados.

Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as versões.

Solução
Este documento tem o objetivo exemplificar o uso da API de Metadados, a fim de utilizar todos os métodos implementados.

Existem duas APIs de Metadados: uma para buscar a estrutura (schema) do metadado em formato compatível com o componente Dynamic Form do PO-UI e outra para os dados registrados no formulário.

1 - Schema API

2 - Data API.

1 - Schema API
Esta API retorna a estrutura do metadado, como já informado acima. Ela aceita apenas o método GET e deve ser chamada da seguinte forma:
Chamada Schema API
http://{domínio}:{porta}/api/framework/v1/metadata/schema/form/{idProjeto}
Nesta chamada, idProjeto representa o código do Projeto de Metadados que foi gerado.

Segue exemplo do GET Schema API de Metadados.

2 - Data API
Esta API possui os verbos GET, POST, PUT e DELETE e permite o gerenciamento dos dados do formulário gerado. Ela deve ser chamada da seguinte forma:
Chamada Dados API
http://{domínio}:{porta}/api/framework/v1/metadata/data/{idProjeto}

Neste exemplo exemplificaremos o uso da Data API, com seus respectivos métodos:
1 - GET - GetAll (Retornar todos Registros) ou GetOne (Retornar registro especifico).

2 - POST - Inserir registro no Metadados.

3 - PATCH- Atualizar informações no registro do Metadados.

4 - DELETE - Deletar um registro do Metadados.

Importante
O funcionamento da API em todos os verbos se dá conforme o Padrão de API TOTVS. No entanto, algumas funcionalidades como seleção de colunas, paginação, objetos complexos e tabelas relacionadas ainda não estão disponíveis.

1.1 - GET ALL

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/metadata/data/{idProjeto}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/metadata/data/PRJ4411904

Exemplo de Resultado

Resultado (JSON)

{

    "hasNext": false,

    "items": [

        {

            "id": 12,

            "ID": 12,

            "NOME": "TESTE NOME 12",

            "IDADE": "12"

        },

      {

            "id": 13,

            "ID": 13,

            "NOME": "TESTE NOME 13",

            "IDADE": "33"

        }
]
}

Exemplo do GET All no Postman:

1.2 - GET ONE

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/metadata/data/{idProjeto}/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/metadata/data/PRJ4411904/12

Exemplo de Resultado

Resultado (JSON)

{

            "id": 12,

            "ID": 12,

            "NOME": "TESTE NOME 12",

            "IDADE": "12"

}

Exemplo do GET One no Postman:

2 - POST

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/metadata/data/{idProjeto}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Url Utilizada: http://localhost:8051/api/framework/v1/metadata/data/PRJ4411904

Exemplo de Entrada

Resultado (JSON)

{

            "ID": 17,

            "NOME": "TESTE NOME 17",

            "IDADE": "27"

}

Exemplo de Resultado

Resultado (JSON)

{

            "id": 17,

            "ID": 17,

            "NOME": "TESTE NOME 17",

            "IDADE": "27"
}

Exemplo do Post no Postman:

4 - Patch

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/metadata/data/{idProjeto}/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 17

Url Utilizada: http://localhost:8051/api/framework/v1/metadata/data/PRJ4411904/17

Exemplo de Entrada

Resultado (JSON)

{

    "NOME": "NOVO NOME 17"
}

Exemplo de Resultado Positivo

Resultado (JSON)

{

     "id": 17,

     "ID": 17,

     "NOME": "TESTE NOME 17",

     "IDADE": "27"
}

Exemplo de Patch no Postman:

5 - Delete

Configuração

Máscara de Url: http://{domínio}:{porta}/api/framework/v1/metadata/data/{idProjeto}/{id}

Exemplo de Configuração

Domínio: localhost

Porta: 8051

Id: 17

Url Utilizada: http://localhost:8051/api/framework/v1/metadata/data/PRJ4411904/17

Resultado esperado

Será retornado o respondeCode = 204 e a resposta em branco.

Exemplo de Delete no Postman:

Saiba Mais:

Para mais informações sobre a API de Metadados, segue documentação abaixo:
API Metadados

Olá,

Cross Segmentos - Backoffice RM - Integração - API - Consumo API Metadados

0 Comentários

Olá ,

Olá ,

Olá ,

Olá,