global
Global
global
SNG-Get RITM Vars via REST API-v2.1
5214b11a379d045090b68cf6c3990e55
loaded
sys_remote_update_set
admin
2019-11-25 23:01:58
034bb95237dd045090b68cf6c3990ea7
0
admin
2019-11-25 23:01:58
INSERT_OR_UPDATE
global
customer
sys_ws_definition_09817ffa37ec730090b68cf6c3990e10
true/api/13231/ritm_vars_apiapplication/json,application/xml,text/xmlfalseNo active default versioncf9d01d3e73003009d6247e603f6a990falseRITM Vars API13231application/json,application/xml,text/xmlfalseritm_vars_apisys_ws_definitionadmin2019-04-05 17:57:4109817ffa37ec730090b68cf6c3990e102RITM Vars APIglobalglobalsys_ws_definition_09817ffa37ec730090b68cf6c3990e10admin2019-04-05 17:59:41]]>
-1197587906
034bb95237dd045090b68cf6c3990ea7
false
admin
2019-11-25 23:01:58
0f4bb95237dd045090b68cf6c3990ea7
0
169eea801b40000001
admin
2019-11-25 23:01:58
RITM Vars API
Scripted REST API
global
b112773efdec73004e226c87a2b7caee
b112773efdec73004e226c87a2b7caee:-1197587906,fc123776cfec7300d0607220b65aa392:2038284928,9ca177f6c8ec730086954faafdef5415:-1197587906
INSERT_OR_UPDATE
global
customer
sys_script_include_28c2337e37ec730090b68cf6c3990e5a
<?xml version="1.0" encoding="UTF-8"?><record_update table="sys_script_include"><sys_script_include action="INSERT_OR_UPDATE"><access>package_private</access><active>true</active><api_name>global.trimAndSplit</api_name><caller_access/><client_callable>false</client_callable><description/><name>trimAndSplit</name><script><![CDATA[/**
* Converts a string to an array, much like .split(), except that it trims each element of leading and trailing whitespace.
* @param inputString {string} The string that should be split and trimmed
* @param [token=,] {string} The character to split on (usually ','). Default value is a comma character.
* @returns {Array} An array of elements that have each been trimmed of whitespace.
*/
function trimAndSplit(inputString, token) {
var i, inputArr;
var resultArray = [];
//Give token a default value if not specified
token = (!token) ? ',' : token;
if (!inputString || typeof inputString !== 'string') {
gs.logError(
'trimAndSplit function received an invalid argument in the first argument. The argument received was: ' +
inputString +
'. The only acceptable first argument for trimAndSplit, is a string.');
return [];
}
if (inputString.indexOf(token) < 0) {
//Return the original string in an array, because no instances of the token were found.
return [inputString];
}
//convert the input string to an array, splitting on the provided token (usually ',')
inputArr = inputString.split(token);
for (i = 0; i < inputArr.length; i++) {
//Trim each element in the split string array, then push it to the return array.
resultArray.push(inputArr[i].trim());
}
//return the trimmed and split array.
return resultArray;
}]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2019-04-05 18:02:49</sys_created_on><sys_id>28c2337e37ec730090b68cf6c3990e5a</sys_id><sys_mod_count>1</sys_mod_count><sys_name>trimAndSplit</sys_name><sys_package display_value="Global" source="global">global</sys_package><sys_policy/><sys_scope display_value="Global">global</sys_scope><sys_update_name>sys_script_include_28c2337e37ec730090b68cf6c3990e5a</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2019-11-25 22:50:39</sys_updated_on></sys_script_include></record_update>
-816399812
034bb95237dd045090b68cf6c3990ea7
false
admin
2019-11-25 23:01:58
474bb95237dd045090b68cf6c3990ea7
0
16ea4c27ab70000001
admin
2019-11-25 23:01:58
trimAndSplit
Script Include
global
51b8399e6e9d0450678e522359155410
51b8399e6e9d0450678e522359155410:-816399812,c687bd1ed69d04502ad059a93671bddc:1184288824,f277359a839d0450bdd857654da3422b:-462819513,8007311e989d045091d73f5e646bf088:-1384179843,4ac6bd5ae19d04502e698e2c6ff0a48a:938967086,67c2b73e80ec73008898e03f716dd703:1184288824
INSERT_OR_UPDATE
global
customer
sys_ws_operation_9022f73e37ec730090b68cf6c3990e8e
<?xml version="1.0" encoding="UTF-8"?><record_update table="sys_ws_operation"><sys_ws_operation action="INSERT_OR_UPDATE"><active>true</active><consumes>application/json,application/xml,text/xml</consumes><consumes_customized>false</consumes_customized><default_operation_uri/><enforce_acl>cf9d01d3e73003009d6247e603f6a990</enforce_acl><http_method>GET</http_method><name>get_vars</name><operation_script><![CDATA[(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
var variableName, i, ritmVariables, ritmNumber, grRitm, variablesObject, ritmNumbers;
var responseObj = {}; //The object that should ultimately be returned.
//Set ritmNumber from header value, convert to an array, and trim each element.
ritmNumbers = trimAndSplit(request.getHeader('ritm'), ','); //Calling custom script include.
//ritmNumbers = request.getHeader('ritm').split(','); //<--Commented out, but you can enable it if you don't have the trimAndSplit script include.
if (!ritmNumbers) {
//If ritm header was not set or was malformed, return an error.
response.setStatus(417);
return 'Unable to process request. Request header \'ritm\' not defined. ' +
'Please define a request header called \'ritm\' with the value set to the ticket number for the RITM you\'d like to retrieve the variables for. Value provided for RITM: ' +
ritmNumbers;
}
grRitm = new GlideRecord('sc_req_item');
//For each RITM in the ritmNumbers array...
for (i = 0; i < ritmNumbers.length; i++) {
//Get the RITM number
ritmNumber = ritmNumbers[i];
//Get the GlideRecord for the RITM, or throw an error if we can't.
if (!grRitm.get('number', ritmNumber)) { //If we can't find the RITM...
response.setStatus(417); //set the status to indicate a bad argument
response.setHeader(ritmNumber,
'Unable to locate requested ritm: ' + ritmNumber); //add a header to indicate which RITM was bad.
gs.logError(
'Scripted REST API ritm_vars_api unable to process request. RITM not found: ' +
ritmNumber); //Log an error so the admin knows what happens if the requestor asks.
continue; //Continue the loop with the next RITM in case there's anything valid we *can* return.
}
//Get the object containing the catalog variables.
ritmVariables = grRitm.variables;
//Declare a fresh object each loop.
//This will be made to contain all of the variables and variable values for the RITM we're iterating over,
//Then it will be pushed into the responseObj object, and reset for the next RITM on the next iteration.
variablesObject = {};
//Set the 'number' property on the variables object to the current ritm number. This will also be the
variablesObject["number"] = ritmNumber;
//Iterate over ritmVariables, looping through each one as v.
//This is necessary because the "gr.variables" is not a standard JS object, and cannot be mapped.
for (variableName in ritmVariables) {
//NOTE: If you want to return all variables on the catalog item associated with the RITM, remove the second condition in the IF block below.
//With the second condition, this will only show variables that have been populated.
if (ritmVariables.hasOwnProperty(variableName) && ritmVariables[variableName]) { //Make sure the property exists and isn't null or unknown.
variableName = variableName.toString(); //Make sure we're all proper strings here.
//pushing the variable into variablesObject, which will be copied into responseObject along with a version of variablesObject for each of the RITMs.
variablesObject[variableName] = ritmVariables[variableName].toString();
}
}
//Call addObjToObj function to add variablesObject to responseObj with the key set to the current RITM number, so it can be accessed as 'responseObj["RITM0123456"]'.
//NOTE: If we didn't use addObjToObj, we'd run into this problem where objects are linked rather than copied, when added to other objects in javascript.
responseObj = addObjToObj(responseObj, variablesObject, ritmNumber);
}
return responseObj; //Returning the variables and their values. Returning an object here will set the response "body" to the JSON equivalent of this object.
//Helper function below
function addObjToObj(parent, child, name) {
parent[name] = child;
return parent; //Note: Does not break pass-by-reference, because we're declaring a new object on each loop on line 39 above.
}
})(request, response);
]]></operation_script><operation_uri>/api/13231/ritm_vars_api</operation_uri><produces>application/json,application/xml,text/xml</produces><produces_customized>false</produces_customized><relative_path>/</relative_path><request_example/><requires_acl_authorization>true</requires_acl_authorization><requires_authentication>true</requires_authentication><requires_snc_internal_role>true</requires_snc_internal_role><short_description>Returns a JSON object with all populated variables' names and values.</short_description><sys_class_name>sys_ws_operation</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2019-04-05 18:00:29</sys_created_on><sys_id>9022f73e37ec730090b68cf6c3990e8e</sys_id><sys_mod_count>3</sys_mod_count><sys_name>get_vars</sys_name><sys_package display_value="Global" source="global">global</sys_package><sys_policy/><sys_scope display_value="Global">global</sys_scope><sys_update_name>sys_ws_operation_9022f73e37ec730090b68cf6c3990e8e</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2019-11-25 23:00:30</sys_updated_on><web_service_definition display_value="RITM Vars API">09817ffa37ec730090b68cf6c3990e10</web_service_definition><web_service_version/></sys_ws_operation></record_update>
476619440
034bb95237dd045090b68cf6c3990ea7
false
admin
2019-11-25 23:01:58
474bb95237dd045090b68cf6c3990ea8
0
16ea4cb81a30000001
admin
2019-11-25 23:01:58
get_vars
Scripted REST Resource
global
31fabdda9d9d0450aa70f915bccbcb5b
31fabdda9d9d0450aa70f915bccbcb5b:476619440,8356f3be3aec7300a4d32a0a6c3f68cc:1042604583,58627b3e00ec73007b9fb1f6b02308d4:-1569576793,ad427b3eebec7300ea8c51e8fd20f4c5:1725162780
INSERT_OR_UPDATE
global
customer
sys_ws_header_map_d3e3f3be37ec730090b68cf6c3990ef3
sys_ws_header_mapadmin2019-04-05 18:07:48d3e3f3be37ec730090b68cf6c3990ef30b483bf7e37ec730090b68cf6c3990e33globalglobalsys_ws_header_map_d3e3f3be37ec730090b68cf6c3990ef3admin2019-04-05 18:07:48b483bf7e37ec730090b68cf6c3990e339022f73e37ec730090b68cf6c3990e8e]]>
-1036112742
034bb95237dd045090b68cf6c3990ea7
false
admin
2019-11-25 23:01:58
834bb95237dd045090b68cf6c3990ea8
0
169eeaf6ed70000001
admin
2019-11-25 23:01:58
b483bf7e37ec730090b68cf6c3990e33
Scripted REST Header Association
global
2cf337bedaec7300c84e28c2f0401372
2cf337bedaec7300c84e28c2f0401372:-1036112742
INSERT_OR_UPDATE
global
customer
sys_ws_header_b483bf7e37ec730090b68cf6c3990e33
RITM0087923,RITM0087944,RITM0087801ritmtrueThe RITM number of the ticket(s) for which you'd like to retrieve the variables.sys_ws_headeradmin2019-04-05 18:06:42b483bf7e37ec730090b68cf6c3990e331ritmglobalglobalsys_ws_header_b483bf7e37ec730090b68cf6c3990e33admin2019-04-05 18:14:0009817ffa37ec730090b68cf6c3990e10]]>
3026896
034bb95237dd045090b68cf6c3990ea7
false
admin
2019-11-25 23:01:58
cf4bb95237dd045090b68cf6c3990ea7
0
169eeb51da20000001
admin
2019-11-25 23:01:58
ritm
Scripted REST Header
global
a35573be3fec7300394c03f9a8fedf23
a35573be3fec7300394c03f9a8fedf23:3026896,94b333be67ec7300c8159e8bcdb6ed83:-1678163559