Service data

• The ID # must contain letters and may contain numbers, but cannot start with numbers.

• In the Service URL field, we must enter the REST API URL that will be used for the integration. If the service will use parameters of the PATH type, they must be inserted in the URL itself (simply add an endpoint, such as: https://exampleservice.com/user/{path}). Note that the PATH parameter that is inserted in the URL will be added by the system in the Input parameter step; this input parameter must have a value during consumption for the operation to be carried out successfully.

• If we enable the Internal SE Suite web service option, it will be possible to select an internal REST API provided by SoftExpert Suite. Thus, a source will not need to be created if the environment's domain configurations are changed.

• When configuring a REST interface provided by SoftExpert Suite, it is possible to obtain the service URL in the Reference section.

HTTP methods available for selection:

Parameter types available for selection:

Data types available for selection:

If the previously selected method is POST or PUT, the Request body field will be displayed; use it to insert an example for the request body in JSON format. The body example will be used for SoftExpert Suite to map the attributes that will be sent by the request. 

See an example of the request body that can be inserted in the displayed field:

{  
 "id": 1,  
 "name": "New example name"  
}

It is also possible to send examples with date type:

{  
 "id": 10,  
 "name": "example",  
 "admission Date": "MM/dd/yyyy"  
}

The date parameter must be using the formatting value correctly. See some examples of date formats:

• When configuring a REST interface provided by SoftExpert Suite, select the POST method. The request body can be obtained in the Reference section.

• The examples to be inserted in the Response body are similar to those described for the Request body, in the Input parameters step.

• When the body of the request/response is inserted in the Input parameters and Output parameters sections, problems may occur and prevent it from moving on to the next step. Refer to the Troubleshooting section to see possible problems and their solutions.

• When configuring a REST interface provided by SoftExpert Suite, you can find the response body in the Integration Guide document.

In the Security tab, it is possible to define a security list for the REST data source, restricting access to the necessary users only.

Check the options available in this tab:

Private

Only the users defined in this tab will be able to edit or view the REST data source. To do that, use the following columns:

• Edit: define the users, teams, departments, and/or positions that will have permission to edit the data source.
• View: define the users, teams, departments, and/or positions that will be allowed to view the data source.

Public

All system users will be able to view the REST data source, but only those defined in the corresponding column will be allowed to edit it. Therefore, the View column will be disabled (since the data source can be viewed by any user). 

In the Edit column, define the users, teams, departments, and/or positions that will have permission to edit the data source data.

After clicking on the Consumption test button, use the screen that will open to provide the required information, in accordance with the specifications of the service being consumed. 

Among the parameters available in the consumption test, the following information can be inserted:

To consume the service, click on the Execute button at the bottom of the screen. Two response types may be displayed:

• Success: consumption was successful. In this case, it will be possible to view a JSON with the service return via SoftExpert Suite.
• Something went wrong: there was a problem while consuming the service. Refer to the Troubleshooting section to see the possible responses and their meanings.