It consists of following navigation tabs:
...
- 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 attributes are the attributes which need to be passed to the payload to create the ticket. The values are the information which captured in the Luma attributes from the slot 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.
Code Block {
"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.
...
Example: For a sample JSON response for a payload looks like this
| Code Block |
|---|
{ |
...
"data": { |
...
"items": [ |
...
|
...
{ "TicketIdentifier": "300-11" |
...
}, |
...
{
...
{ "TicketIdentifier": "300-12" |
...
},
{
...
}, { "TicketIdentifier": "300-23" |
...
}, |
...
{
...
{ "TicketIdentifier": "300-31" |
...
}, |
...
{ |
...
"TicketIdentifier": "300-34" |
...
}, |
...
{
...
{ "TicketIdentifier": "300-37" |
...
}, |
...
{ |
...
"TicketIdentifier": "300-41" |
...
}, |
...
{ |
...
"TicketIdentifier": "300-43" |
...
}, |
...
{ |
...
"TicketIdentifier": "300-45" |
...
}, |
...
{ |
...
"TicketIdentifier": "300-46" |
...
}, |
...
{ |
...
"TicketIdentifier": "300-48" |
...
}
],
...
} ], "totalCount": |
...
11 }, |
...
"error": null, |
...
"status": "OK" |
...
} |
Based on the above JSON Response, the following information of pagination count need to be passed.
Key | Value |
|---|---|
| @pagination.totalCount | @resp.data.totalCount |
- Key: In the form data, Key represents an attribute.
- Value: It represents attribute value.
XML Response
Example: For a sample XML response for a payload looks like this:
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?> |
...
<entries>
<values>
<EntryID>INC000000867505</EntryID>
<Submitter>peter.hinchey</Submitter>
...
<entries> <values> <EntryID>INC000000867505</EntryID> <Submitter>peter.hinchey</Submitter> <Submit_Date>2018-12-17T16:12:39.000+0000</Submit_Date> |
...
<AEC_Initial_Assignee>Roman Havryshkiv</AEC |
...
_Initial_Assignee> <Assignee_Login_ID>v-havryshr</Assignee_Login_ID> |
...
</values> |
...
</entries> |
The above sample XML response will be parsed as shown below:
@resp.\\entries\values\EntryID OR @resp.\\EntryID
@resp.\\entries\values\Submitter OR @resp.\\Submitter
@resp.\\entries\values\Submit_Date OR @resp.\\Submit_Date
@resp.\\entries\values\AEC_Initial_Assignee OR @resp.\\AEC_Initial_Assignee
@resp.\\entries\values\Assignee_Login_ID OR @resp.\\Assignee_Login_ID
Response
It is the format of your output response. Once the skill is fulfilled the response from the payload can be configured to visualize in the three response formats. They are Card, Image, Quick Replies.
...
Example: To avoid truncating details for the following sample JSON response, do the following:
| Code Block |
|---|
{ |
...
"entries": |
...
{
...
[ { "values": |
...
{ "Entry ID": "INC000000867505", |
...
"Submitter": "peter.hinchey", |
...
"Submit Date": "2018-12-17T16:12:39.000+0000", |
...
"AEC Initial Assignee": |
...
"Roman Havryshkiv", "Assignee Login ID": "v-havryshr" |
...
}
}
]
}
...
} } ] } Add ${@response.key with spaces} |
...
The above sample will be parsed as shown below: |
...
${@resp.entries.values.Entry ID} |
...
${@resp.entries.values.Submit Date} |
...
${@resp.entries.values.AEC Initial Assignee} |
...
${@resp.entries.values.Assignee Login ID} |
Sub Title: Subtitle of the output data, In the below example, we are showing the information Ticket status, Priority, AssignedIndividual and Requestor.
...
For example, if the payload response is as below
| Code Block |
|---|
{ |
...
"data": |
...
{ "Severity": "Normal", |
...
"CreationTimestamp": "1527142942000", |
...
"Impact": "Medium", |
...
"RequiresCabApproval": "0", |
...
“Description:: “Test Description”, |
...
"ResolvedDateTimestamp": "", |
...
"ResolvedGroupID": "0", |
...
"ResolvedGroupName": "", |
...
"ResolvedUserName": "", |
...
"SendWorklogEmail": "", |
...
"Source": "LUMA", |
...
"ReasonCode": "Incident Created", |
...
"Phase": "Acceptance", |
...
"RequestCatalogWorkflowId": "", |
...
"RequestedForAltEmail": " |
...
john. |
...
ts@serviceaide.com", |
...
"RequestedForAltPhone": "", |
...
"Urgency": "Medium", |
...
"LastWorklog": "", |
...
"RequestedOrgID": "1", |
...
"RequesterAltEmail": " |
...
john. |
...
ts@serviceaide.com", |
...
"RequestedForExternalUserID": "d8bf3b90-387e-4929-b52e-21d86d4b0cdf", |
...
"RequestedForID": "15", |
...
"RequestedForOrgHierarchicalPath": "ransa08midast01", |
...
"RequesterRootOrgName": "ransa08midast01", |
...
"RequesterUserID": "9", |
...
"RequesterUserName": " |
...
ts, |
...
john", |
...
"AssignedContactID": "1", |
...
"AssignedIndividual": "ransa08midast01, admin", |
...
"AssignedTo": "ransa08midast01, admin | Administration", |
...
"RequestedForRootOrgName": "ransa08midast01", |
...
"RequestedForUserID": "9", |
...
"RequestedForUserName": " |
...
ts, |
...
john", |
...
"MdrElementID": "98", |
...
"TicketIdentifier": "300-39", |
...
"TicketStatus": "New", |
...
"Priority": "Medium" |
...
}, |
...
"error": null, |
...
"status": "CREATED" |
...
} |
Title - Ticket #@resp.data.TicketIdentifier
...
| Code Block |
|---|
{ |
...
"data": |
...
{
...
[ { "code": "0", |
...
"name": "None" |
...
}, |
...
...
{ "code": "1", |
...
"name": "Critical" |
...
},
{
...
}, { "code": "2", |
...
"name": "High" |
...
}, |
...
...
{ "code": "3", |
...
"name": "Medium" |
...
}, |
...
{
...
{ "code": "4", |
...
"name": "Low" |
...
}
],
...
} ], "error": null, |
...
"status": "OK" |
...
} |
Title: @resp.data.name
Type: Text
Payload: Data type payload.
- Click Save to reflect the Web Services in Luma Bot or else click Cancel.