Os exemplos descritos nesta seção contêm dados reais e podem ser aplicados em qualquer ambiente SE Suite. Com isso, ao segui-los, será possível cadastrar e consumir dados de fontes de exemplo. Nesta seção, estão disponíveis também, os dados dos serviços utilizados nos cadastros.
1.
|
Na barra de ferramentas da tela principal de Fonte de dados REST (AD052), acione o botão .
|
2.
|
Na etapa Dados do serviço REST, do assistente que será aberto, preencha os seguintes campos, da forma descrita:
Identificador: sesuiteSampleOAuthService
Nome: SESuite OAuth Service Sample
URL do serviço: https://<ambiente>/softexpert/rest/sample/oauth
Tipo de autenticação: Autenticação OAuth (client credentials)
URL de acesso ao token: https://<ambiente>/softexpert/rest/sample/oauth/token
Client ID: idsample
Client Secret: somesecret
Nas URLs onde está denotado com <ambiente>, deve-se alterado este valor para o domínio do ambiente em que a fonte está sendo criada.
|
|
3.
|
Acione o botão Próximo, ao fim da configuração de cada etapa.
|
4.
|
Na etapa Parâmetros de entrada, preencha somente o método como GET.
|
5.
|
Na etapa Parâmetros de saída, inclua o corpo de resposta conforme o exemplo a seguir:
|
6.
|
Avance a etapa Segurança, sem realizar nenhuma configuração nela.
|
7.
|
Na etapa Resumo, é possível verificar as configurações realizadas nas etapas anteriores. Acione o botão Teste de consumo para realizar um teste do serviço registrado. Na tela que será aberta, acione o botão Executar.
|
8.
|
Sua fonte de dados está devidamente configurada e funcionando corretamente! Acione o botão Finalizar para concluir seu registro.
|
1.
|
Na barra de ferramentas da tela principal de Fonte de dados REST (AD052), acione o botão .
|
2.
|
Na etapa Dados do serviço REST, do assistente que será aberto, preencha os seguintes campos, da forma descrita:
Identificador: sesuiteSampleCompanyServiceQuery
Nome: SESuite Company Service Query Sample
URL do serviço: https://<ambiente>/softexpert/rest/sample/company
Nas URLs onde está denotado com <ambiente>, deve-se alterado este valor para o domínio do ambiente em que a fonte está sendo criada.
|
|
3.
|
Acione o botão Próximo, ao fim da configuração de cada etapa.
|
4.
|
Na etapa Parâmetros de entrada, preencha os campos com os seguintes valores:
Método: GET
Identificador: term
Parâmetro: QUERY
Tipo: STRING
|
5.
|
Na etapa Parâmetros de saída, inclua o corpo de resposta conforme o exemplo a seguir:
|
6.
|
Avance a etapa Segurança, sem realizar nenhuma configuração nela.
|
7.
|
Na etapa Resumo, é possível verificar as configurações realizadas nas etapas anteriores. Acione o botão Teste de consumo para realizar um teste do serviço registrado. Na seção Consulta da tela que será aberta, preencha o seguinte parâmetro:
term: canada
Feito isso, acione o botão Executar.
|
8.
|
Sua fonte de dados está devidamente configurada e funcionando corretamente! Acione o botão Finalizar para concluir seu registro.
|
1.
|
Na barra de ferramentas da tela principal de Fonte de dados REST (AD052), acione o botão .
|
2.
|
Na etapa Dados do serviço REST, do assistente que será aberto, preencha os seguintes campos, da forma descrita:
Identificador: sesuiteSampleCompanyServiceInsert
Nome: SESuite Company Service Insert Sample
URL do serviço: https://<ambiente>/softexpert/rest/sample/company
Nas URLs onde está denotado com <ambiente>, deve-se alterado este valor para o domínio do ambiente em que a fonte está sendo criada.
|
|
3.
|
Acione o botão Próximo, ao fim da configuração de cada etapa.
|
4.
|
Na etapa Parâmetros de entrada, preencha os campos com os seguintes valores:
Método: POST
Corpo de requisição:
|
5.
|
Na etapa Parâmetros de saída, inclua o corpo de resposta conforme o exemplo a seguir:
|
6.
|
Avance a etapa Segurança, sem realizar nenhuma configuração nela.
|
7.
|
Na etapa Resumo, é possível verificar as configurações realizadas nas etapas anteriores. Acione o botão Teste de consumo para realizar um teste do serviço registrado. Na seção Corpo da requisição da tela que será aberta, preencha os seguintes parâmetros:
companyName: CT - COMPANY FOR TESTS
state: SHANDONG
country: CHINA
Feito isso, acione o botão Executar.
|
8.
|
Sua fonte de dados está devidamente configurada e funcionando corretamente! Acione o botão Finalizar para concluir seu registro.
|
O Serviço Company é um serviço que simula a manipulação de informações sobre dados de corporações fictícias e está disponível para ser utilizado na fonte de dados REST. Veja a seguir os endpoints disponíveis:
Recuperar todas as corporações
|
URL
|
https://<ambiente>/softexpert/rest/sample/company
|
Método
|
GET
|
Corpo de resposta
|
[{"identifier":0," companyName":"string", "state":"string", "country":"string"}]
|
Filtrar corporações
|
URL
|
https://<ambiente>/softexpert/rest/sample/company/query
|
Método
|
GET
|
Parâmetros (Query)
|
NOME: term / TIPO: texto
|
Corpo de resposta
|
[{"identifier":0," companyName":"string", "state":"string", "country":"string"}]
|
Filtrar corporações com faixa de valor
|
URL
|
https://<ambiente>/softexpert/rest/sample/company/between
|
Método
|
GET
|
Parâmetros (Query)
|
▪NOME: minID / TIPO: numérico ▪NOME: maxID / TIPO: numérico |
Corpo de resposta
|
[{"identifier":0," companyName":"string", "state":"string", "country":"string"}]
|
Inserir nova corporação
|
URL
|
https://<ambiente>/softexpert/rest/sample/company
|
Método
|
POST
|
Corpo de requisição
|
{"companyName":"string","state":"string","country":"string"}
|
Corpo de resposta
|
{"identifier":0," companyName":"string", "state":"string", "country":"string"}
|
Informações adicionais
|
A corporação inserida não será realmente persistida, nem salva em memória, sendo apenas um exemplo simulando a inserção de um registro.
|
Atualizar corporação
|
URL
|
https://<ambiente>/softexpert/rest/sample/company
|
Método
|
PUT
|
Corpo de requisição
|
{"identifier":0," companyName":"string", "state":"string", "country":"string"}
|
Corpo de resposta
|
{"identifier":0," companyName":"string", "state":"string", "country":"string"}
|
Informações adicionais
|
A corporação inserida não será realmente atualizada, é apenas um exemplo simulando a atualização de um registro. Caso não seja passado um identificador válido, nada é retornado.
|
Remover corporação
|
URL
|
https://<ambiente>/softexpert/rest/sample/company
|
Método
|
DELETE
|
Corpo de resposta
|
{"message":"string"}
|
Informações adicionais
|
A corporação inserida não será realmente removida, é apenas um exemplo simulando a remoção de um registro.
|
Nas URLs onde está denotado com <ambiente>, deve-se alterado este valor para o domínio do ambiente em que a fonte está sendo criada.
|
|
|