| Warning |
|---|
Looking for the documentation on the newest versions of SIL Engine and the Simple Issue Language for Jira 8 for Server/Data Center? Click here ! |
| Info | ||
|---|---|---|
| ||
This routine is available starting with SIL Engine™ 4.15.50. |
Syntax
fromJsongetWebhookPayload(json)
Description
| Excerpt |
|---|
Converts the given JSON string into a SIL™ type (can be a primitive, array or struct). |
Parameters
...
Parameter name
...
Type
...
Required
...
Description
...
json
...
string
...
Yes
...
Gets the Webhook payload from the calling client. |
Return type
variable return type - depending on the left hand side operator type
Examples
Both examples show how JSON data can be parsed into an array or struct collections. Both examples use the following struct definitions:WebhookPayload
Examples
Example 1 - Getting the Webhooks payload from the calling client
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| Code Block | ||||||||
| ||||||||
| ||||||||
struct code {
number [] rgba;
string hex;
}
struct color {
string color;
string category;
string type;
code code;
}
struct colors {
color [] colors;
} |
Example 1 - Reading JSON from a file
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
string json = readFromTextFile("C:\\colors.json");
colors cData;
cData = fromJson(json);
return cData.colors[0].color; |
Example 2 - Reading JSON from a variable
| |
//getting the REST/HTTP call input parameters:
WebhookPayload httpRequestPayload = getWebhookPayload();
//getting the used HTTP method:
string httpMethod = httpRequestPayload.httpMethod;//This can be something like "GET", "POST", "PUT", etc.
//getting the http request payload (body):
string httpPayload = httpRequestPayload.payload;
//getting the http query parameters:
WebhookParam[] httpQueryParams = httpRequestPayload.queryParams;
string firstQueryParamName = httpQueryParams[0].name;
string firstQueryParamValue = httpQueryParams[0].values[0];
//sending the response back to the caller:
appendToWebhookResponse("http method:");
appendToWebhookResponse(httpMethod);
appendToWebhookResponse("payload:");
appendToWebhookResponse(httpPayload);
appendToWebhookResponse("firstQueryParamName:");
appendToWebhookResponse(firstQueryParamName);
appendToWebhookResponse("firstQueryParamValue:");
appendToWebhookResponse(firstQueryParamValue);
//returning a custom HTTP status code:
return true, 1234; |
See also
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|