Defining parameters for the endpoint URL

The system analyzes the REST endpoint URL that you entered and suggests the elements of the URL that represent resource path names and query string parameter names on the Define Parameters screen of the New REST Integration wizard. You can revise the elements on this screen.

For example, if you entered a URL in the format https//sampleURL.com/res_path1/res_path2?URLkey={URLkey}, the res_path1 and res_path2 elements appear in the Resource Path Name column and the URLkey element appears in the Query String Parameter Name column; {URLkey} represents the value of URLkey that is substituted at run time.

1. Verify and if necessary, update the Endpoint URL by clicking Edit.
2. Verify and if necessary, update the suggested elements for the Resource Path Name and Query String Parameter Name. The system updates the Endpoint URL accordingly.
3. Select the Is Parameter? check box next to each element under the Resource Path Name column that is a parameter.

In the above example, if you mark res_path2 as a parameter, the Endpoint URL changes to https//sampleURL.com/res_path1/{res_path2}?URLkey={yourURLkey}, with res_path2 in curly braces. The res_path2 element is now considered part of the request. The system generates a property as part of the request data model and substitutes the property's value for the value of res_path2 at run time.

Note: The system considers query string parameters as part of the request and creates properties for them as well.

4. Add more elements by clicking the relevant + icon.
5. Delete an element by clicking the Delete icon next to the element.
6. Click Next.

Related information

Open topic with navigation