The examples described in this section have real examples and may be applied to any SE Suite environment. Thus, by following them, it will be possible to create and consume example source data. The data of the services used in the records are also available in this section.
1.
|
On the toolbar of the main screen of the REST data source (AD052), click on the button.
|
2.
|
In the REST service data step of the wizard that will be opened, fill out the following fields according to these descriptions:
ID #: sesuiteSampleOAuthService
Name: SESuite OAuth Service Sample
Service URL: https://<environment>/softexpert/rest/sample/oauth
Authentication type: OAuth Authentication (client credentials)
Token access URL: https://<environment>/softexpert/rest/sample/oauth/token
Client ID: idsample
Client Secret: somesecret
In the URLs, where it says <environment>, it should be replaced with the domain of the environment in which the source is being created.
|
|
3.
|
Click on the Next button after configuring each step.
|
4.
|
In the Input parameters step, fill out only the method as GET.
|
5.
|
In the Output parameters step, add the response body according to the following example:
|
6.
|
Move past the Security step without performing any configurations in it.
|
7.
|
In the Summary step, it is possible to check the configurations performed in the previous steps. Click on the Consumption test button to perform a test of the recorded service. On the screen that will be opened, click on the Execute button.
|
8.
|
Your data source is properly configured and working correctly! Click on the Finish button to finish your record.
|
1.
|
On the toolbar of the main screen of the REST data source (AD052), click on the button.
|
2.
|
In the REST service data step of the wizard that will be opened, fill out the following fields according to these descriptions:
Identifier: sesuiteSampleCompanyServiceQuery
Name: SESuite Company Service Query Sample
Service URL: https://<environment>/softexpert/rest/sample/company
In the URLs, where it says <environment>, it should be replaced with the domain of the environment in which the source is being created.
|
|
3.
|
Click on the Next button after configuring each step.
|
4.
|
In the Input parameters step, fill out the fields with the following values:
Method: GET
Identifier: term
Parameter: QUERY
Type: STRING
|
5.
|
In the Output parameters step, add the response body according to the following example:
|
6.
|
Move past the Security step without performing any configurations in it.
|
7.
|
In the Summary step, it is possible to check the configurations performed in the previous steps. Click on the Consumption test button to perform a test of the recorded service. In the Search section on the screen that will open, fill out the following parameter:
term: canada
Once done, click on the Execute button.
|
8.
|
Your data source is properly configured and working correctly! Click on the Finish button to finish your record.
|
1.
|
On the toolbar of the main screen of the REST data source (AD052), click on the button.
|
2.
|
In the REST service data step of the wizard that will be opened, fill out the following fields according to these descriptions:
Identifier: sesuiteSampleCompanyServiceInsert
Name: SESuite Company Service Insert Sample
Service URL: https://<environment>/softexpert/rest/sample/company
In the URLs, where it says <environment>, it should be replaced with the domain of the environment in which the source is being created.
|
|
3.
|
Click on the Next button after configuring each step.
|
4.
|
In the Input parameters step, fill out the fields with the following values:
Method: POST
Request body:
|
5.
|
In the Output parameters step, add the response body according to the following example:
|
6.
|
Move past the Security step without performing any configurations in it.
|
7.
|
In the Summary step, it is possible to check the configurations performed in the previous steps. Click on the Consumption test button to perform a test of the recorded service. In the Request body section on the screen that will open, fill out the following parameters:
companyName: CT - COMPANY FOR TESTS
state: SHANDONG
country: CHINA
Once done, click on the Execute button.
|
8.
|
Your data source is properly configured and working correctly! Click on the Finish button to finish your record.
|
The Company Service is a service that simulates the handling of information on data of fake corporations and is available to be used in the REST data source. The following endpoints are available:
Retrieve all corporations
|
URL
|
https://<environment>/softexpert/rest/sample/company
|
Method
|
GET
|
Response body
|
[{"identifier":0," companyName":"string", "state":"string", "country":"string"}]
|
Filter corporations
|
URL
|
https://<environment>/softexpert/rest/sample/company/query
|
Method
|
GET
|
Parameters (Query)
|
NAME: term / TYPE: text
|
Response body
|
[{"identifier":0," companyName":"string", "state":"string", "country":"string"}]
|
Filter corporations with a value range
|
URL
|
https://<environment>/softexpert/rest/sample/company/between
|
Method
|
GET
|
Parameters (Query)
|
▪NAME: minID / TYPE: numeric ▪NAME: maxID / TYPE: numeric |
Response body
|
[{"identifier":0," companyName":"string", "state":"string", "country":"string"}]
|
Add a new corporation
|
URL
|
https://<environment>/softexpert/rest/sample/company
|
Method
|
POST
|
Request body
|
{"companyName":"string","state":"string","country":"string"}
|
Response body
|
{"identifier":0," companyName":"string", "state":"string", "country":"string"}
|
Additional information
|
The added corporation will not be truly persisted or saved to memory, being simply an example to simulate adding a record.
|
Update corporation
|
URL
|
https://<environment>/softexpert/rest/sample/company
|
Method
|
PUT
|
Request body
|
{"identifier":0," companyName":"string", "state":"string", "country":"string"}
|
Response body
|
{"identifier":0," companyName":"string", "state":"string", "country":"string"}
|
Additional information
|
The added corporation will not be truly updated, being simply an example to simulate updating a record. If a valid identifier is not entered, nothing is returned.
|
Delete corporation
|
URL
|
https://<environment>/softexpert/rest/sample/company
|
Method
|
DELETE
|
Response body
|
{"message":"string"}
|
Additional information
|
The added corporation will not be truly deleted, being simply an example to simulate deleting a record.
|
In the URLs, where it says <environment>, it should be replaced with the domain of the environment in which the source is being created.
|
|
|