It consists of following navigation tabs:
- Web Service Details
- Path Parameters
- Query parameters
- Request Headers
- Outbound Mapping
- Inbound Mapping
Web Service Details
Web Service details tab provides the basic information about web service objects. Use this tab to define the Web Service Details. It consists of the following fields:
Name: Specify the name of the new web service.
...
- Get: To retrieve data
- Post: To create data
- Put: To edit the data
- Delete: To delete the data
Path Parameters
The path parameter is part of a path segment that occurs after its name. Path parameters offer a unique opportunity to dynamically replace the values and pass them in the URL
...
- Key- parameter1 and Value value1
- Key- parameter2 and Value value2
Query Parameters
The query parameters are sometimes referred to as optional parameters, . The query parameters are separated from the hierarchical parameters by the question mark. Query parameters appear in the URL after the question mark (?) after the resource name:
https://myserver.com/resource-name?param1=value1¶m2=value2
...
- Key – param1 and Value – value1
- Key – param2 and value – value2
Request Headers
Headers are mostly classified as request headers, . You will have to set the request headers when you are sending the request.
The below is the following sample headers that you will encounter are encountered the most while.
Authorization: Carries credentials containing the authentication information of the client for the resource being requested.
...
Content-Type: Indicates the media type (text/HTML or text/JSON, XML/custom) of the response sent to the client by the server, this will help the client in processing the response body correctly.
Outbound Mapping
Request payload which needs to be passed to complete the request.
...
Key attributes are the attributes which need to be passed to the payload to create the ticket, the . The values are the information which is captured in the Luma attributes from the slot population prompts and will be passed to the request.
- Advanced: Select this check box if you want to pass all the information you put in the text area gets sent with the request, this is mainly used in case if the attribute value cannot be populated directly and the value is again another JSON (Nested JSON). As shown below in the eg. if we need to populate multiple custom attributes in a ticket using the payload then the Advanced section will look as below.
{
"Impact":"@context.Impact",
"Description":"@context.Description",
"CustomAttributes":{
"Business_Criticality":"@context.Business_Criticality",
"Active_Directory_Account_Data":"@context.Active_Directory_Account_Data"
},
"Priority":"@context.Priority",
"DescriptionLong":"@context.Details",
"Severity":"@context.Severity",
"Urgency":"@context.Urgency",
"Categorization":"@context.Categorization"
} As shown in the above example, for Custom Attributes Key, the values we are passing are for both Business_Criticality and Active_Directory_Account_Data and the remaining attribute has direct values associated.
Click Update to save your modified outbound data.
Inbound Mapping
Inbound mapping is done based on the response from the payload, An . An API response consists of the body, headers, and the status code, . Currently, Luma would process processes the web service if the response is in JSON or XML format.
Inbound mapping is optional only need when you want the information to populate the slots based on the response of the initial call, It can be used to
...
Based on the above JSON Response, The the following information of pagination count need to be passed
...
Payload: Data type payload.
- Click Save to reflect the Web Services in Luma Bot or else click Cancel.