| Table of Contents | ||||
|---|---|---|---|---|
|
Basics
This feature allows the admin to define customized API routines. These routines can be executed via an API call using the Custom API identifier.
...
This Grid allows Users to add custom API calls.
Identifier: This is the unique identifier for the specific API logic. This identifier is used to invoke this Custom Logic with an API Call.
Description: A description field to provide additional information as to the purpose of the API logic.
...
Logic tab
The Logic tab is where the Custom Logic can be written and reviewed.
A User can quickly review the code written for the specific event with the 
button.
Users will be limited to the white-listed functions for PHP in PCR-360. A list of the functions can be seen in PCR-360 by clicking on the 
button.
| Include Page | ||||
|---|---|---|---|---|
|
Debug tab
...
The Debug tab shows the results of debug function calls. This debug information is cleared after 24 hours.
...
| Code Block | ||
|---|---|---|
| ||
curl -X POST -d '{"foo":"bar"}' http://DOMAIN/api/API_KEY/hello-world.json -H Content-Type:application/json |
The .json extension requests data returned JSON encoded
The Content-Type header directive for "application/json" specifies the incoming request data is JSON encoded
Within the Custom API logic, $request would contain the decoded request data:
...
Custom API shares a set of common syntax and available functions with the other types of Custom Logic.
| Include Page | ||||
|---|---|---|---|---|
|
UDF Identifiers
| Excerpt |
|---|
UDF parameters are all lower case when processed by PCR-360. Since Organizations can create their own UDF fields, the generic use of IDENTIFIER is used as a placeholder for actual UDF Identifiers. |
...
This Custom API script was written to process incoming API calls from Slack (a team chat program we use internally at PCR).
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?php
/**
* Type: Custom Logic
* Identifier: helpdesk
*/
// The incoming payload from Slack is JSON encoded so we need to decode it...
// Usually there is no need to decode the request parameter. However, Slack
// sends the "payload" parameter as a JSON encoded string
$payload = json_decode($request["payload"], true);
$user = $payload["user"]["name"];
$callbackId = explode("-",$payload["callback_id"]);
$iconUrl = "https://www.iconexperience.com/_img/v_collection_png/24x24/plain/";
$icon = "error.png";
// find the Contact for this User - using the query function is best with
// bound parameters instead of placing them directly into the query string.
// This protects the database against injection threats
$contacts = $this->query(
"SELECT RECID FROM CONTACTS C
LEFT JOIN V_UDF UDF ON UDF.VALUE_TABLE_NAME = 'CONTACTS' AND C.RECID = VALUE_TABLE_RECID
WHERE UDF.VALUE = :slack_user",
[":slack_user" => "@".$user]
);
if(!empty($contacts)){
// the query function always returns an array
// of rows so we need to look at the first index
$contact = $contacts[0];
$incidents = $this->query(
"SELECT SD.*, D.CODE, L.VALUE AS STATUS
FROM SERVICE_DESK SD
LEFT JOIN DEPT_HIERARCHY D ON SD.D_OWNER_DEPT_HIERARCHY_RECID = D.RECID
LEFT JOIN LISTS L ON SD.SD_STATUS_LISTS_RECID = L.RECID
WHERE SD_NUMBER = :incident",
[":incident" => $callbackId[0]]
);
if(!empty($incidents)){
$incident = $incidents[0];
$workflow = $this->query(
"SELECT SDWF.*, CONCAT(C.LAST_NAME,', ',C.FIRST_NAME) AS WORKER, L.CODE AS STATUS
FROM SERVICE_DESK_WORKFLOW SDWF
LEFT JOIN CONTACTS C ON C.RECID = SDWF.WORKER_CONTACTS_RECID
LEFT JOIN LISTS L ON SDWF.SD_WF_STATUS_LISTS_RECID = L.RECID
WHERE SERVICE_DESK_RECID = :sd_recid AND SDWF.RECID = :recid",
[
":sd_recid" => $incident["RECID"],
":recid" => $callbackId[2]
]
);
if(!empty($workflow)){
$wf = $workflow[0];
if(empty($wf["WORKER"])){
if($wf["STATUS"] == "PENDING"){
if(Core_Model_Api_Servicedesk::assignWorkflow(
$wf["RECID"], $contact["RECID"]
)){
$assigned = "Assigned to @{$user}";
$icon = "checkbox.png";
} else {
$assigned = "Error: Failed to Assign Workflow...";
}
} else {
$assigned = "Error: WF is not Pending...";
}
} else {
$assigned = "WF Already Assigned to {$wf["WORKER"]}";
$icon = "information.png";
}
} else {
$assigned = "Error: Cannot find Workflow {$callbackId[1]} on {$callbackId[0]}...";
}
} else {
$assigned = "Error: Cannot find Incident [{$callbackId[0]}]...";
}
} else {
$assigned = "Error: Cannot find User [{$payload["user"]["name"]}]...";
}
$orig = $payload["original_message"];
// the response array is the data that is returned to the original API request
$response = [
"text" => $orig["text"],
"attachments" => [[
"title" => $orig["attachments"][0]["title"],
"title_link" => $orig["attachments"][0]["title_link"],
"text" => $orig["attachments"][0]["text"],
"footer" => $assigned,
"footer_icon" => $iconUrl.$icon,
"ts" => time(),
]]
]; |
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|