Plant ApplicationsCreate a PRE or POST Call
Procedure
- In the Configuration page, select Custom Calls.
- In the Actions section, in the left pane, select a required action from the list of actions for which you want to create a PRE or POST call.
- Under Custom Call Details section, select PRE or POST based on the requirement.Provide values as specified in the following table.
Field Description URL Enter the external service URL. For example, https://<IP address>:<port number>/workqueue-app/api/workqueue/operations?workOrderId={WorkOrderId}&segmentId={segmentid}.
Note: Only CORS-enabled URLs are valid.METHOD Select the request type (GET or POST) that will be used to call the external service. Authentication Switch the toggle to enable URL authentication. Note: Only Operations Hub UAA authentication is supported.Add another input parameter Select to add as many input parameters you would like to pass to the external service URLs. The PARAMETER list along with the ALIAS text box appears. PARAMETER Select an input parameter from the PARAMETER drop-down list box that you want to add to the URL. Note: The input parameters are a list of all property definitions including definitions under the MaterialLot and Material property groups. However, the Configuration application does not support the property definitions within the MaterialLot Import and Material Import property groups even though they are listed.ALIAS Enter the alias name in the ALIAS text box based on the selected input parameter. Note: The alias name is the external application’s input parameter. It is mapped to the internal application’s input parameter to read values. - Under Output Parameters, provide values as specified in the following table.
Field Description PARAMETER Enter the output parameter so that data can be transferred from an external service to the integrated application. ALIAS Indicates the boolean value (true or false), which is a property returned by the API to determine if the request is successful. You cannot modify this field. If an output parameter is not supplied, standard API responses are assumed with 200 being True and all other codes as False .
Note: Ensure that this field is a part of the response from the external API so that the integrated application can read and verify if the API call was executed successfully.Display Message Key Enter a string output parameter, which is a property returned by the API that contains a custom user message. This is used only when the boolean parameter returns a false value. - Select Update to save your changes.
