globalGlobalglobalSnowMirror Performance API improves download times.SnowMirror Performance API 6.4.46bddc64593d4c7103998f1965d03d69cloadedsys_remote_update_setadmin2026-04-15 12:22:12dafd0e4593d4c7103998f1965d03d6dc0admin2026-04-15 12:22:12INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_app_210f92c1dbba7150e42281791396195ctruetruelogfalsefalsehelsinki_es5truenonenonefd0fd2c1dbba7150e422817913961992SnowMirror Performance APIfalsefalsepermissiveglobalfalseAllows SnowMirror to download data faster compared to using traditional REST API.210f92c1dbba7150e42281791396195csys_appadmin2023-11-27 15:17:54210f92c1dbba7150e42281791396195c11admin2026-04-15 11:56:40truefalse0e2fd6c1dbba7150e4228179139619a46.4.4700000trueimage/svg+xmlsm-snowflake.svgd662684abb63b8532f3ea420652a710824b1231158726f6f79cc518d22b8999f49952089availableadmin2023-11-27 15:17:56fd0fd2c1dbba7150e4228179139619921system2023-11-27 15:17:56sys_app210f92c1dbba7150e42281791396195cH4sIAAAAAAAAAA==160fd0fd2c1dbba7150e422817913961992admin2023-11-27 15:17:56310fd2c1dbba7150e422817913961993dVjLblxFEN0j8Q+tkSKBRNr9fjgxkbgSq2EHG3YhGWwL47HsIU74ek69eowEiyjjure7q06dOlV93777/Oed+3R4fLo93l/tog87d7j/cPx4e399tfvl5x9fj92777/+6u3Tp2uHV++frnY3p9PD5cXF8/Ozf87++Hh9kUIIF3hj555vP55usE8ID5937uZwe31zoj8r/fnp9vD8w/Hz1S644GJI+Nd3Lw+POzrq4f3pxj2dvtwdrnb4//H4x+Hy/nh/ePP77d3d68e/7vjPvw+PR7ZcPl7/9k33o+SY+6vvyvnnHJ5/5Vffytrjw/sPt6cvl/HNzn282v0EB6Ifuc48XA++9FZbchub60ghR9ewB/6sDcbgO0yputZ8aaNXN6fPsZXQXCt+hoZnm5vdzzTbGK5ln3lTN5sPk3+15FMeaUQ3iw9NFkffc8mdVycfMm1F1pRDadON6cdEVINsuUbycuAUWoH9gri6uVH9lBhgHWHUWdwoPg1aQi7GmOnkkT09pP2q58XJ7V1DfLUP/K7VR/6JPelECbFmX0pUf8tgf2v0LVTykbyV1QXehrBW0y/gUobPs1SCNHgOG292HxIiL2QTaEs1J/ZuwKHBUGQARHERQCP5Klvm7FvsEUAP/FEMQyBjLxTgxmcC1+BjTXRWrp5cxjJg3Wal6PFmKi0AL2RFs5zxVBLaYCIj+cGRJQduqetp2CbEt8BHpGaHbWTtXd4kfzkBsMXOFEnYMdJyPiUlokgclm6srj7x9i7iOUUIt7MRJ66nCK9KULF45iaQGkYl2KKkCRTRNMCmSQQdYuHzIqFPKwPYzP5HpCgy8n36RK/BNpHUkuJ0naoDgUyKo0ocm+udgUO4s/ECGLpwEMBoyrB0NAYDADJ+FSmvACYwr0vyU9i2udqMZSUamyvCnPy8gDuV+VaTgZBRmI3P2dPqkSc7XnyWauc9JxKexwtr7VYX/7KluN6TmtrIT0ZRoeWKBIeryELMlhaqbF0drTY3rk5mNkTFt25aUbm03TSOkUnCgQ9GfzIK+NVXLZ5koWSLFOeOxG8BkmhLgzADQivI1WloB5/ldYSbxbUgSR4MVvVNGPI6mDRADsYAxhNvJikP4K90iGf+12DpTaaBpBByCIIpiRbAlIXz1Wi2kWZMeEAq54fIayHusWANQ452E4UCmqkS4+XYqkWysIBaUXolQ0phUjVhKWxdsranPSM1BqjFMO6yPwomWYnI03G/4ajOb8J2Xq0nYjVpDAMKdiYp9bLKBixWjuMp018Vb0/1ppKEUulJSZQCtuYFKCrTnWjNAMXXpXngPdFFPEyWUGzZJPMQmy6YodRn5TxCarg0EwuCihKEw1QdSJXBPSxSjTOn4E3mk2HSkIZPLMMokVBUk6q5BWOVRGZtpjhVokSllEm5gW8xM8U2kKxIU0U8KtXgorbSlLxIWbB2k6pRkZZmIU9ChJMRQNtq/DQHa6jZKJ6pA2vGqwGBXtOZiUu50TKq0DlSn9J+Uya7xhhlKQ9YldrAUFOG7bKC01e/AReQ7Yz2xbJNvbBWhTw3kxmQUMcCNDLxCbzW8sVrJUl5FtOMPcGjL04kjtduRIcuOELMwmDZIK6IxL2QwmHtmmTYqvrcF2C1vrC6EWyqInHxEDuq2GB1WhLUbQADitou4KWdHZaQBssEeqIxB8KnyUBcIseQR5WM6acQoL2AMYY1hXRbC30omasVw14VIODgEFo0nJayNGNwNkkLpmlRuwdmLoEUtiE9B+A0AbyvWYdrLkvH49VFAZ+SL5yja1Ja09kw0m9U0Ep78pzfW6FShEr7QghwbbJGFMsSrDre0jIhacumpWRT/JI5zExUiUWWdDyFoGm4yJIqFKRLywpthw3Zig/bKcn2xE2du0bzVQaTjSpBtQTWpJUQTO5hk8JOa4rCVKOls/E4Id7SiKx1L9lPKiaAgN+oNNlVkyEChrmIYV1nKZhU3DHV60SXqrUOuhIwYxnWbroUQ7GfCaIuQotRyzpBPvf/8DLoYg0CVyCopAy5zThHRq3IPM9v1vMEwX2DnSUPdJAq2ZsDyZwtxWSb7i+LyYVKlfsXjaJSWGRjDDFzCk60WLoXj5wMeVm3AIycmn9kncuPctO08U3LEo3jIqdoq810F9zTOX/jFirHUPXKrHDu82RTxp3VIJtqcKOXlTod13Vtgk29oWvK5JZC45Pkm4dNYw+NRPx844FPeixuGjbYNBsCMSurXGMmIrf49uGLolOraf3oNnLT8MQpJnh0sK/N9AMoljXnLi5MsE1vWENRRgp08mqk0nKByefhBLWn2M2yRC5bjZJNVKGZt7SYx8Ju7ZmOoDhZCTUO8kRreRoI8FmVbCMt0wsMRSfNo4d1c11toq1bIV1BZF7byKo3kHY+WEZYoK+Vheu2TpqUp6I3I4qD19LFTiWuCUC4qmjTIVBEQWFTidvzdCx9+KW12hUeorUcpJ4nskwXYZlw6JKy+inzFv/btQTdmVouPFVKD3N+Y/dXX8jiwVg35B6NHSNa8fS8qEU76ovFUkIYNf460dv6MJBtfKF7mFBwI+uU7xjni9dYF2GCQZ5CcHVsGcEi3yiNOv2sXgnBVbUe0W7Z4IXdwSG/MUrUkGKdRDilTEIwzYpn6SpddWU+pfh7lDlqNssqHFIxpi8sPAez4/YlxqIe1oY31jy9c9AdVBSPjAo0UFPBjFYeBO7QZsefh2Svvq5nJK5BdBQZ01b6nx+SfnX/84Vpd0HfueiLGf7/B039IHyDEwAA27721fd0fd2c1dbba7150e422817913961992admin2023-11-27 15:17:56b10fd2c1dbba7150e422817913961993]]>-576710617dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1212fd0e4593d4c7103998f1965d03d6dd019d91002d7f0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiPropertiesScript Includeglobal1a5a428d3a94c7107bf26b2361fcd20a1a5a428d3a94c7107bf26b2361fcd20a:-1794273980,7a9b05a8ee753210eb7b8ec8a22f02e2:-1794273980,759d79386832c610f101ee0a7a38d345:-863442572,02da7df01732c61060ec027d2ff0cdc5:-863442572,fe7553ab468b79104ac616b4ca2ea63c:-863442572,8bb7de0c0407bd50b5d4bc76c4f0393e:-1863065406,cb27120cc007bd50b58dd2d43762cd1c:-964174983,c65665080a43bd50026083848b385975:-990597559,cf336d445e43bd5058a5fb5b93e0ae04:-1206530161,f1ff4dc00d03bd5098949499e6bd722b:84386664,1f4f0dc0d003bd50f23ea2c87d36baff:-1276072194,01de0580a103bd50c72897c290e5a180:1074411608INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_6b1296c4db07bd50d1200bd3e29619bbsysparm_display_valuefalseDetermines whether to return display values. The same as in Table API.sys_ws_query_parameteradmin2023-12-06 22:04:026b1296c4db07bd50d1200bd3e29619bb0sysparm_display_value210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_6b1296c4db07bd50d1200bd3e29619bbadmin2023-12-06 22:04:028bd06245dbba7150e42281791396194a]]>1208519428dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1212fd4e4593d4c7103998f1965d03d62c019d90ff24370000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiParamsLoaderScript Includeglobal12780a498e94c710ce2c61b86d05968d12780a498e94c710ce2c61b86d05968d:-1707759082,7d4bd6d01833f6109285da3f0bda03b3:1172039672,968bc1a80375321077645f088cc0b531:1329892083,0196fa4d66005610855c4e547db2879b:1567621699,15e402750fd002105d541796d1c493f6:-1229647794,90d3fa49250056100f63b288d13917b5:1567621699,15e402750fd002105d541796d1c493f6:-1229647794,dd9d39382d32c610173aafcfffaeaedf:-1229647794,15e402750fd002105d541796d1c493f6:-1229647794,a1da7df0b832c61019f6ec9acd12b411:-1229647794,15e402750fd002105d541796d1c493f6:-1229647794,7f8372fc421cc610e0203d4a9fd3567b:-1229647794,ecc466ecb35886101b8d1c5c15b7d7e9:-504522447,ed89a85422dc06106de81f15c9ee6529:-622107912,0647e0d073dc061008dc54c4ac6043aa:-723942726,a6459f6ba88b7910a1ea2b229b0d9f34:-1044144558,893a58f9080bb11073c892ce43c8c3cf:-1378870052,2e47083949c7b110da04aef1e559c8e8:387550685,70e404b50ac7b110149a9c31dcc3c905:-1693382945,76948c756ec7b110139abb4fad387e71:-203591325,c634087587c7b110914ff732b5097705:-1801839080,1ea73769d587b110b0bc04e438bedce7:-1378870052,8590a26c46c3319059d57cee84fd26bf:-155887191,719f162c28c33190d590f2c1a9e929a9:214552439,308f96e863c331902cd97b79a6aa1970:921864669,b2a75e0cf807bd5048d8a84f3930fd50:-155887191,a1e38e48d1c3bd503b7b0f036f425180:-788845538,06dcf90091c3bd50b9ed189f61f64a08:-82097839,5bd5edc4c843bd508567e341ffd015b8:-788845538,8c1329444443bd5047a0338cbcceb44d:-1920782111,fea011447c03bd5050127406b5c68a48:-2088677984,02809904cb03bd508ee38b7a2177726c:2085489024INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_2573da08db07bd50d1200bd3e29619a8sysparm_sum_fieldsfalseList of fields on which to perform SUM operation. Same as Aggregate API.sys_ws_query_parameteradmin2023-12-06 22:09:352573da08db07bd50d1200bd3e29619a80sysparm_sum_fields210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_2573da08db07bd50d1200bd3e29619a8admin2023-12-06 22:09:358bd06245dbba7150e42281791396194a]]>-1181577053dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:121afd4e4593d4c7103998f1965d03d629019d90ff245f0000001admin2026-04-15 12:22:12
sysparm_sum_fieldsScripted REST Query Parameterglobal37835e08f907bd50596ee387ad2ed02b37835e08f907bd50596ee387ad2ed02b:-1181577053,37835e08f907bd50596ee387ad2ed02b:-1181577053INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_ccd4de48db07bd50d1200bd3e2961941sm_limit_with_aclfalseHow many records to return for ACL-restricted table?sys_ws_query_parameteradmin2023-12-06 22:15:35ccd4de48db07bd50d1200bd3e29619410sm_limit_with_acl210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_ccd4de48db07bd50d1200bd3e2961941admin2023-12-06 22:15:358bd06245dbba7150e42281791396194a]]>1262196864dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:121afd4e4593d4c7103998f1965d03d62e019d90ff24840000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiEnvLoaderScript Includeglobalb73982c94e94c7100f60b5d35e3de4f6b73982c94e94c7100f60b5d35e3de4f6:109655935,50398e89f994c710ec54f735fb60cf77:-1665034223DELETE210f92c1dbba7150e42281791396195ccustomersys_script_include_79748a3593d002100f94f1d97bba1021<?xml version="1.0" encoding="UTF-8"?><record_update table="sys_script_include"><sys_script_include action="DELETE"><access>package_private</access><active>true</active><api_name>global.SnowMirrorPerformanceApiOperationStatsUsingGlideRecord</api_name><caller_access/><client_callable>false</client_callable><description>Provides access to aggregate operations implemented using GlideRecord.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiOperationStatsUsingGlideRecord</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiOperationStatsUsingGlideRecord = Class.create();
SnowMirrorPerformanceApiOperationStatsUsingGlideRecord.prototype = {
initialize: function(env) {
this.env = env;
},
run: function() {
var env = this.env;
var tableName = env.tableName;
var params = env.params;
var responseWriter = new SnowMirrorPerformanceApiStreamWriter(env);
var countGR = null;
if (params.sysparmCount) {
countGR = env.precondition.checkAcl() ? new GlideRecordSecure(tableName) : new GlideRecord(tableName);
}
var maxGR = null;
if (params.sysparmMaxFields.length > 0) {
maxGR = env.precondition.checkAcl() ? new GlideRecordSecure(tableName) : new GlideRecord(tableName);
}
try {
responseWriter.start(function() {
// COUNT
if (countGR != null) {
countGR.addEncodedQuery(params.query);
countGR.setWorkflow(env.precondition.runBusinessRules());
if (params.category) {
countGR.setCategory(params.category);
}
}
// MAX
if (maxGR !== null) {
maxGR.addEncodedQuery(params.query);
maxGR.orderByDesc(params.sysparmMaxFields.join(","));
maxGR.setLimit(1);
maxGR.setWorkflow(env.precondition.runBusinessRules());
if (params.category) {
maxGR.setCategory(params.category);
}
}
}, env.response);
responseWriter.query(function() {
if (countGR != null) {
countGR.query();
}
if (maxGR !== null) {
maxGR.query();
}
});
responseWriter.stream(function(writer) {
var statsResponse = {
'stats': {}
};
if (countGR != null) {
statsResponse['stats']['count'] = countGR.getRowCount();
}
if (params.sysparmMaxFields.length > 0) {
statsResponse['stats']['max'] = {};
while (maxGR != null && maxGR._next()) {
for (var i in params.sysparmMaxFields) {
statsResponse['stats']['max']['' + params.sysparmMaxFields[i]] = maxGR.getValue(params.sysparmMaxFields[i]);
}
}
}
writer.writeString('"result": ' + JSON.stringify(statsResponse));
});
} finally {
responseWriter.close();
}
},
_addAggregateFieldsToGlideAggregate: function(recordGA, operation, fields) {
for (var i in fields) {
recordGA.addAggregate(operation, fields[i]);
}
},
type: 'SnowMirrorPerformanceApiOperationStatsUsingGlideRecord'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2024-02-12 10:51:51</sys_created_on><sys_id>79748a3593d002100f94f1d97bba1021</sys_id><sys_mod_count>3</sys_mod_count><sys_name>SnowMirrorPerformanceApiOperationStatsUsingGlideRecord</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_79748a3593d002100f94f1d97bba1021</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2025-12-10 11:35:29</sys_updated_on></sys_script_include></record_update>-595479547dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:121efd4e4593d4c7103998f1965d03d625019d90ff25700000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiOperationStatsUsingGlideRecordScript Includeglobalb97b01a8b875321030bd4bd531d5cfb5b97b01a8b875321030bd4bd531d5cfb5:-595479547,e5fa4d280575321095ac3c4e1426eec1:-29110535,9466b64dc000561059594a4164f9143d:-1246280055,841f79f8f832c610c1c89dd9773b52f0:741820051,06c0ea0140cc1610cf3525e78a79aa12:-1246280055,841f79f8f832c610c1c89dd9773b52f0:741820051,7a8482350fd0021011d096ed79cdb806:-172731432,e19d3938b532c610e974adfffb44d1f8:815156476,7a8482350fd0021011d096ed79cdb806:-172731432,46da7df06c32c610bd68542fbfbd6688:815156476,7a8482350fd0021011d096ed79cdb806:-172731432INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_3dd29ec4db07bd50d1200bd3e2961923sysparm_countfalseReturn the number of records or not. Same as Aggregate API.sys_ws_query_parameteradmin2023-12-06 22:07:103dd29ec4db07bd50d1200bd3e29619230sysparm_count210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_3dd29ec4db07bd50d1200bd3e2961923admin2023-12-06 22:07:108bd06245dbba7150e42281791396194a]]>1710781598dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:121efd4e4593d4c7103998f1965d03d62a019d90ff244a0000001admin2026-04-15 12:22:12
v1Scripted REST Versionglobal3dd592c86607bd5051b58a824c01851b3dd592c86607bd5051b58a824c01851b:1639289680,3dd592c86607bd5051b58a824c01851b:1639289680,79d592c87407bd50e51867255697f118:-649752495INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_7eda6feddb3af150e422817913961909Decides whether SnowMirror Performance API runs business rules. Possible values:
- false/not defined/empty value: Performance API does not run business rules.
- true: Performance API runs business rules.truefalsesnowmirror.performance-api.business-rules.enabledsys_propertiesadmin2023-11-29 10:07:147eda6feddb3af150e4228179139619092snowmirror.performance-api.business-rules.enabled210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_7eda6feddb3af150e422817913961909admin2023-12-18 10:17:27booleanfalse]]>-1906030146dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1252fd0e4593d4c7103998f1965d03d6e0019d90ff253d0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiStreamWriterScript Includeglobal887a068daf94c7107fc64b674e3d742a887a068daf94c7107fc64b674e3d742a:-862365791,3f9b45a857753210c67b966d7093cf8a:-862365791,559d39388332c6102b810482fff296c7:768097841,9dda7df00532c610b96e46c049180c04:768097841,ca95d3abd18b791079f29c86365211bc:768097841,a7a00c71e2c7b1103260a307bff32fb5:-675567018,d41a7be97687b1109d818a33a3ec21a8:1149724258,6be937e9f087b110bfd79145acbf8d5b:-652657124,24f6c2641d8331906634c7787246dcbf:-1456446097,6e258ae08d8331905ae145a7ddd0c2ed:171887310,7e48028c4ac3bd509c25c9481398a609:1181976711,48188e4c95c3bd506d649edb5f2f2b75:2015231207,fd174a0c5bc3bd50a5f8fe89d5c729c1:1672975739,b846c20cc5c3bd5086181d3aadbf3d01:-144301026,a0a3864855c3bd50ead68103bf0e4e65:388484434,a392060841c3bd506f34be92e64ac5db:2054282578,7e5675c49a83bd507c211f671384a319:1076939623,55e5f584b583bd5053e2f38c33e0e4c0:-1304208851,1540bd40a783bd503a44c1d331fb74cf:1724577065,cafe29005283bd50b1e77e3eb2a03ed2:1895421252,4fbee500ee83bd50c6dcda633acaa528:630303237,126eedccec43bd50a0002e9c062c398c:-914897349,6b2e2dcc2043bd50710c3f46ecea5422:920854795,d2fd29ccca43bd502acf0ee95cb8e790:1798787280,c4cd65cc9343bd5076cdb3bf7e9ab2d2:545106553,678d65cc3943bd50e640c3cedf7e3f38:-955494066,5253ed448643bd50ff7df5290d753262:-1569683529,abaf15806c43bd50097bc6c9dcadfe3e:-508395328,748555480003bd50028316967dd6b7dd:-1294711839INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_841b8e8d9394c7103998f1965d03d640<?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.SnowMirrorPerformanceApiOperationAttachmentBatch</api_name><caller_access/><client_callable>false</client_callable><description>Downloads (streams) multiple attachments as a JSON. Attachment data is encoded with Base64.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiOperationAttachmentBatch</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiOperationAttachmentBatch = Class.create();
SnowMirrorPerformanceApiOperationAttachmentBatch.prototype = {
initialize: function(env) {
this.env = env;
},
run: function() {
var env = this.env;
var params = env.params;
var logger = env.logger;
var responseWriter = new SnowMirrorPerformanceApiStreamWriter(env);
var sysAttachment = env.precondition.checkAcl() ? new GlideRecordSecure('sys_attachment') : new GlideRecord('sys_attachment');
// Read in a loop and stream the response
try {
responseWriter.start(function() {
sysAttachment.setWorkflow(env.precondition.runBusinessRules());
if (params.category) {
sysAttachment.setCategory(params.category);
}
}, env.response);
responseWriter.stream(function(writer) {
var result = {
'error': ''
};
writer.writeString("\"result\": [");
var gsa = new GlideSysAttachment();
var maxDurationExceeded = false;
var recordWritten = false;
for (var i = 0; i < params.attachmentSysIds.length; i++) {
if (!sysAttachment.get(params.attachmentSysIds[i])) {
continue;
}
try {
if (recordWritten) {
writer.writeString(', ');
}
writer.writeString('["');
writer.writeString(params.attachmentSysIds[i]);
writer.writeString('", "');
writer.writeString(GlideStringUtil.base64Encode(gsa.getBytes(sysAttachment)));
writer.writeString('"]');
recordWritten = true;
var durationMillis = (Date.now() - env.startProcess);
maxDurationExceeded = params.smMaxDurationInSeconds && (durationMillis > params.smMaxDurationInSeconds * 1000);
logger.trace('Duration ms: ' + durationMillis + ', sm duration: ' + (params.smMaxDurationInSeconds * 1000) + ', exceeded: ' + maxDurationExceeded);
if (maxDurationExceeded) {
result.error = 'Transaction cancelled: maximum execution time exceeded. Performance API is allowed to run for at most ' + params.smMaxDurationInSeconds + ' seconds.';
break;
}
} catch (error) {
if (error instanceof Error) {
logger.error(error.message);
logger.error(error.stack);
result.error = error.message ? error.message : '';
} else {
logger.error(error);
result.error = error ? '' + error : '';
}
logger.error("SysId: " + params.attachmentSysIds[i]);
result.error += ', SysId=' + params.attachmentSysIds[i];
break;
}
}
writer.writeString("]");
return result;
});
} finally {
responseWriter.close();
}
},
type: 'SnowMirrorPerformanceApiOperationAttachmentBatch'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2026-04-15 12:09:30</sys_created_on><sys_id>841b8e8d9394c7103998f1965d03d640</sys_id><sys_mod_count>0</sys_mod_count><sys_name>SnowMirrorPerformanceApiOperationAttachmentBatch</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_841b8e8d9394c7103998f1965d03d640</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:09:30</sys_updated_on></sys_script_include></record_update>952689664dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1252fd4e4593d4c7103998f1965d03d626019d910beb3a0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiOperationAttachmentBatchScript Includeglobald81b8e8d8e94c7109772ce4520ee5442d81b8e8d8e94c7109772ce4520ee5442:952689664INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_6263d608db07bd50d1200bd3e296195dsysparm_max_fieldsfalseList of fields on which to perform MAX operation. Same as Aggregate API.sys_ws_query_parameteradmin2023-12-06 22:08:586263d608db07bd50d1200bd3e296195d0sysparm_max_fields210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_6263d608db07bd50d1200bd3e296195dadmin2023-12-06 22:08:588bd06245dbba7150e42281791396194a]]>-1978930148dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1252fd4e4593d4c7103998f1965d03d62b019d90ff245a0000001admin2026-04-15 12:22:12
snowmirror.performance-api.defaultLimitAclRestricted.SnowMirror Performance APICategory Propertyglobale72ad2cc2907bd5053839331e00111d1e72ad2cc2907bd5053839331e00111d1:-1761722813,e72ad2cc2907bd5053839331e00111d1:-1761722813,06691a8c9a07bd502421d6304eae5cdf:1919607427INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_security_acl_a818c9c6dbfa3550e4228179139619d9truefalsefalseProvides access to SnowMirror Performance API endpoint.LocalSnowMirror Performance API accessexecutesys_security_acladmin2023-11-30 11:32:34a818c9c6dbfa3550e4228179139619d92SnowMirror Performance API access210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_security_acl_a818c9c6dbfa3550e4228179139619d9admin2023-12-06 21:52:14REST_Endpoint]]>1170894153dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1256fd4e4593d4c7103998f1965d03d627019d90ff242b0000001admin2026-04-15 12:22:12
SnowMirror Performance API access
SnowMirror Performance API accessAccess Controlglobalb59f02445e07bd50383490022cac64adb59f02445e07bd50383490022cac64ad:226602571,b59f02445e07bd50383490022cac64ad:226602571,1b8fce041507bd5007666f41be2b679b:-1193976788,06384dc6c8fa35505f8cdb528f6e14c9:1817124090INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_76041648db07bd50d1200bd3e29619fcsm_compress_empty_fieldsfalseShould we compress consecutive empty fields? Values: true, falsesys_ws_query_parameteradmin2023-12-06 22:12:1576041648db07bd50d1200bd3e29619fc0sm_compress_empty_fields210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_76041648db07bd50d1200bd3e29619fcadmin2023-12-06 22:12:158bd06245dbba7150e42281791396194a]]>-236688621dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1256fd4e4593d4c7103998f1965d03d62c019d90ff24690000001admin2026-04-15 12:22:12
snowmirror.performance-api.acl.includes.SnowMirror Performance APICategory Propertyglobal3bf992cce107bd507dd4423f95b1775f3bf992cce107bd507dd4423f95b1775f:-159663856,3bf992cce107bd507dd4423f95b1775f:-159663856,4e691a8c7c07bd500bd4c480860e91ea:-1684437609INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_operation_031d0a8193d4c7103998f1965d03d6a4<?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</consumes><consumes_customized>false</consumes_customized><default_operation_uri>/api/gvs/performance_api/attachment/files</default_operation_uri><enforce_acl>a818c9c6dbfa3550e4228179139619d9</enforce_acl><http_method>GET</http_method><name>Attachment Batch</name><operation_script><![CDATA[/**
* SnowMirror Performance API - Attachment Batch API which allows you to download multiple attachments in a single batch. The response looks like: { "result": [ ["attachment_sys_id_1", "base64_data_of_attachment_1"], ["attachment_sys_id_2", "base64_data_of_attachment_2"]]}. The response may also contain "parse_duration" and "error" fields.
*
* Custom API for SnowMirror that provides an alternative for "table" and "stats" operations. The purpose of this API
* is to improve download times. It achieves better performance by:
* - turning off ACL checks
* - turning off business rules
* - streaming the results
*
* Security:
* A user needs to have a have "snowmirror_performance_api" role assigned to be able to use Performance API.
*
* The API is configurable via system properties:
*
* Request parameters:
* - sm_debug - should we return debugging information in the response and log it to the activity log? Messages are
* being collected on the server side and streamed to end of the response. Therefore, it is suitable only
* for debugging purposes mostly on smaller requests.
* - off: no logging information. This is also a default option if the parameter is empty or not present.
* - trace: the most detailed information
* - debug: detailed information
* - info: smaller number of log information
* - sm_retrieve_logs - should we return logs and log them to the activity log? Messages are being collected
* on the server side and streamed to end of the response. Therefore, it is suitable only
* for debugging purposes mostly on smaller requests.
* - true - return logs
* - anything else - do not return logs
* - sm_max_duration - for how long (in seconds) can this script process a single request?
*/
(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
var env = new SnowMirrorPerformanceApiEnvLoader().run(request, response, 'attachment');
env.logger.info('Start: ' + env.operation + '/file');
new SnowMirrorPerformanceApiOperationAttachmentBatch(env).run();
})(request, response);]]></operation_script><operation_uri>/api/gvs/v1/performance_api/attachment/files</operation_uri><produces>application/json</produces><produces_customized>false</produces_customized><relative_path>/attachment/files</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/><sys_class_name>sys_ws_operation</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2026-04-15 12:18:26</sys_created_on><sys_id>031d0a8193d4c7103998f1965d03d6a4</sys_id><sys_mod_count>0</sys_mod_count><sys_name>Attachment Batch</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_ws_operation_031d0a8193d4c7103998f1965d03d6a4</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:18:26</sys_updated_on><web_service_definition display_value="SnowMirror Performance API">8bd06245dbba7150e42281791396194a</web_service_definition><web_service_version display_value="v1">75d592c8db07bd50d1200bd3e2961916</web_service_version></sys_ws_operation></record_update>-1593964843dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:125afd4e4593d4c7103998f1965d03d628019d911419ec0000001admin2026-04-15 12:22:12
Attachment BatchScripted REST Resourceglobal871d0a81a1d4c7103c815685da90bba6871d0a81a1d4c7103c815685da90bba6:-1593964843INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_9d349648db07bd50d1200bd3e29619e2sm_max_durationfalseFor how long (in seconds) can this script process a single request?sys_ws_query_parameteradmin2023-12-06 22:12:419d349648db07bd50d1200bd3e29619e20sm_max_duration210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_9d349648db07bd50d1200bd3e29619e2admin2023-12-06 22:12:418bd06245dbba7150e42281791396194a]]>1252587791dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:125afd4e4593d4c7103998f1965d03d62d019d90ff24700000001admin2026-04-15 12:22:12
snowmirror.performance-api.business-rules.excludes.SnowMirror Performance APICategory Propertyglobalac1a52cc0107bd5065abf51f3491a1dcac1a52cc0107bd5065abf51f3491a1dc:319087191,ac1a52cc0107bd5065abf51f3491a1dc:319087191,c2691a8c7807bd50673e7c879c7b69e6:1429842804INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_69c7f48cdb8f7d50d1200bd3e29619a4<?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.SnowMirrorPerformanceApiLogger</api_name><caller_access/><client_callable>false</client_callable><description>Logs data to ServiceNow logs using GSLog. On top of that, it allows us to gather log messages into an array. Later, this array can be written to a response so that SnowMirror can read the logs.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiLogger</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiLogger = Class.create();
SnowMirrorPerformanceApiLogger.prototype = {
initialize: function(request) {
this.gsLog = new GSLog(gs.getProperty('snowmirror.performance-api.logger.level', 'SnowMirror'));
this.logs = [];
this.level = (request.queryParams['sm_debug'] ? request.queryParams['sm_debug'][0] : 'warning').toLowerCase();
this.retrieveLogs = request.queryParams['sm_retrieve_logs'] !== null && request.queryParams['sm_retrieve_logs'] !== undefined && request.queryParams['sm_retrieve_logs'][0] === 'true';
this.gsLog.setLevel(this.logLevelsServiceNow[this.level]);
},
'level': function() {
return this.level;
},
'logLevels': {
'trace': 0,
'debug': 1,
'info': 2,
'warning': 3,
'error': 4,
'off': 5
},
'logLevelsServiceNow': {
'trace': 'Debug',
'debug': 'Debug',
'info': 'Info',
'warning': 'Warning',
'error': 'Err',
'off': 'Crit'
},
'enabled': function() {
return this.logLevels[this.level] !== undefined && this.level !== 'off';
},
'trace': function(val) {
this.log('trace', val);
},
'debug': function(val) {
this.log('debug', val);
},
'info': function(val) {
this.log('info', val);
},
'warning': function(val) {
this.log('warning', val);
},
'error': function(val) {
this.log('error', val);
},
'log': function(level, val) {
if (this.logLevels[this.level] <= this.logLevels[level]) {
var logMessage = '[' + level.toUpperCase() + '] ' + val;
this.gsLog.log(this.logLevelsServiceNow[level], val);
if (this.retrieveLogs) {
this.logs.push(new Date().toISOString() + ' ' + logMessage);
}
}
},
'logMessages': function() {
return this.logs;
},
type: 'SnowMirrorPerformanceApiLogger'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2023-12-06 15:42:35</sys_created_on><sys_id>69c7f48cdb8f7d50d1200bd3e29619a4</sys_id><sys_mod_count>23</sys_mod_count><sys_name>SnowMirrorPerformanceApiLogger</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_69c7f48cdb8f7d50d1200bd3e29619a4</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 11:59:46</sys_updated_on></sys_script_include></record_update>-480594773dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:125efd4e4593d4c7103998f1965d03d624019d910302400000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiLoggerScript Includeglobal21d846894994c71014932de1a3cf957421d846894994c71014932de1a3cf9574:-480594773,a2ca492875753210201d9665fb6ecbff:-480594773,ad9d3938b632c6104423b4e3414933e3:1600947131,61da7df09c32c61048f8cc09efb71c15:1600947131,fd25db6bbb8b7910fa372c95f7cc58ba:1600947131,c8b2c5e3d5837910a29a59bcf34699ca:1696580718,423205e317837910b0129e322077b4de:-1513763895,4c61c5a33e837910b9715161e3356b28:-1889189433,c93369944a03fd5095a9d9378a26910d:-1373192678,0d19d28c7c07bd503eeaf26ed057d3b4:1633912430,8b78d24cc407bd5036b35181c3aedb98:-1687391444,8658828c46c3bd501f2c74bdce8580d4:-120958380,00080e4cb5c3bd5047c7f600c1f98b64:-586370519,83b7c64c98c3bd50415a5031af9b39d3:514563465,4f87824c3dc3bd50e865dd883d2665f6:-915458508,fae64a0cdcc3bd509160e564a56a20bb:-1283834077,5db6420cc4c3bd5026dabf33895d8f0b:380368716,0fc482883ec3bd50e16a12c3ca3825e3:-1283834077,549fed00e083bd50e43f10802a725694:-88080740,cb4ce94c2343bd5023d84ed0d998d55a:-352649689,6ceb694c9a43bd506b5f0470ec26e332:1019848705,9375e9c47b43bd507cc55b9cde8587a7:1720840971,24a22d041143bd50fa389665bd1ae56c:144123616,1ed2490850cf7d5093bd144a2cfc5b56:671944305,c5cff8443bcf7d50b4ea67b7a6ae9a95:-845324641,7afafc00b8cf7d5009ef50145881de6b:-1591983227INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_2a6292c4db07bd50d1200bd3e29619bbsysparm_fieldsfalseComma-separated list of fields to return in the response. Same as Table API.sys_ws_query_parameteradmin2023-12-06 22:05:132a6292c4db07bd50d1200bd3e29619bb0sysparm_fields210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_2a6292c4db07bd50d1200bd3e29619bbadmin2023-12-06 22:05:138bd06245dbba7150e42281791396194a]]>-1101236295dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:125efd4e4593d4c7103998f1965d03d629019d90ff243b0000001admin2026-04-15 12:22:12
sysparm_fieldsScripted REST Query Parameterglobalb7821ec41107bd50e1845ae7f9df3739b7821ec41107bd50e1845ae7f9df3739:-1101236295,b7821ec41107bd50e1845ae7f9df3739:-1101236295INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_ff452220db988610d1200bd3e29619d3sm_count_typefalseHow to count records: using GlideAggregate or using GlideRecord.getRowCountsys_ws_query_parameteradmin2024-02-08 16:03:12ff452220db988610d1200bd3e29619d30sm_count_type210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_ff452220db988610d1200bd3e29619d3admin2024-02-08 16:03:128bd06245dbba7150e42281791396194a]]>-1940870660dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:125efd4e4593d4c7103998f1965d03d62e019d90ff25420000001admin2026-04-15 12:22:12
ff452220db988610d1200bd3e29619d3Scripted REST Query Parameter Associatioglobal3085e2208b9886102b884fa0593628f43085e2208b9886102b884fa0593628f4:-590839051INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_298b6721db7af150e4228179139619abComma separated list of tables which should not run business rules. If running business rules is enabled, we will not run business rules only for these tables.truefalsesnowmirror.performance-api.business-rules.excludessys_propertiesadmin2023-11-29 10:09:49298b6721db7af150e4228179139619ab1snowmirror.performance-api.business-rules.excludes210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_298b6721db7af150e4228179139619abadmin2023-12-06 21:40:31string]]>1705044544dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1292fd0e4593d4c7103998f1965d03d6df019d90ff241c0000001admin2026-04-15 12:22:12
snowmirror.performance-api.business-rules.excludesSystem Propertyglobal31ec86803807bd5087470696a9e9ac5f31ec86803807bd5087470696a9e9ac5f:1705044544,31ec86803807bd5087470696a9e9ac5f:1705044544,98bba721807af150ed601e3a0a6a244c:-2070193583INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_fa3b6321db7af150e422817913961988Comma separated list of tables which should always run business rules. If running business rules is disabled, we will run business rules only for these tables.truefalsesnowmirror.performance-api.business-rules.includessys_propertiesadmin2023-11-29 10:08:56fa3b6321db7af150e4228179139619881snowmirror.performance-api.business-rules.includes210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_fa3b6321db7af150e422817913961988admin2023-12-06 21:40:41string]]>-1284280006dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1292fd0e4593d4c7103998f1965d03d6e4019d90ff24210000001admin2026-04-15 12:22:12
snowmirror.performance-api.business-rules.includesSystem Propertyglobaldcfcc680c607bd50ebeaef73e3d1a889dcfcc680c607bd50ebeaef73e3d1a889:-1284280006,dcfcc680c607bd50ebeaef73e3d1a889:-1284280006,937b6321a57af150551291273744fecb:-304394729INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_6ece3d24dbd48610d1200bd3e2961973<?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.SnowMirrorPerformanceApiOperationStatsUsingGlideRecord</api_name><caller_access/><client_callable>false</client_callable><description>Provides access to aggregate operations implemented using GlideRecord.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiOperationStatsUsingGlideRecord</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiOperationStatsUsingGlideRecord = Class.create();
SnowMirrorPerformanceApiOperationStatsUsingGlideRecord.prototype = {
initialize: function(env) {
this.env = env;
},
run: function() {
var env = this.env;
var tableName = env.tableName;
var params = env.params;
var responseWriter = new SnowMirrorPerformanceApiStreamWriter(env);
var countGR = null;
if (params.sysparmCount) {
countGR = env.precondition.checkAcl() ? new GlideRecordSecure(tableName) : new GlideRecord(tableName);
}
var maxGR = null;
if (params.sysparmMaxFields.length > 0) {
maxGR = env.precondition.checkAcl() ? new GlideRecordSecure(tableName) : new GlideRecord(tableName);
}
try {
responseWriter.start(function() {
// COUNT
if (countGR != null) {
countGR.addEncodedQuery(params.query);
countGR.setWorkflow(env.precondition.runBusinessRules());
if (params.category) {
countGR.setCategory(params.category);
}
}
// MAX
if (maxGR !== null) {
maxGR.addEncodedQuery(params.query);
maxGR.orderByDesc(params.sysparmMaxFields.join(","));
maxGR.setLimit(1);
maxGR.setWorkflow(env.precondition.runBusinessRules());
if (params.category) {
maxGR.setCategory(params.category);
}
}
}, env.response);
responseWriter.query(function() {
if (countGR != null) {
countGR.query();
}
if (maxGR !== null) {
maxGR.query();
}
});
responseWriter.stream(function(writer) {
var statsResponse = {
'stats': {}
};
if (countGR != null) {
statsResponse['stats']['count'] = countGR.getRowCount();
}
if (params.sysparmMaxFields.length > 0) {
statsResponse['stats']['max'] = {};
while (maxGR != null && maxGR._next()) {
for (var i in params.sysparmMaxFields) {
statsResponse['stats']['max']['' + params.sysparmMaxFields[i]] = maxGR.getValue(params.sysparmMaxFields[i]);
}
}
}
writer.writeString('"result": ' + JSON.stringify(statsResponse));
});
} finally {
responseWriter.close();
}
},
_addAggregateFieldsToGlideAggregate: function(recordGA, operation, fields) {
for (var i in fields) {
recordGA.addAggregate(operation, fields[i]);
}
},
type: 'SnowMirrorPerformanceApiOperationStatsUsingGlideRecord'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2024-02-08 13:15:12</sys_created_on><sys_id>6ece3d24dbd48610d1200bd3e2961973</sys_id><sys_mod_count>7</sys_mod_count><sys_name>SnowMirrorPerformanceApiOperationStatsUsingGlideRecord</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_6ece3d24dbd48610d1200bd3e2961973</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 11:59:00</sys_updated_on></sys_script_include></record_update>-29110535dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1292fd4e4593d4c7103998f1965d03d625019d91024cf50000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiOperationStatsUsingGlideRecordScript Includeglobaldaa8ce497f94c71014a181393384064cdaa8ce497f94c71014a181393384064c:-29110535,b35bc968bd7532101f30fe1f704fd1fa:-29110535,5c56b64df8005610b01caef95ca52e1b:-1246280055,680f79f8ba32c61022f0edb870ee8c54:1749633551,1cd0a64137cc1610ba51c21a3fea9e18:413457273,680f79f8ba32c61022f0edb870ee8c54:1749633551,21da7df02232c610597d8427d820c819:-172731432,3b8da1741ffe8610d29a46657bdbb9e5:1749633551,f4af1668db58861025244b6a87dc34b0:-172731432,b38f52682f5886104d50d49807ef7390:407617200,0d720e2867d48610b27393ca196635ce:983645932,fffeb16487d48610f26e3a2baf6d3143:-2134580563INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_32b21ec4db07bd50d1200bd3e2961928sysparm_read_replica_categoryfalseName of the category to use for queries. Same as Table API.sys_ws_query_parameteradmin2023-12-06 22:06:1332b21ec4db07bd50d1200bd3e29619281sysparm_read_replica_category210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_32b21ec4db07bd50d1200bd3e2961928admin2024-08-14 16:30:478bd06245dbba7150e42281791396194a]]>-1417578302dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1292fd4e4593d4c7103998f1965d03d62a019d90ff255c0000001admin2026-04-15 12:22:12
6a415a84db07bd50d1200bd3e2961907Scripted REST Query Parameter Associatioglobalde75da889707bd5079ca01206d4b0df7de75da889707bd5079ca01206d4b0df7:1229401632,de75da889707bd5079ca01206d4b0df7:1229401632INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_9349168cdb07bd50d1200bd3e2961951Default number of records to return via Performance API. This property is used only when a request does not specify a different value via "sysparm_limit" request parameter.truefalsesnowmirror.performance-api.defaultLimitsys_propertiesadmin2023-12-06 22:34:419349168cdb07bd50d1200bd3e29619510snowmirror.performance-api.defaultLimit210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_9349168cdb07bd50d1200bd3e2961951admin2023-12-06 22:34:41integer1000]]>-724252193dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1296fd0e4593d4c7103998f1965d03d6e0019d90ff24e70000001admin2026-04-15 12:22:12
snowmirror.performance-api.defaultLimitSystem Propertyglobal2b49d68c5007bd5036a70458657ba2492b49d68c5007bd5036a70458657ba249:-724252193,2b49d68c5007bd5036a70458657ba249:-724252193INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_1709d5c8db03bd50d1200bd3e29619aa<?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.SnowMirrorPerformanceApiPrecondition</api_name><caller_access/><client_callable>false</client_callable><description>Decides, whether Performance API should run ACL checks and business rules.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiPrecondition</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiPrecondition = Class.create();
SnowMirrorPerformanceApiPrecondition.prototype = {
initialize: function(env) {
this.env = env;
this.checkAclResult = this._checkAcl();
this.runBusinessRulesResult = this._runBusinessRules();
},
checkAcl: function() {
return this.checkAclResult;
},
runBusinessRules: function() {
return this.runBusinessRulesResult;
},
_checkAcl: function() {
var logger = this.env.logger;
var config = this.env.config;
var params = this.env.params;
var tableName = this._getTableName();
logger.trace('Check ACL: enabled=' + config.checkAcl + ', includes=' + config.checkAclIncludes + ', excludes=' + config.checkAclExcludes);
var checkAcl;
if (config.checkAcl) {
checkAcl = config.checkAclExcludes.indexOf(tableName) === -1;
} else {
checkAcl = config.checkAclIncludes.indexOf(tableName) !== -1;
}
logger.debug('Check ACL result: table=' + tableName + ', enabled=' + checkAcl);
if (checkAcl) {
logger.info("SnowMirror batch size with acl:" + params.smLimitWithAcl);
params.limit = params.smLimitWithAcl;
}
return checkAcl;
},
_runBusinessRules: function() {
var logger = this.env.logger;
var config = this.env.config;
var params = this.env.params;
var tableName = this._getTableName();
// Should we run BRs?
logger.trace('Run business rules: enabled=' + config.runBusinessRules + ', includes=' + config.businessRulesIncludes + ', excludes=' + config.businessRulesExcludes);
var runBr;
if (config.runBusinessRules) {
runBr = config.businessRulesExcludes.indexOf(tableName) === -1;
} else {
runBr = config.businessRulesIncludes.indexOf(tableName) !== -1;
}
logger.trace('Run business rules result: enabled=' + runBr);
return runBr;
},
_getTableName: function() {
var tableName = this.env.tableName;
if (tableName === undefined && this.env.operation === 'attachment') {
tableName = 'sys_attachment';
}
return tableName;
},
type: 'SnowMirrorPerformanceApiPrecondition'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2023-12-06 17:56:18</sys_created_on><sys_id>1709d5c8db03bd50d1200bd3e29619aa</sys_id><sys_mod_count>12</sys_mod_count><sys_name>SnowMirrorPerformanceApiPrecondition</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_1709d5c8db03bd50d1200bd3e29619aa</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:07:06</sys_updated_on></sys_script_include></record_update>-266307786dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1296fd0e4593d4c7103998f1965d03d6e5019d9109b6ba0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiPreconditionScript Includeglobal7c8a4ac93294c71083df1dfc0d6943af7c8a4ac93294c71083df1dfc0d6943af:-266307786,159b05a819753210e39dc92cac5e02bf:-466033917,999d3938c032c610f7ec3f74216babcb:-1553356237,25da7df07832c610222c43dbba563a09:-1553356237,3265df6b6d8b791055cf1643645f3672:-1553356237,3df2eaac3dc33190b8a4ba8c0bd33242:-1390220072,d9c2a6ec4dc33190515526f7b9a8c728:1114203643,fd0621508743fd503b92492572f4f20c:-1390220072,8701f5806b83bd503b25b3c19eae4a41:942098463,1a5929c88243bd50e18093ce0af1cb0c:-1307544955,6cd8ad887e43bd50ab13bada3a7aeac7:559632261,f0b7e5481e43bd50f7917641fb1bf123:1297484785,b90769081843bd500d8bdea320962535:-1152315508,be232944e943bd501ffcae1e4e18e153:1677810050,2d99550c3b03bd50c26681f8a9e6b42c:1571810877INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_b3d9514cdb03bd50d1200bd3e2961983<?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.SnowMirrorPerformanceApiOperationTable</api_name><caller_access/><client_callable>false</client_callable><description>Loads data from tables and streams it to a response.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiOperationTable</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiOperationTable = Class.create();
SnowMirrorPerformanceApiOperationTable.prototype = {
initialize: function(env) {
this.env = env;
},
run: function() {
var env = this.env;
var params = env.params;
var logger = env.logger;
var responseWriter = new SnowMirrorPerformanceApiStreamWriter(env);
var gr = env.precondition.checkAcl() ? new GlideRecordSecure(env.tableName) : new GlideRecord(env.tableName);
var fieldList;
var this_ = this;
// Read in a loop and stream the response
try {
responseWriter.start(function() {
gr.addEncodedQuery(params.query);
gr.setLimit(params.limit);
gr.setWorkflow(env.precondition.runBusinessRules());
if (params.category) {
gr.setCategory(params.category);
}
}, env.response);
responseWriter.query(function() {
gr.query();
});
responseWriter.stream(function(writer) {
var result = {
'error': ''
};
writer.writeString("\"result\": [");
var fieldTypes = {};
var count = 0;
var maxDurationExceeded = false;
while (gr._next() && !maxDurationExceeded) {
try {
count++;
var record = params.smDvResponseStyle === 'array' ? [] : {};
if (count > 1) {
writer.writeString(",");
}
fieldList = this_.prepareFieldList(params.fieldList, gr);
var emptyFieldCount = 0;
var processValue = function(val) {
if (!params.smCompressEmptyFields) {
record.push(val);
return;
}
if (val === '') {
emptyFieldCount++;
return;
}
if (emptyFieldCount > 0) {
record.push(emptyFieldCount);
emptyFieldCount = 0;
}
record.push(val);
};
var processValueFinish = function() {
if (emptyFieldCount > 0) {
record.push(emptyFieldCount);
emptyFieldCount = 0;
}
};
fieldList.forEach(function(field) {
if (params.smDvResponseStyle === 'array') {
if (params.displayValue === "true") {
if (this_.getFieldType(gr, fieldTypes, field) === 'dv') {
processValue(this_.getDisplayValueFromGlideRecord(gr, field));
} else {
processValue(this_.getValueFromGlideRecord(gr, field));
}
} else if (params.displayValue === 'all' && field.lastIndexOf('dv_', 0) === 0) {
processValue(this_.getDisplayValueFromGlideRecord(gr, field.substring(3)));
} else {
processValue(this_.getValueFromGlideRecord(gr, field));
}
} else {
if (params.displayValue === "false") {
record[field] = this_.getValueFromGlideRecord(gr, field);
} else {
var fieldType = this_.getFieldType(gr, fieldTypes, field);
if (params.displayValue === "true") {
if (fieldType === 'dv') {
record[field] = this_.getDisplayValueFromGlideRecord(gr, field);
} else {
record[field] = this_.getValueFromGlideRecord(gr, field);
}
} else if (params.displayValue === 'all') {
if (fieldType === 'dv' && params.smDvResponseStyle === 'field') {
record['dv_' + field] = this_.getDisplayValueFromGlideRecord(gr, field);
record[field] = this_.getValueFromGlideRecord(gr, field);
} else if (fieldType === 'dv') {
record[field] = {};
record[field].display_value = this_.getDisplayValueFromGlideRecord(gr, field);
record[field].value = this_.getValueFromGlideRecord(gr, field);
} else {
record[field] = this_.getValueFromGlideRecord(gr, field);
}
} else {
throw new Error("Unsupported display value type: " + params.displayValue);
}
}
}
});
processValueFinish();
this_.jsonStringifyToWriter(record, writer);
} catch (error) {
if (error instanceof Error) {
logger.error(error.message);
logger.error(error.stack);
result.error = error.message ? error.message : '';
} else {
logger.error(error);
result.error = error ? '' + error : '';
}
logger.error("SysId: " + this_.getValueFromGlideRecord(gr, 'sys_id'));
result.error += ', SysId=' + this_.getValueFromGlideRecord(gr, 'sys_id');
break;
}
var durationMillis = (Date.now() - env.startProcess);
maxDurationExceeded = params.smMaxDurationInSeconds && (durationMillis > params.smMaxDurationInSeconds * 1000);
logger.trace('Duration ms: ' + durationMillis + ', sm duration: ' + (params.smMaxDurationInSeconds * 1000) + ', exceeded: ' + maxDurationExceeded);
if (maxDurationExceeded) {
result.error = 'Transaction cancelled: maximum execution time exceeded. Performance API is allowed to run for at most ' + params.smMaxDurationInSeconds + ' seconds.';
break;
}
}
writer.writeString("]");
return result;
});
} finally {
responseWriter.close();
}
},
/**
* Prepares a list of fields to download.
*
* @param fieldList current field list. Serves also like a cache so that we don't have to create the list repeatedly
* @param gr glide record
* @returns list of fields
*/
prepareFieldList: function(fieldList, gr) {
if (!fieldList) {
for (var prop in gr) {
fieldList.push(prop);
}
}
return fieldList;
},
/**
* Returns a value of a column from a single record.
*
* @param gr glide record
* @param columnName name of a column
* @returns string value of a column
*/
getValueFromGlideRecord: function(gr, columnName) {
var el = gr.getElement(columnName);
if (el === null || (this.env.precondition.checkAcl() && !el.canRead())) {
return null;
}
return el.toString();
},
/**
* Returns a display value from a column.
*
* @param gr glide record
* @param columnName name of a column
* @returns display value
*/
getDisplayValueFromGlideRecord: function(gr, columnName) {
var val = gr.getDisplayValue(columnName);
return val !== null ? val : '';
},
/**
* Decide whether a field has a Display Value or not. Return "norm" or "dv".
*
* @param fieldTypes a cache of field types.
* @param field field
* @returns "norm" or "dv"
*/
getFieldType: function(record, fieldTypes, field) {
var fieldType = fieldTypes[field];
if (!fieldType) {
this.env.logger.trace('Figuring out field type: ' + field);
var fieldDesc = record.getElement(field).getED();
var internalType = '' + fieldDesc.getInternalType();
var types = ['document_id', 'domain_id', 'reference', 'glide_list'];
var isChoiceOrSuggestion = fieldDesc.getChoice() > 0;
fieldType = (isChoiceOrSuggestion || types.indexOf(internalType) !== -1) ? 'dv' : 'norm';
this.env.logger.trace('Figured out field type: ' + field + " is " + fieldType);
fieldTypes[field] = fieldType;
}
return fieldType;
},
isPlainObject: function(value) {
return value !== null &&
typeof value === 'object' &&
(Object.getPrototypeOf(value) === Object.prototype || Object.getPrototypeOf(value) === null);
},
jsonStringifyToWriter: function(obj, writer) {
var isArray = Array.isArray(obj);
writer.writeString(isArray ? '[' : '{');
var objValue;
var isFirst = true;
var keys = isArray ? obj : Object.keys(obj);
var i;
for (i = 0; i < keys.length; i++) {
var objKey = isArray ? i : keys[i];
objValue = obj[objKey];
if (!isFirst) {
writer.writeString(',');
}
if (!isArray) {
writer.writeString(JSON.stringify(objKey));
writer.writeString(':');
}
if (this.isPlainObject(objValue) || Array.isArray(objValue)) {
this.jsonStringifyToWriter(objValue, writer);
} else {
writer.writeString(JSON.stringify(objValue));
}
isFirst = false;
}
writer.writeString(isArray ? ']' : '}');
},
type: 'SnowMirrorPerformanceApiOperationTable'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2023-12-06 18:18:08</sys_created_on><sys_id>b3d9514cdb03bd50d1200bd3e2961983</sys_id><sys_mod_count>106</sys_mod_count><sys_name>SnowMirrorPerformanceApiOperationTable</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_b3d9514cdb03bd50d1200bd3e2961983</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 11:58:37</sys_updated_on></sys_script_include></record_update>714258616dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1296fd4e4593d4c7103998f1965d03d626019d9101f29c0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiOperationTableScript Includeglobale4980e492e94c710dead4f05e6a0e6e7e4980e492e94c710dead4f05e6a0e6e7:714258616,6d7dade8c6793210bf467923b027cea8:-1854123411,104de5e84c793210507f243e52eb5eda:2055351485,eaec2da8f0793210107bd6115d9bd6dc:-1282506348,5face5685f79321011b566962ef1fe2e:1684857065,240c21685d7932109a9487dab9677b9a:2045959851,5e4ae96420793210ba072bf637cbec99:-1125451003,e68925e09e7932100da263e4d3e91d67:-327469321,caf8a1e04d7932103cb042c5b3b3e982:-1500755059,2f08e16080793210ad4c027e3c05be2a:1600508994,5c2761ec4c3932101652a4dd1cbc23e2:164722613,fc5621ace8393210a12e5182a6a70723:1808260570,7d4d192c19f532107343d1d41ab9e9ee:-47178618,bbbb9928adf53210b88b986319e05421:-1714962874,9c3b59288bf532102d4761689c88b0b5:-47178618,feca5de486f53210e6da6bc3bb615c6a:-1714962874,422795e8d3753210a54b2e88c38bd360:-47178618,e6ba05283e7532108206788d982a2413:422234085,f766f64d6d005610bfdff0ea17ab6d97:-365035104,baceb5f84132c610055a738f04471b47:-370519458,fc8caecd62cc16104c97930abb911ca1:-322497731,99da6a4d69cc16100f3192b53df8c6a6:-1542230047,baceb5f84132c610055a738f04471b47:-370519458,e2c0a6414dcc161072f88d07aa099448:-365035104,baceb5f84132c610055a738f04471b47:-370519458,b59d79380f32c6104470b1af9fad7e3d:914339877,754cb9b4c732c610fcc3ded8a18a236a:914339877,42da7df07132c6109c31a8a5990a87bd:1774933170,dfad25749cfe86101259f7e16cb0609d:1774933170,23c38aa8c0d486109fe6b74a3a8a1e26:914339877,2f83c66858d4861029d4dc7940463a2b:1900903269,66802f27e3cb7910a205b5e6088990dc:914339877,88455f6b3d8b79104c449f87b506c09a:1599635635,65959cb5ff0bb1105e540a0e19bf8ddf:-1954806962,ab5214f1dd0bb110b4cc438137651507:-1239605474,38a1dcb1b20bb11068e8e8dc5736e3d3:-1900919184,bd2158b1de0bb1106e2c421aec7942e3:49630555,0ee050b1e20bb1104ef1b273a11795e3:-615511192,51fd00fd91c7b11011ded0efbdfc8b34:-1919173244,485d4cbda2c7b11019afd95c1e8536f0:-1897532721,08fcc07df2c7b1105ffaffe47733f7d1:-250658658,81ebc43d61c7b1100817d2b50a0f0665:500714840,463b843d72c7b1100e024487a6a3903e:-1619082270,ac0b8cf991c7b1100f8f6787982a8198:-622112705,e4da8cf9d4c7b1100d9b41cc7cecbf9f:209373450,3e9ac4f925c7b1105ff6d393205ee99a:-1755522128,6b3a84f991c7b110252cf74676ddecaa:523665240,7bf984f946c7b110325643a19af21e1b:-1656275879,a38980b9fdc7b110054c57e24cd49d08:1136552101,39c8c0b969c7b11058b8145ffdf35a99:-1333978548,2d680c79e0c7b1108f1bbbe4cf004676:-1821636875,1a2848795cc7b11050b7dd4a0553598b:155292483,d0e74079cac7b1104d993ac5035f37a4:-1364517967,76d2c03578c7b110e7892f21c7dc4c9a:-2075041866,63728cf194c7b110d1a154443f7f9479:-231701192,7532c4f130c7b110480159918eaf1f2d:1063997674,af7140f1dcc7b110e912153ece29109d:1223916038,a910087120c7b110dd655f1685296b39:-2130163098,d4cf376141c7b11021c538a1fe9a5694:1711712683,eb9e7321bac7b110087507ba2e9538ba:-1137944771,2f2e3fad8f87b1103a78f75613a17816:551949597,136cff6de887b1109bff3556d7709197:-287894462,b81cf76d1987b110a0c254715b8a0023:-730406956,5a9bf76d1e87b1102f73119f42456f1a:1868703512,f2fabf2d2087b11013509e4dcaa350a8:-490674905,b37a732d0787b1109598a65622e773b3:2087080949,775933e94887b1101ccb4f474774d9c3:-273293411,fb1933e9e187b1109df88d63903db0bb:1002120998,494837a98787b110ad455dd706761358:-681149864,6b96b7297987b110c5cf5448f0b6bb08:852733409,04f533294587b110b45520ff8d89df64:-1373687352,e8b57be5e187b1100aa42244ec3866fe:-470261373,8a35f3e52787b1100d787581c8b462d2:-482983997,6d23abd58d8771105378929503996b6b:1687798624,d6a2ef957b8771106c220fbe6d617267:1622815474,4812a7952c87711062b9eef2514a01a1:-880513790,71c1ef55b887711009143ab7ce70b984:-1956781244,2e15c6e085833190f31c571a5dbed41c:2081526233,633f61d43683fd50101c15ac4526e550:1251305792,8037659c6a43fd500b6b541cd72dc56b:197146408,6a07a19c0843fd50a32ef6e4ea18184f:1504392417,dcac42801407bd5022700b543a88f94e:1251305792,d31c4a407807bd502e85696ea0af390f:912337860,0af50ec8a2c3bd50312bb75b88d24b7d:-664099295,71d34e48f8c3bd50f05d77cb5be56c53:-1796245395,65d14a8438c3bd507906a8a378afefed:-166161065,5da18284bac3bd5084da2d7cda0cca5d:-2034333273,be414e4483c3bd503cc4b4f5a1ec530f:658904759,ebe00a44c6c3bd50d817c16eef8cd158:-810711402,19b00a44c1c3bd50a114cdb3f944c614:-1719213100,7640024452c3bd503c1ba3e216bf98a7:1199315703,552ff9c09ac3bd50137674495a12524c:570067308,780fb9c0e4c3bd50279ab349d39e08b0:-1105781194,84defd80d2c3bd50d43369b63924ba96:-1697510971,5eaefd80abc3bd5032dabc0da118f806:-1640143618,986ef5800cc3bd50a7c5643685877eff:-1165936003,5b1ef180bbc3bd5082bc2572900b27ed:571281799,b7ddf94030c3bd5061d227d8cea2da61:-107998297,c15df540acc3bd50ced56c95f2fe6058:-969177206,3c0c3dcc5e83bd50514666674b94d5eb:-1076016758,edeb79cc6283bd50dac2ee1eba29f42d:988321648,305b798c3c83bd50cf0bf2700cb73f3a:-1253860238,ef0bb54c8583bd5042f321ea752a3456:-261536606,9759710c4783bd50b5d41771a17558dd:-1334469003,cf383148f983bd502e6da91f8d8017f2:-1168738147,cfb775086e83bd507ec5d4cb534c2ce2:1624383350,d90739c45183bd50d214cd231383c00a:1388699184,7155b5840d83bd5070f308029b5b66cf:749212628,6d153d447883bd509ab76bd36e3b78ae:-809687514,67b439442083bd50fcc1feaebe00251d:1147207834,54c0b5803383bd501b6b597049e2cf17:1074640976,a05d21ccd143bd50aec6481551da9db8:2090839194,af0de58c5743bd5086bcfcef208c6704:393206786,11f929c8c843bd508ad17e307fd39247:2090839194,22e7a1883d43bd50c472b039a590d4f8:1400922423,daa62d086843bd50ac04d568d7e57a68:-2111388503,2b12e5047a43bd50988691c77ddc0be5:-359388674,519ed1404143bd50817a49ee976ec56c:931426701INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_6a25467593d002100f94f1d97bba10e0sm_count_typefalseHow to count records: using GlideAggregate or using GlideRecord.getRowCountsys_ws_query_parameteradmin2024-02-12 10:54:466a25467593d002100f94f1d97bba10e00sm_count_type210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_6a25467593d002100f94f1d97bba10e0admin2024-02-12 10:54:468bd06245dbba7150e42281791396194a]]>-1940870660dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:1296fd4e4593d4c7103998f1965d03d62b019d90ff25520000001admin2026-04-15 12:22:12
SnowMirror Performance API access.snowmirror_performance_apiAccess Rolesglobalceb366489547bd50f06815851c3e29d3ceb366489547bd50f06815851c3e29d3:-746133165,ceb366489547bd50f06815851c3e29d3:-746133165INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_76439608db07bd50d1200bd3e296195asysparm_min_fieldsfalseList of fields on which to perform MIN operation. Same as Aggregate API.sys_ws_query_parameteradmin2023-12-06 22:08:4076439608db07bd50d1200bd3e296195a0sysparm_min_fields210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_76439608db07bd50d1200bd3e296195aadmin2023-12-06 22:08:408bd06245dbba7150e42281791396194a]]>1143214154dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:129afd4e4593d4c7103998f1965d03d62c019d90ff24550000001admin2026-04-15 12:22:12
c7b31e08db07bd50d1200bd3e2961947Scripted REST Query Parameter Associatioglobal942556880507bd500916540a4ecbc0b7942556880507bd500916540a4ecbc0b7:32628176,942556880507bd500916540a4ecbc0b7:32628176INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_app_application_341e16c0db47bd50d1200bd3e29619aetruee0355b31ef303000a61d5a3615c0fb78SnowMirror Performance API allows SnowMirror to download data faster compared to using traditional REST API.browserSnowMirror Performance API100snowmirror_performance_apisys_app_applicationadmin2023-12-06 22:57:07global/341e16c0db47bd50d1200bd3e29619ae0SnowMirror Performance API210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_app_application_341e16c0db47bd50d1200bd3e29619aeadmin2023-12-06 22:57:07SnowMirror Performance API]]>-1216805703dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:129efd0e4593d4c7103998f1965d03d6dd019d90ff25230000001admin2026-04-15 12:22:12
snowmirror.performance-api.acl.excludes.SnowMirror Performance APICategory Propertyglobalc6f952ccc007bd50031256a0c2263cd6c6f952ccc007bd50031256a0c2263cd6:-1769482763,c6f952ccc007bd50031256a0c2263cd6:-1769482763,01f9de8c0207bd50a856f5697ca27325:224827508,8a691a8c0e07bd50035470518b71aada:1242381364INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_27bac68d9394c7103998f1965d03d659<?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.SnowMirrorPerformanceApiOperationAttachment</api_name><caller_access/><client_callable>false</client_callable><description>Performance API alternative to ServiceNow Attachment API which downloads (streams) a single attachment.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiOperationAttachment</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiOperationAttachment = Class.create();
SnowMirrorPerformanceApiOperationAttachment.prototype = {
initialize: function(env) {
this.env = env;
},
run: function() {
var env = this.env;
var request = env.request;
var response = env.response;
var sysId = request.pathParams.sys_id;
if (!sysId) {
response.setStatus(400);
response.setBody({
error: 'Missing sys_id path parameter'
});
return;
}
var sysAttachment = env.precondition.checkAcl() ? new GlideRecordSecure('sys_attachment') : new GlideRecord('sys_attachment');
sysAttachment.setWorkflow(env.precondition.runBusinessRules());
if (env.params.category) {
sysAttachment.setCategory(env.params.category);
}
if (!sysAttachment.get(sysId)) {
response.setStatus(404);
response.setBody({
error: 'Attachment not found: ' + sysId
});
return;
}
var contentType = sysAttachment.getValue('content_type') || 'application/octet-stream';
var stream = new GlideSysAttachment().getContentStream(sysId);
if (!stream) {
response.setStatus(500);
response.setBody({
error: 'Could not open content stream for: ' + sysId
});
return;
}
try {
response.setStatus(200);
response.setContentType(contentType);
response.getStreamWriter().writeStream(stream);
} catch (e) {
response.setStatus(500);
response.setBody({
error: 'Error streaming attachment: ' + e.message
});
}
},
type: 'SnowMirrorPerformanceApiOperationAttachment'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2026-04-15 12:08:05</sys_created_on><sys_id>27bac68d9394c7103998f1965d03d659</sys_id><sys_mod_count>0</sys_mod_count><sys_name>SnowMirrorPerformanceApiOperationAttachment</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_27bac68d9394c7103998f1965d03d659</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:08:05</sys_updated_on></sys_script_include></record_update>-756253483dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:129efd4e4593d4c7103998f1965d03d623019d910aa11b0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiOperationAttachmentScript Includeglobal6bbac68d8094c710c8974e4b75d5bf5b6bbac68d8094c710c8974e4b75d5bf5b:-756253483INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_operation_3061aa45dbba7150e422817913961955<?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</consumes><consumes_customized>false</consumes_customized><default_operation_uri>/api/gvs/performance_api/{operation}/{tableName}</default_operation_uri><enforce_acl>a818c9c6dbfa3550e4228179139619d9</enforce_acl><http_method>GET</http_method><name>Synchronization</name><operation_script><![CDATA[/**
* SnowMirror Performance API.
*
* Custom API for SnowMirror that provides an alternative for "table" and "stats" operations. The purpose of this API
* is to improve download times. It achieves better performance by:
* - turning off ACL checks
* - turning off business rules
* - streaming the results
*
* Security:
* A user needs to have a have "snowmirror_performance_api" role assigned to be able to use Performance API.
*
* The API is configurable via system properties:
*
* - snowmirror.performance-api.acl.check - Decides whether SnowMirror Performance API checks ACLs.
* Possible values:
* - false/not defined/empty value: Performance API does not check ACLs.
* - true: Performance API checks ACLs.
* - snowmirror.performance-api.acl.includes - Comma separated list of tables which should always check ACLs.
* If ACL checks is disabled, we will check ACLs only for these tables.
* - snowmirror.performance-api.acl.excludes - Comma separated list of tables which should not check ACLs.
* If ACL checks is enabled, we will not check ACLs only for these tables.
* - snowmirror.performance-api.business-rules.enabled - Decides whether SnowMirror Performance API runs business rules.
* Possible values:
* - false/not defined/empty value: Performance API does not run business rules.
* - true: Performance API runs business rules.
* - snowmirror.performance-api.business-rules.includes - Comma separated list of tables which should always run
* business rules. If running business rules is disabled, we will run business rules only for these tables.
* - snowmirror.performance-api.business-rules.excludes - Comma separated list of tables which should not run
* business rules. If running business rules is enabled, we will not run business rules only for these tables.
*
* Request parameters:
* - sm_debug - should we return debugging information in the response and log it to the activity log? Messages are
* being collected on the server side and streamed to end of the response. Therefore, it is suitable only
* for debugging purposes mostly on smaller requests.
* - off: no logging information. This is also a default option if the parameter is empty or not present.
* - trace: the most detailed information
* - debug: detailed information
* - info: smaller number of log information
* - sm_retrieve_logs - should we return logs and log them to the activity log? Messages are being collected
* on the server side and streamed to end of the response. Therefore, it is suitable only
* for debugging purposes mostly on smaller requests.
* - true - return logs
* - anything else - do not return logs
* - sm_limit_with_acl - how many records to download in a response when ACL check is enabled.
* - sm_max_duration - for how long (in seconds) can this script process a single request?
* - sm_compress_empty_fields - should we compress consecutive empty fields into number of empty fields to shorten
* the response? For example instead of: "", "", "" we send just a number 3.
* - sm_count_type - how should we count records. GlideAggregate - using GlideAggregate which it faster but it runs BRs. GlideRecord - using GlideRecord.getRowCount which does not run BRs but is slower.
* - sm_response_style - how does the response look like. Usually, there is no reason to specify/modify this parameter.
* The default value is "array" because it is concise and can make a difference for tables with
* lots of columns.
* - array: rows are being returned as an array without column names. The values of columns are
* returned in the same order as are columns in "sysparm_fields" parameter.
* For example: [ "column value", "column display value" ]
* - field: rows are returned as objects.
* For example: { "column": "column value", "dv_column": "column display value" }
* - default: rows are returned as objects like in ServiceNow's REST API.
* For example: { "column": { "value": "column value", "display_value: "column display value" }
*/
(function process( /*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
var env = {};
env.startProcess = Date.now();
env.info = {
'apiVersion': 1
};
env.operation = request.pathParams.operation;
env.tableName = request.pathParams.tableName;
env.request = request;
env.response = response;
env.logger = new SnowMirrorPerformanceApiLogger(request);
env.config = new SnowMirrorPerformanceApiProperties(env.logger).load();
env.paramUtils = new SnowMirrorPerformanceApiParamUtils(env.logger);
env.params = new SnowMirrorPerformanceApiParamsLoader(env.paramUtils, env.config).load(request);
env.debugInfo = new SnowMirrorPerformanceApiDebugInfo();
env.debugInfo.readParams(env.params);
env.precondition = new SnowMirrorPerformanceApiPrecondition(env);
env.logger.info('Start: ' + env.operation + '/' + env.tableName);
env.logger.info('Operation: ' + env.operation);
env.logger.info('Count Type: ' + env.params.smCountType);
if (env.operation === 'stats' && env.params.smCountType == 'GlideRecord') {
new SnowMirrorPerformanceApiOperationStatsUsingGlideRecord(env).run();
} else if (env.operation === 'stats') {
new SnowMirrorPerformanceApiOperationStats(env).run();
} else {
new SnowMirrorPerformanceApiOperationTable(env).run();
}
})(request, response);]]></operation_script><operation_uri>/api/gvs/v1/performance_api/{operation}/{tableName}</operation_uri><produces>application/json</produces><produces_customized>false</produces_customized><relative_path>/{operation}/{tableName}</relative_path><request_example/><requires_acl_authorization>true</requires_acl_authorization><requires_authentication>true</requires_authentication><requires_snc_internal_role>false</requires_snc_internal_role><short_description>SnowMirror Performance API improves download times.</short_description><sys_class_name>sys_ws_operation</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2023-11-27 15:29:16</sys_created_on><sys_id>3061aa45dbba7150e422817913961955</sys_id><sys_mod_count>49</sys_mod_count><sys_name>Synchronization</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_ws_operation_3061aa45dbba7150e422817913961955</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:15:47</sys_updated_on><web_service_definition display_value="SnowMirror Performance API">8bd06245dbba7150e42281791396194a</web_service_definition><web_service_version display_value="v1">75d592c8db07bd50d1200bd3e2961916</web_service_version></sys_ws_operation></record_update>-1670000416dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:129efd4e4593d4c7103998f1965d03d628019d9111aa9e0000001admin2026-04-15 12:22:12
SynchronizationScripted REST Resourceglobal848cc681cdd4c710dd12062108c629d8848cc681cdd4c710dd12062108c629d8:-1670000416,41058275acd00210423c4814a9e2899a:-570061357,359d7938e632c6102372415cabd28b49:-570061357,41058275acd00210423c4814a9e2899a:-570061357,ceda7df07c32c6103d97abbbf081f6c8:-570061357,41058275acd00210423c4814a9e2899a:-570061357,e9133ebc711cc610f14843438ee3e683:-570061357,0625a6ec1d588610a7af62574e037a68:-659748977,6db4eeac33588610bffaa293465757e3:265570423,dacf1a6814588610da982c69d912a16c:1796174408,3992466888d4861023da8bcf67ba084d:1175420145,c9c2c5e3e98379103e2231505c90f6ce:-1507407955,37a1c5a3ea8379103b2de3c3002d7734:-286138470,d2e446e0e7833190d178613d798d3bc0:-1507407955,2124fd1c1483fd508795c1703f036f7f:-200756267,adbfa9d44783fd50e7775fbb8856a268:-887645684,297f65d4f783fd50a239018111d61894:1347132862,7908524c6907bd503eeea190c68f902b:-200756267,2a57d60cfe07bd509c2d3cd589493ad2:-229437713,3dd592c83807bd50ad1664f64ad5ff21:828625271,58d0d2841a07bd5016ca4f76bcc6f837:-985259544,2dd502c8dcc3bd5043b10e74b9120bae:1081289467,4da9b10c5a83bd50acbaccb2dbdccb03:-159991013,372771085c83bd50da46f36f86840734:64117139,424ba14c3b43bd508e8c24cb7657205b:1817288735,34c161044e43bd508aeb2ae538e825f6:781900856,92638908edcf7d502b365fc174c59c86:906113224,a5a201083acf7d5007d0813a2c33876c:680686440,7092810810cf7d50cd0829d59f20447f:180755680,458ebcc0c0cf7d50181166d08f60b780:-326660569,f38bbc4024cf7d50bbf30e3162dcf583:-795858909,5cd7c9e69ffab550ca7d9119fe8aa361:301770835,f28f2306fb7675501a3952d7bafe95a7:2132300440,6b7ea3c2be767550fbaa0874f7d413f7:1117642753,6af5e7ca93367550aba87af95f4f3df2:1617941537,4fdab542dcfe35507eca28e90075779d:-187701488,692171c606be355080ba19bbdb484414:768410624,c8b0758632be355044a8edc8a4bb04dc:-1859900969,2d3de18260be3550e77ea262758453f7:559914727,75bc694205be355001827ce403d0a643:-794333004,5a3ce142aebe3550ecacab7043fbcc47:-1104735140,ce9a25ce797e35509aadc64561ae08fb:1770304374,010a618e637e355025882db5f7e9caf1:1919328579,a5582d0e2b7e3550526027bae806e3b5:361701171,5d18e9ca917e355083cfb3bceda34512:-1428795136,12d7a9ca3c7e35507f204d332398c2ae:-813864672,64e6694a777e35501eda12ea013a440f:-1747520998,b4762906277e3550a8e477227a3e52cd:780420401,9e2469c2e07e3550d37c1c6bb8cb4bda:-315820929,21d44dc279fa35506c1d145401885522:383648845,ecc438bdbc3ef150267264749f13bbe8:1776243083,9b7c6361d67af1501b7b64aece4b4921:1090590917,4863e329863af1506021c8e12c8c53df:-965313740,34f223299e3af15099ca73d0efd7db8d:1824554830,8ee1afa5193af1502a7ba11c5026de4b:-1061038770,b8016ba5373af15067ac04dbf7052277:1106288451,aa0b1b61693af1503f16bc0cef9f1b87:1012184784,8412628591ba71501c0a070f4bb466bf:-240587983,88a1aa453fba7150f37e8ad297894d82:1852668176INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_bc131208db07bd50d1200bd3e29619b8sysparm_avg_fieldsfalseList of fields on which to perform AVG operation. Same as Aggregate API.sys_ws_query_parameteradmin2023-12-06 22:08:21bc131208db07bd50d1200bd3e29619b80sysparm_avg_fields210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_bc131208db07bd50d1200bd3e29619b8admin2023-12-06 22:08:218bd06245dbba7150e42281791396194a]]>1448154314dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:129efd4e4593d4c7103998f1965d03d62d019d90ff24500000001admin2026-04-15 12:22:12
snowmirror.performance-api.business-rules.includes.SnowMirror Performance APICategory Propertyglobalb30a52ccff07bd50da5dc73376a75063b30a52ccff07bd50da5dc73376a75063:1445758238,b30a52ccff07bd50da5dc73376a75063:1445758238,8e691a8ce007bd50baae2c3f8b6875e3:378829307INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_38f59948db03bd50d1200bd3e29619c7<?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.SnowMirrorPerformanceApiOperationStats</api_name><caller_access/><client_callable>false</client_callable><description>Provides access to aggregate operations.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiOperationStats</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiOperationStats = Class.create();
SnowMirrorPerformanceApiOperationStats.prototype = {
initialize: function(env) {
this.env = env;
},
run: function() {
var env = this.env;
var tableName = env.tableName;
var params = env.params;
var responseWriter = new SnowMirrorPerformanceApiStreamWriter(env);
var queryError = null;
var this_ = this;
var logger = this.env.logger;
var recordGA = new GlideAggregate(tableName);
try {
responseWriter.start(function() {
if (params.sysparmCount) {
recordGA.addAggregate('COUNT');
}
this_._addAggregateFieldsToGlideAggregate(recordGA, 'AVG', params.sysparmAvgFields);
this_._addAggregateFieldsToGlideAggregate(recordGA, 'MIN', params.sysparmMinFields);
this_._addAggregateFieldsToGlideAggregate(recordGA, 'MAX', params.sysparmMaxFields);
this_._addAggregateFieldsToGlideAggregate(recordGA, 'SUM', params.sysparmSumFields);
recordGA.addEncodedQuery(params.query);
recordGA.setGroup(false);
}, env.response);
responseWriter.query(function() {
try {
recordGA.query();
} catch (error) {
queryError = error;
}
});
responseWriter.stream(function(writer) {
if (queryError !== null) {
writer.writeString('"result": {}, "error": ' + JSON.stringify(queryError.message ? queryError.message : ''));
return;
}
try {
while (recordGA._next()) {
var statsResponse = {
'stats': {}
};
if (params.sysparmCount) {
statsResponse['stats']['count'] = recordGA.getAggregate('COUNT');
}
if (params.sysparmMaxFields.length > 0) {
statsResponse['stats']['max'] = {};
for (var i in params.sysparmMaxFields) {
statsResponse['stats']['max']['' + params.sysparmMaxFields[i]] = recordGA.getAggregate('MAX', params.sysparmMaxFields[i]);
}
}
writer.writeString('"result": ' + JSON.stringify(statsResponse));
}
} catch (error) {
if (error instanceof Error) {
logger.error(error.message);
logger.error(error.stack);
writer.writeString('"result": {}, "error": ' + JSON.stringify(error.message ? error.message : ''));
} else {
logger.error(error);
}
}
});
} finally {
responseWriter.close();
}
},
_addAggregateFieldsToGlideAggregate: function(recordGA, operation, fields) {
for (var i in fields) {
recordGA.addAggregate(operation, fields[i]);
}
},
type: 'SnowMirrorPerformanceApiOperationStats'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2023-12-06 17:44:07</sys_created_on><sys_id>38f59948db03bd50d1200bd3e29619c7</sys_id><sys_mod_count>23</sys_mod_count><sys_name>SnowMirrorPerformanceApiOperationStats</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_38f59948db03bd50d1200bd3e29619c7</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 11:59:18</sys_updated_on></sys_script_include></record_update>1052395213dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d2fd4e4593d4c7103998f1965d03d624019d910294750000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiOperationStatsScript Includeglobal32b88a49a394c7100ffe1a07bdc84d1b32b88a49a394c7100ffe1a07bdc84d1b:1052395213,2c53903012b1b210ab58506384a4189d:-884240228,8b135cfce671b210262215b88e3f54a7:-10261678,cc32d87c5671b210eb2b7cb65c5032db:-78951950,b8b19cf40471b210f7091ae7416e2524:-10261678,59d094f8b771b210a10e3548271bb062:-1486591118,ae1f4cf4fb71b2109c51eda916de8df8:1778903735,04da8928c275321022afeddb60e860d2:559707518,c6be35f85e32c610fadc1b9a6bc41215:2141671150,119d39388132c610f81a6bd57761e5dc:-786075831,f14cb9b4f332c610236b5fd2150e8166:-786075831,e1da7df09032c6102ebcef5ca5b0620d:967722478,579de174d4fe8610a5d32c2dcc8168d5:967722478,57606b27bacb791041cc35ed75a50234:-786075831,2d355f6b548b7910f94d6a246b168d2f:-670341237,f8f02755b3877110651d9f2f5d8fd377:637402725,8b80ee2cbec33190194aa36abbf3e411:1411239605,286b9ae41cc33190e6ecc0371c4f729a:-896576226,85ea1ae458c331902f3da0187b278c91:-568527529,698a52e4d4c331903ec38ab07a588151:-14025408,ea6a9ea4dfc331902ca58fee631573ee:1390131229,613a5ea484c331903667cd79fdb3e29d:1302084378,e633864845c3bd50b8b0975f989d055c:874069259,e5f2ce083ec3bd50c706ce316af706c4:2035327047,11b9b10ca383bd5048776bd5a0665a0a:761540363,b117fdc4ea83bd504b38d3d12dc24092:-535284732,5c5f1d40ca43bd50c03f4c39990bc793:1708417764,f6c61988c103bd50b9fbdd2e0307a8dd:552702977INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_operation_9e5b4ac99394c7103998f1965d03d6c8<?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</consumes><consumes_customized>false</consumes_customized><default_operation_uri>/api/gvs/performance_api/attachment/{sys_id}/file</default_operation_uri><enforce_acl>a818c9c6dbfa3550e4228179139619d9</enforce_acl><http_method>GET</http_method><name>Attachment</name><operation_script><![CDATA[/**
* SnowMirror Performance API. This resouce is an alternative for ServiceNow attachment API which downloads (streams) a * single attachment by its SysId.
*
* Security:
* A user needs to have a have "snowmirror_performance_api" role assigned to be able to use Performance API.
*
* The API is configurable via system properties:
*
* - snowmirror.performance-api.acl.check - Decides whether SnowMirror Performance API checks ACLs.
* Possible values:
* - false/not defined/empty value: Performance API does not check ACLs.
* - true: Performance API checks ACLs.
* - snowmirror.performance-api.acl.includes - Comma separated list of tables which should always check ACLs.
* If ACL checks is disabled, we will check ACLs only for these tables.
* - snowmirror.performance-api.acl.excludes - Comma separated list of tables which should not check ACLs.
* If ACL checks is enabled, we will not check ACLs only for these tables.
* - snowmirror.performance-api.business-rules.enabled - Decides whether SnowMirror Performance API runs business rules.
* Possible values:
* - false/not defined/empty value: Performance API does not run business rules.
* - true: Performance API runs business rules.
* - snowmirror.performance-api.business-rules.includes - Comma separated list of tables which should always run
* business rules. If running business rules is disabled, we will run business rules only for these tables.
* - snowmirror.performance-api.business-rules.excludes - Comma separated list of tables which should not run
* business rules. If running business rules is enabled, we will not run business rules only for these tables.
*
* Request parameters:
* - sm_debug - should we return debugging information in the response and log it to the activity log? Messages are
* being collected on the server side and streamed to end of the response. Therefore, it is suitable only
* for debugging purposes mostly on smaller requests.
* - off: no logging information. This is also a default option if the parameter is empty or not present.
* - trace: the most detailed information
* - debug: detailed information
* - info: smaller number of log information
*/
(function process( /*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
var env = new SnowMirrorPerformanceApiEnvLoader().run(request, response, 'attachment');
env.logger.info('Start: ' + env.operation + '/' + request.pathParams.sys_id + '/file');
new SnowMirrorPerformanceApiOperationAttachment(env).run();
})(request, response);]]></operation_script><operation_uri>/api/gvs/v1/performance_api/attachment/{sys_id}/file</operation_uri><produces>application/json</produces><produces_customized>false</produces_customized><relative_path>/attachment/{sys_id}/file</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/><sys_class_name>sys_ws_operation</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2026-04-15 12:13:11</sys_created_on><sys_id>9e5b4ac99394c7103998f1965d03d6c8</sys_id><sys_mod_count>0</sys_mod_count><sys_name>Attachment</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_ws_operation_9e5b4ac99394c7103998f1965d03d6c8</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:13:11</sys_updated_on><web_service_definition display_value="SnowMirror Performance API">8bd06245dbba7150e42281791396194a</web_service_definition><web_service_version display_value="v1">75d592c8db07bd50d1200bd3e2961916</web_service_version></sys_ws_operation><sys_es_latest_script action="INSERT_OR_UPDATE"><id>9e5b4ac99394c7103998f1965d03d6c8</id><sys_created_by>admin</sys_created_by><sys_created_on>2026-04-15 12:13:11</sys_created_on><sys_id>0aeb460193d4c7103998f1965d03d66a</sys_id><sys_mod_count>0</sys_mod_count><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:13:11</sys_updated_on><table>sys_ws_operation</table><use_es_latest>true</use_es_latest></sys_es_latest_script></record_update>497362147dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d2fd4e4593d4c7103998f1965d03d629019d910f49b50000001admin2026-04-15 12:22:12
AttachmentScripted REST Resourceglobal8eeb8241c9d4c71017bce89f52e7cbb58eeb8241c9d4c71017bce89f52e7cbb5:497362147INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_c7b31e08db07bd50d1200bd3e2961947sm_response_stylefalseHow does the response look like. Values: array, field, defaultsys_ws_query_parameteradmin2023-12-06 22:11:20c7b31e08db07bd50d1200bd3e29619470sm_response_style210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_c7b31e08db07bd50d1200bd3e2961947admin2023-12-06 22:11:208bd06245dbba7150e42281791396194a]]>-1055789825dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d2fd4e4593d4c7103998f1965d03d62e019d90ff24630000001admin2026-04-15 12:22:12
bc131208db07bd50d1200bd3e29619b8Scripted REST Query Parameter Associatioglobal0445d6889607bd5069c121b97ca98ff20445d6889607bd5069c121b97ca98ff2:715333810,0445d6889607bd5069c121b97ca98ff2:715333810INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_4270aa05dbba7150e4228179139619a8Comma separated list of tables which should not check ACLs. If ACL check is enabled (snowmirror.performance-api.acl.check), we will not check ACLs only for these tables.truefalsesnowmirror.performance-api.acl.excludessys_propertiesadmin2023-11-27 15:24:424270aa05dbba7150e4228179139619a81snowmirror.performance-api.acl.excludes210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_4270aa05dbba7150e4228179139619a8admin2023-12-06 21:40:05string]]>791019456dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d6fd0e4593d4c7103998f1965d03d6df019d90ff24120000001admin2026-04-15 12:22:12
snowmirror.performance-api.acl.excludesSystem Propertyglobal2fcc0680ab07bd50f67f2aaa7a74122f2fcc0680ab07bd50f67f2aaa7a74122f:791019456,2fcc0680ab07bd50f67f2aaa7a74122f:791019456,95906e0538ba71505222fb827de05d11:-1020193583INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_fb569ac8db07bd50d1200bd3e29619d9Default number of records to return via Performance API when a table is ACL-restricted. This property is used only when a request does not specify a different value via "sm_limit_with_acl" request parameter.truefalsesnowmirror.performance-api.defaultLimitAclRestrictedsys_propertiesadmin2023-12-06 22:23:04fb569ac8db07bd50d1200bd3e29619d92snowmirror.performance-api.defaultLimitAclRestricted210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_fb569ac8db07bd50d1200bd3e29619d9admin2023-12-06 22:27:18integer1000]]>177677003dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d6fd0e4593d4c7103998f1965d03d6e4019d90ff24e20000001admin2026-04-15 12:22:12
snowmirror.performance-api.defaultLimitAclRestrictedSystem Propertyglobal9f975a0cac07bd501ebbf61e10c6e2a19f975a0cac07bd501ebbf61e10c6e2a1:177677003,9f975a0cac07bd501ebbf61e10c6e2a1:177677003,0fb69ac89207bd50cdf3ccd0dcbc100b:1114418417,d1a69ac83707bd507291754fbd442de0:1639493617INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_script_include_75acb880dbcf7d50d1200bd3e29619e5<?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.SnowMirrorPerformanceApiParamUtils</api_name><caller_access/><client_callable>false</client_callable><description>Utility methods to read request parameters.</description><mobile_callable>false</mobile_callable><name>SnowMirrorPerformanceApiParamUtils</name><sandbox_callable>false</sandbox_callable><script><![CDATA[var SnowMirrorPerformanceApiParamUtils = Class.create();
SnowMirrorPerformanceApiParamUtils.prototype = {
initialize: function(logger) {
this.logger = logger;
},
extractQueryParam: function(request, paramName, defaultValue) {
this.logger.trace('extractQueryParam: ' + paramName);
var value = request.queryParams[paramName];
if (value !== null && value !== undefined) {
this.logger.trace('extractQueryParam: val = ' + value[0]);
return value[0];
}
this.logger.trace('extractQueryParam: using default value = ' + defaultValue);
return defaultValue;
},
extractQueryParamAsInt: function(request, paramName, defaultValue) {
this.logger.trace('extractQueryParamAsInt: ' + paramName);
var val = this.extractQueryParam(request, paramName, defaultValue);
this.logger.trace('extractQueryParamAsInt: val = ' + val);
return val !== null ? parseInt(val) : null;
},
extractQueryParamAsBoolean: function(request, paramName, defaultValue) {
this.logger.trace('extractQueryParamAsBoolean: ' + paramName);
var val = this.extractQueryParam(request, paramName, defaultValue);
this.logger.trace('extractQueryParamAsBoolean: val = ' + val);
return String(val).toLowerCase() === 'true';
},
extractQueryParamAsArray: function(request, paramName) {
return this.split(this.extractQueryParam(request, paramName, ''));
},
split: function(val) {
return (val !== null && val !== undefined && val !== '') ? val.split(',') : [];
},
type: 'SnowMirrorPerformanceApiParamUtils'
};]]></script><sys_class_name>sys_script_include</sys_class_name><sys_created_by>admin</sys_created_by><sys_created_on>2023-12-06 15:52:07</sys_created_on><sys_id>75acb880dbcf7d50d1200bd3e29619e5</sys_id><sys_mod_count>17</sys_mod_count><sys_name>SnowMirrorPerformanceApiParamUtils</sys_name><sys_package display_value="SnowMirror Performance API" source="210f92c1dbba7150e42281791396195c">210f92c1dbba7150e42281791396195c</sys_package><sys_policy/><sys_scope display_value="SnowMirror Performance API">210f92c1dbba7150e42281791396195c</sys_scope><sys_update_name>sys_script_include_75acb880dbcf7d50d1200bd3e29619e5</sys_update_name><sys_updated_by>admin</sys_updated_by><sys_updated_on>2026-04-15 12:06:03</sys_updated_on></sys_script_include></record_update>-820646500dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d6fd4e4593d4c7103998f1965d03d625019d9108c09a0000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiParamUtilsScript Includeglobala94a8e4d6a94c71085090576b950a944a94a8e4d6a94c71085090576b950a944:-820646500,9b8bc1a82a753210beb845a0bf2760a6:-820646500,259d39386b32c6100187ba5caf4603f4:-470617716,a5da7df03532c6100a9e335571792829:-470617716,92559f6b248b79103d02176fe1e874e4:-470617716,56070839e2c7b11065b9899e1b6a27d3:-2065957330,2b9648f5b9c7b11097cf708795176e5e:1385895347,672608f523c7b110a9c2a7cb5a3d8d2e:200803117,23c548b5f6c7b110e4b84e87f6924193:1078289667,c2402e2c1bc33190d0f66256ff38743f:-2065957330,5ade92e884c33190d49e9c5307028d4d:241163404,9bbe1ea8b0c33190a80b1f314a9115ec:-817679024,888d1e68f6c33190270d545ac1055c58:1965131916,ef0d1a68e2c331904e3fd40f55e5f08c:-2079073145,c42cd6286fc33190e9ccfd2158cf3ca4:-1221596538,8ac2a1449943bd50438f2d7f3f689003:582221614,4cc8854c91cf7d5084fdc486e098c038:-1727785926,973245c43dcf7d50fb3d53a4bc6ae6fc:-547326942,758149845fcf7d507bbfbf517ff06950:-297827076,9a2d7c806acf7d50adc057b93df13ae0:727596020INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_37921ec4db07bd50d1200bd3e2961921sysparm_limitfalseMaximum number of records to return. Same as Table API.sys_ws_query_parameteradmin2023-12-06 22:05:4837921ec4db07bd50d1200bd3e29619210sysparm_limit210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_37921ec4db07bd50d1200bd3e2961921admin2023-12-06 22:05:488bd06245dbba7150e42281791396194a]]>663777069dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12d6fd4e4593d4c7103998f1965d03d62a019d90ff24400000001admin2026-04-15 12:22:12
78b4de48db07bd50d1200bd3e296193cScripted REST Query Parameter Associatioglobala225d688fa07bd50a3b16ba621bbb51ca225d688fa07bd50a3b16ba621bbb51c:1215071537,a225d688fa07bd50a3b16ba621bbb51c:1215071537INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_properties_c8502a05dbba7150e4228179139619cdComma separated list of tables which should always check ACLs. If ACL check is disabled (snowmirror.performance-api.acl.check), we will check ACLs only for these tables.truefalsesnowmirror.performance-api.acl.includessys_propertiesadmin2023-11-27 15:23:35c8502a05dbba7150e4228179139619cd2snowmirror.performance-api.acl.includes210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_properties_c8502a05dbba7150e4228179139619cdadmin2023-12-06 21:40:15string]]>896235466dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12dafd0e4593d4c7103998f1965d03d6e0019d90ff24170000001admin2026-04-15 12:22:12
SnowMirrorPerformanceApiDebugInfoScript Includeglobalb6e80a899694c710a80873f26ac03cd9b6e80a899694c710a80873f26ac03cd9:1255440463,09cac1e4fc7532109d81dfe8c360eb92:1255440463,c7c44e3588d0021091a634e610668fa0:-2141821205,b59d7938fd32c610ec5cc9c887659b41:-2141821205,c7c44e3588d0021091a634e610668fa0:-2141821205,42da7df0fc32c610e2a7dc4f95dfdcc1:-2141821205,c7c44e3588d0021091a634e610668fa0:-2141821205,f947e0d0abdc061059007068b11aeb48:-2141821205,35406727b0cb791046d8a4d9200df875:-470088249,e2251f6b338b79106b296f8826c0d419:-1359572056,f8b355c46203bd50cfeee16b5bcec1d0:1079697997INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_6a415a84db07bd50d1200bd3e2961907sysparm_queryfalseEncoded query used to filter the result set. It works the same as in Table API.sys_ws_query_parameteradmin2023-12-06 22:03:006a415a84db07bd50d1200bd3e29619070sysparm_query210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_6a415a84db07bd50d1200bd3e2961907admin2023-12-06 22:03:008bd06245dbba7150e42281791396194a]]>-1740425321dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12dafd4e4593d4c7103998f1965d03d62b019d90ff24310000001admin2026-04-15 12:22:12
snowmirror.performance-api.acl.check.SnowMirror Performance APICategory Propertyglobal06691a8cda07bd503e9107aae56da0d806691a8cda07bd503e9107aae56da0d8:-1768708119,06691a8cda07bd503e9107aae56da0d8:-1768708119INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_user_role_0e2fd6c1dbba7150e4228179139619a4trueAllows you to call SnowMirror Performance API.falsetruesnowmirror_performance_api-1falsesnowmirror_performance_apisys_user_roleadmin2023-11-27 15:18:280e2fd6c1dbba7150e4228179139619a41snowmirror_performance_api210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_user_role_0e2fd6c1dbba7150e4228179139619a4admin2023-12-06 21:51:14]]>-934611234dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12defd4e4593d4c7103998f1965d03d627019d90ff24260000001admin2026-04-15 12:22:12
snowmirror_performance_apiRoleglobalf65f8ec0a107bd504b4f306a85766cb1f65f8ec0a107bd504b4f306a85766cb1:-340325514,f65f8ec0a107bd504b4f306a85766cb1:-340325514,462fd6c1c8ba7150186bfb975b03a8a7:-15131160INSERT_OR_UPDATE210f92c1dbba7150e42281791396195ccustomersys_ws_query_parameter_77445248db07bd50d1200bd3e29619f7sm_sn_compatibilityfalseShould the response look like a resp.from out-of-the-box REST API? true/falsesys_ws_query_parameteradmin2023-12-06 22:14:2277445248db07bd50d1200bd3e29619f70sm_sn_compatibility210f92c1dbba7150e42281791396195c210f92c1dbba7150e42281791396195csys_ws_query_parameter_77445248db07bd50d1200bd3e29619f7admin2023-12-06 22:14:228bd06245dbba7150e42281791396194a]]>2021601927dafd0e4593d4c7103998f1965d03d6dcfalseadmin2026-04-15 12:22:12defd4e4593d4c7103998f1965d03d62c019d90ff24780000001admin2026-04-15 12:22:12